Zebra Translate
iOS API

API Reference for the Zebra iOS SDK (Cocoapod)

Zebra

public class Zebra { }

Class for the Zebra Translate engine. Resources should be cleaned when you are done using the delete() function.

Zebra.getAvailableDevices()

public static func getAvailableDevices() throws -> [String]

Retrieves a list of devices that can be specified when constructing Zebra.

Returns

• [String] : An array of available devices.

Throws

• ZebraError: If an error occurs while retrieving the devices.

Zebra.init()

init method for Zebra Translate engine.

public init(
  accessKey: String,
  modelPath: String? = nil,
  device: String? = nil) throws -> Zebra

Parameters

• accessKey String : The AccessKey obtained from Picovoice Console.
• modelPath String? : Absolute path to file containing model parameters (.pv). Sets the source and target translation languages.
• device String? : String representation of the device (e.g., CPU or GPU) to use. If set to best, the most suitable device is selected automatically. If set to gpu, the engine uses the first available GPU device. To select a specific GPU device, set this argument to gpu:${GPU_INDEX}, where ${GPU_INDEX} is the index of the target GPU. If set to cpu, the engine will run on the CPU with the default number of threads. To specify the number of threads, set this argument to cpu:${NUM_THREADS}, where ${NUM_THREADS} is the desired number of threads.

Throws

• ZebraError: If an error occurs while creating an instance of Zebra Translate engine.

Zebra.delete()

Releases resources acquired by the Zebra engine.

public func delete()

Zebra.translate()

Translates text. The maximum number of characters that can be translated at once is given by .maxCharacterLimit.

public func translate(text: String) throws -> String

Parameters

• text String : Text to translate.

Returns

• String : Translated text.

Throws

• ZebraError: If there is an error while translating.

Zebra.version

public static let version: String

Current Zebra version.

Zebra.maxCharacterLimit

public var maxCharacterLimit: Int32

Maximum number of characters allowed in a single translation request.

ZebraError

public class ZebraError : LocalizedError { }

Error thrown if an error occurs within Zebra Translate engine.

public class ZebraMemoryError : ZebraError {}
public class ZebraIOError : ZebraError {}
public class ZebraInvalidArgumentError : ZebraError {}
public class ZebraStopIterationError : ZebraError {}
public class ZebraKeyError : ZebraError {}
public class ZebraInvalidStateError : ZebraError {}
public class ZebraRuntimeError : ZebraError {}
public class ZebraActivationError : ZebraError {}
public class ZebraActivationLimitError : ZebraError {}
public class ZebraActivationThrottledError : ZebraError {}
public class ZebraActivationRefusedError : ZebraError {}