Yobe Namespace Reference

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

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

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

Enumerations
enum class	IDSensitivity {   LOWEST , LOW , MEDIUM , HIGH ,   HIGHEST }
	The level of sensitivity to use for ID template matching. More...
enum class	OutputGain {   LOWEST , LOW , MEDIUM , HIGH ,   HIGHEST }
	This enumeration is used to define the fixed output gain for Yobe's processed buffer. The gain is applied according to the application requirement. Default gain is MEDIUM. More...
enum class	MicOrientation { BROAD_SIDE = 0 , END_FIRE = 15 }
	This enum allows the algorithm to know how your microphones are oriented. [See Details in doxygen docs]. More...
enum class	VoiceTarget { NEAR_FIELD , FAR_FIELD }
	This is used to specify whether the target voice is near or far from the microphone. More...
enum class	OutputBufferType { YOBE_VARIABLE , YOBE_FIXED }
	This is used to define the OutputBufferType of LATTE algorithm. To learn which applies to your application please see the section in the documentation. 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 , ENROLLING = 8 }
	Yobe status codes that give information on internal state. More...

Detailed Description

Contains all Yobe-related functions and structures.

Enumeration Type Documentation

IDSensitivity

enum class Yobe::IDSensitivity

strong

The level of sensitivity to use for ID 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.

OutputGain

enum class Yobe::OutputGain

strong

This enumeration is used to define the fixed output gain for Yobe's processed buffer. The gain is applied according to the application requirement. Default gain is MEDIUM.

Enumerator
LOWEST	The output gain lowest level.
LOW	The output gain low level.
MEDIUM	The output gain medium level. This is the default gain.
HIGH	The output gain high level.
HIGHEST	The output gain highest level.

MicOrientation

enum class Yobe::MicOrientation

strong

This enum allows the algorithm to know how your microphones are oriented. [See Details in doxygen docs].

Enumerator
BROAD_SIDE	This orientation has the target voice perpendicular to the line connecting the two microphones.
END_FIRE	This orientation has the target voice parallel to the line connecting the two microphones (ideally the target is facing microphone 1)

VoiceTarget

enum class Yobe::VoiceTarget

strong

This is 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).

OutputBufferType

enum class Yobe::OutputBufferType

strong

This is used to define the OutputBufferType of LATTE algorithm. To learn which applies to your application please see the section in the documentation.

Enumerator
YOBE_VARIABLE	This allow the output buffer to change sizes.
YOBE_FIXED	This guarantees that the output buffer will always be the same size.

Status

enum class 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.
ENROLLING	This means the last buffer was processed while the IDListener was configured for enrolling a new BiometricTemplate.