Cobra Voice Activity Detection
Android API

API Reference for the Android Cobra SDK (cobra-android)

package: ai.picovoice.cobra

Cobra

public class Cobra { }

Class for the Cobra VAD engine.

Cobra must be initialized using the Builder() Class. Resources should be cleaned when you are done using the delete() function.

Cobra.getAvailableDevices()

public static String[] getAvailableDevices() throws CobraException

Lists all available devices that Cobra can use for inference. Each entry in the list can be used as the device argument when initializing Cobra.

Returns

• String[]: Array of all available devices that Cobra can be used for inference.

Throws

• CobraException: If an error occurs while getting available devices.

Cobra.getFrameLength()

public int getFrameLength();

Getter for required number of audio samples per frame.

Returns

• int : Required number of audio samples per frame.

Cobra.getSampleRate()

public int getSampleRate();

Getter for required audio sample rate

Returns

• int : Required audio sample rate.

Cobra.getVersion()

public String getVersion();

Getter for Cobra version.

Returns

• String : Cobra version.

Cobra.delete()

public void delete();

Releases resources acquired by Cobra.

Cobra.process()

public float process(short[] pcm) throws CobraException

Processes a frame of the incoming audio stream and emits the detection result. The required number of samples-per-frame can be obtained by calling .getFrameLength(). The incoming audio needs to have a sample rate equal to .getSampleRate() and be 16-bit linearly-encoded. Cobra operates on single-channel audio.

Parameters

• pcm short[] : A frame of audio samples.

Returns

• float : Probability of voice activity. It is a floating-point number within [0, 1].

Throws

• CobraException: If an error occurs while processing.

Cobra.Builder

public static class Builder { }

Builder for creating an instance of Cobra with a mixture of default arguments.

Cobra.Builder.build()

public Cobra build() throws CobraException

Creates an instance of Cobra VAD engine.

Returns

• Cobra: An instance of Cobra VAD engine.

Throws

• CobraException: If an error occurs while creating an instance of Cobra VAD engine.

Cobra.Builder.setAccessKey()

public Cobra.Builder setAccessKey(String accessKey)

Sets the AccessKey of the builder.

Parameters

• accessKey String : AccessKey obtained from Picovoice Console.

Returns

• Cobra.Builder: Modified Cobra.Builder object.

Cobra.Builder.setDevice()

public Cobra.Builder setDevice(String device)

Sets the device of the builder. If not set it will be set to the default device.

Parameters

• device String : String representation of the device (e.g., CPU or GPU) to use.

Returns

• Cobra.Builder: Modified Cobra.Builder object.

CobraException

public class CobraException extends Exception { }

Exception thrown if an error occurs within Cobra VAD engine.

Exceptions

public class CobraActivationException           extends CobraException { }
public class CobraActivationLimitException      extends CobraException { }
public class CobraActivationRefusedException    extends CobraException { }
public class CobraActivationThrottledException  extends CobraException { }
public class CobraIOException                   extends CobraException { }
public class CobraInvalidArgumentException      extends CobraException { }
public class CobraInvalidStateException         extends CobraException { }
public class CobraKeyException                  extends CobraException { }
public class CobraMemoryException               extends CobraException { }
public class CobraRuntimeException              extends CobraException { }
public class CobraStopIterationException        extends CobraException { }