YobeSDK 0.3.2
 
Loading...
Searching...
No Matches
yobe_lib_util.hpp File Reference
#include "sdk_build_defs.h"
#include <cstdint>
#include <functional>

Go to the source code of this file.

Namespaces

namespace  Yobe
 Contains all Yobe-related functions and structures.
 
namespace  Yobe::Info
 Namespace for obtaining information about Yobe's library.
 

Enumerations

enum class  Yobe::IDSensitivity {
  Yobe::LOWEST , Yobe::LOW , Yobe::MEDIUM , Yobe::HIGH ,
  Yobe::HIGHEST
}
 The level of sensitivity to use for ID template matching. More...
 
enum class  Yobe::OutputGain {
  Yobe::LOWEST , Yobe::LOW , Yobe::MEDIUM , Yobe::HIGH ,
  Yobe::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  Yobe::MicOrientation { Yobe::BROAD_SIDE = 0 , Yobe::END_FIRE = 15 }
 This enum allows the algorithm to know how your microphones are oriented. [See Details in doxygen docs]. More...
 
enum class  Yobe::VoiceTarget { Yobe::NEAR_FIELD , Yobe::FAR_FIELD }
 This is used to specify whether the target voice is near or far from the microphone. More...
 
enum class  Yobe::OutputBufferType { Yobe::YOBE_VARIABLE , Yobe::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  Yobe::Status : int16_t {
  Yobe::YOBE_UNKNOWN = -1 , Yobe::YOBE_OK = 0 , Yobe::YOBE_ERROR = 1 , Yobe::ALREADY_INIT = 2 ,
  Yobe::NEEDS_MORE_DATA = 3 , Yobe::INVALID_LICENSE = 4 , Yobe::SESSION_EXPIRE = 5 , Yobe::YOBE_STOPPED = 6 ,
  Yobe::HANDLE_INVALID = 7 , Yobe::ENROLLING = 8
}
 Yobe status codes that give information on internal state. More...
 

Functions

YOBE_SDK_API const char * Yobe::Info::LibraryVersion ()
 Returns the version of Yobe's library in the format: <Major>.<Interim>.<Minor>
 
YOBE_SDK_API const char * Yobe::Info::StdError (Status status)
 Translates a Yobe Status code into a more readable string.
 
YOBE_SDK_API double Yobe::Info::AudioBufferTime ()
 Returns the processing audio buffer length in seconds.
 
YOBE_SDK_API uint32_t Yobe::Info::OutputBufferSize ()
 Returns the output buffer size in samples.
 
YOBE_SDK_API uint32_t Yobe::Info::InputBufferSize ()
 Returns the input buffer size in samples.
 
YOBE_SDK_API int32_t Yobe::Info::OutputChannels ()
 Returns the number of processing output channels.
 
YOBE_SDK_API int32_t Yobe::Info::InputChannels ()
 Returns the number of input channels required for processing.
 
YOBE_SDK_API uint32_t Yobe::Info::SamplingRate (bool output_sampling_rate=true)
 Returns the expected sampling rate of the input/output buffers.
 
YOBE_SDK_API void Yobe::Info::RegisterCallback (std::function< void(const char *)> log_callback)
 Registers a callback function to receive Yobe logging information.
 

Detailed Description

@description: The API for Yobe's library utilities.