The main class for utilizing the Yobe IDListener functionality. More...
#include <yobe_id_listener.hpp>
Public Member Functions | |
IDListener (const IDListener &)=delete | |
IDListener (IDListener &&) noexcept=default | |
IDListener & | operator= (const IDListener &)=delete |
IDListener & | operator= (IDListener &&) noexcept=default |
virtual Status | Init (const char *license, const char *init_data_path, MicOrientation mic_orientation, OutputBufferType output_voice_target)=0 |
Initializes the internals of the IDListener with additional options. More... | |
virtual Status | Deinit ()=0 |
Cleans up the internals of the IDListener. More... | |
virtual Status | GetStatus () const =0 |
Retrieves the current status of the IDListener. More... | |
virtual MicOrientation | GetMicOrientation () const =0 |
Retrieves the current microphone orientation. More... | |
virtual VoiceTarget | GetVoiceTarget () const =0 |
Retrieves the current voice target status. More... | |
virtual OutputBufferType | GetOutputBufferType () const =0 |
Retrieves the current output buffer type. More... | |
virtual void | SetOutputGain (Yobe::OutputGain gain)=0 |
Set the output gain for the processed output. More... | |
virtual Yobe::OutputGain | GetOutputGain () const =0 |
Get the output gain for the processed output. More... | |
virtual Status | SelectUser (std::shared_ptr< IDTemplate > voice_print)=0 |
Selects the user based on their biometric template. More... | |
virtual IDSensitivity | GetIDSensitivity () const =0 |
Retrieves the sensitivity level for ID template matching. More... | |
virtual void | SetIDSensitivity (IDSensitivity sensitivity_level)=0 |
Set the sensitivity level for ID template matching. More... | |
virtual std::shared_ptr< IDTemplate > | MergeUserTemplates (const std::vector< std::shared_ptr< IDTemplate >> &template_list) const =0 |
Merge multiple IDTemplate containing voice data from the same user into one template. More... | |
virtual std::shared_ptr< IDTemplate > | RegisterTemplate (const double *samples, uint32_t sample_count) const =0 |
Creates a ID template from an audio buffer. More... | |
virtual Status | ProcessBuffer (const int16_t *in_samples, std::vector< int16_t > &out_samples, uint32_t in_sample_count, bool &is_user_verify)=0 |
ProcessBuffer processes a two-channel interleaved audio buffer and writes the processed audio to out_samples. More... | |
virtual Status | ProcessBuffer (const double *in_samples, std::vector< double > &out_samples, uint32_t in_sample_count, bool &is_user_verify)=0 |
ProcessBuffer processes a two-channel interleaved audio buffer and writes the processed audio to out_samples. More... | |
virtual Yobe::Status | StartEnrollment ()=0 |
StartEnrollment configures the IDListener for enrolling a new user through registering their voice into a IDTemplate. More... | |
virtual Yobe::Status | StopEnrollment ()=0 |
StopEnrollment configures the IDListener for normal processing. More... | |
The main class for utilizing the Yobe IDListener functionality.
The IDListener class provides methods for initializing, deinitializing, and processing voice templates. It also provides methods for changing and retrieving the sensitivity level for ID template matching.
|
pure virtual |
Initializes the internals of the IDListener with additional options.
[in] | license | The license provided to you by Yobe. |
[in] | init_data_path | The path to data needed to initialize the IDListener. |
[in] | mic_orientation | This parameter defines the microphones orientation with respect to the target voice. |
[in] | output_voice_target | Indicates either the ASR output or Muting output. [See Details in doxygen docs] |
|
pure virtual |
Cleans up the internals of the IDListener.
|
pure virtual |
Retrieves the current status of the IDListener.
|
pure virtual |
Retrieves the current microphone orientation.
|
pure virtual |
Retrieves the current voice target status.
|
pure virtual |
Retrieves the current output buffer type.
|
pure virtual |
Set the output gain for the processed output.
This API provides user ability to setup fixed gain for the processed audio buffer. The default gain set upped by the SDK is MEDIUM.
|
pure virtual |
Get the output gain for the processed output.
This API provides user ability to get gain for the processed audio buffer. The default gain set upped by the SDK is MEDIUM.
|
pure virtual |
Selects the user based on their biometric template.
[in] | voice_print | The biometric template of the user. |
|
pure virtual |
Retrieves the sensitivity level for ID template matching.
|
pure virtual |
Set the sensitivity level for ID template matching.
sensitivity_level | The sensitivity level to be set. |
|
pure virtual |
Merge multiple IDTemplate containing voice data from the same user into one template.
[in] | template_list | A list of voice templates containing voice data from the same user. |
|
pure virtual |
Creates a ID template from an audio buffer.
This function creates a ID template from an audio buffer containing voice data. The resulting template can be used in either the MergeUserTemplates
or VerifyTemplate
functions to compare the user's voice against a reference template or to merge multiple templates into a single one.
[in] | samples | Pointer to the audio buffer containing the voice data. |
[in] | sample_count | The number of samples in the audio buffer. |
IDTemplate
object that can be used in subsequent operations. If there is an error, this function returns a null pointer.
|
pure virtual |
ProcessBuffer processes a two-channel interleaved audio buffer and writes the processed audio to out_samples.
[in] | in_samples | Pointer to the input audio buffer. |
[out] | out_samples | Pointer to a pre-allocated buffer for the processed audio. |
[in] | in_sample_count | Number of audio samples in the input buffer. |
[out] | is_user_verify | True if the selected user's voice was detected in this buffer. |
|
pure virtual |
ProcessBuffer processes a two-channel interleaved audio buffer and writes the processed audio to out_samples.
[in] | in_samples | Pointer to the input audio buffer. |
[out] | out_samples | Pointer to a pre-allocated buffer for the processed audio. |
[in] | in_sample_count | Number of audio samples in the input buffer. |
[out] | is_user_verify | True if the selected user's voice was detected in this buffer. |
|
pure virtual |
StartEnrollment configures the IDListener for enrolling a new user through registering their voice into a IDTemplate.
Once this is called, ProcessBuffer will output buffers that should be directly fed into the RegisterTemplate function to create a new IDTemplate.
|
pure virtual |
StopEnrollment configures the IDListener for normal processing.
This is usually called after StartEnrollment, once enough data has been given to a IDTemplate for registration.