Yobe Namespace Reference

Contains all Yobe-related functions and structures. More...

Namespaces
	Create
	Namespace for functions that create new instances of Yobe objects.
	Info
	Namespace for obtaining information about Yobe's library.

Classes
struct	BioListener
	The main class for utilizing the Yobe BioListener functionality. More...
struct	BiometricTemplate
	This struct is used to store biometric data of a user. More...
struct	IDListener
	The main class for utilizing the Yobe IDListener functionality. More...

Enumerations
enum class	BiometricSensitivity {   LOWEST , LOW , MEDIUM , HIGH ,   HIGHEST }
	The level of sensitivity to use for biometric template matching. More...
enum class	VoiceTarget { NEAR_FIELD , FAR_FIELD }
	These enums are used to specify whether the target voice is near or far from the microphone. More...
enum class	OutputTarget { YOBE_ASR , YOBE_MUTE }
	The enumeration is used to define the output target of LATTE algorithm. The output or sink target can be either for Automatic Speech Recognition (ASR) or for muting applications. More...
enum class	Status : int16_t {   YOBE_UNKNOWN = -1 , YOBE_OK = 0 , YOBE_ERROR = 1 , ALREADY_INIT = 2 ,   NEEDS_MORE_DATA = 3 , INVALID_LICENSE = 4 , SESSION_EXPIRE = 5 , YOBE_STOPPED = 6 ,   HANDLE_INVALID = 7 }
	Yobe status codes that give information on internal state. More...

Detailed Description

Contains all Yobe-related functions and structures.

Enumeration Type Documentation

BiometricSensitivity

enum Yobe::BiometricSensitivity

strong

The level of sensitivity to use for biometric template matching.

Enumerator
LOWEST	Use the lowest matching threshold, but with a higher likelihood of false detections.
LOW	Use a low matching threshold.
MEDIUM	Use a medium matching threshold.
HIGH	Use a high matching threshold.
HIGHEST	Use the highest matching threshold, with the lowest likelihood of false detections.

VoiceTarget

enum Yobe::VoiceTarget

strong

These enums are used to specify whether the target voice is near or far from the microphone.

Enumerator
NEAR_FIELD	The target voice is near field (less than 2 feet).
FAR_FIELD	The target voice is far field (3 feet or more).

OutputTarget

enum Yobe::OutputTarget

strong

The enumeration is used to define the output target of LATTE algorithm. The output or sink target can be either for Automatic Speech Recognition (ASR) or for muting applications.

Enumerator
YOBE_ASR	The output or sink is for Automatic Speech Recognition (ASR) applications.
YOBE_MUTE	The output or sink is for muting applications.

Status

enum Yobe::Status : int16_t

strong

Yobe status codes that give information on internal state.

Enumerator
YOBE_UNKNOWN	An unknown error has occurred.
YOBE_OK	The function executed successfully.
YOBE_ERROR	A known error occurred in the function.
ALREADY_INIT	The library has already been started.
NEEDS_MORE_DATA	The algorithm needs more data before it can start processing the audio.
INVALID_LICENSE	The license is invalid.
SESSION_EXPIRE	This means the Yobe session timing has expired.
YOBE_STOPPED	This means that the engine successfully stopped.
HANDLE_INVALID	This means that the engine has not been initialized.