Yobe::Info Namespace Reference

Namespace for obtaining information about Yobe's library. More...

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

Detailed Description

Namespace for obtaining information about Yobe's library.

Function Documentation

LibraryVersion()

YOBE_SDK_API const char * Yobe::Info::LibraryVersion

(

)

Returns the version of Yobe's library in the format: <Major>.<Interim>.<Minor>

Returns

C-string of the version of Yobe's library.

StdError()

YOBE_SDK_API const char * Yobe::Info::StdError

(

Status

status

)

Translates a Yobe Status code into a more readable string.

Parameters

status

The Yobe Status code to translate.

Returns

A C-string with a human-readable version of the Yobe Status code.

Examples

BioListener_demo.cpp, and IDListener_demo.cpp.

AudioBufferTime()

YOBE_SDK_API double Yobe::Info::AudioBufferTime

(

)

Returns the processing audio buffer length in seconds.

Returns

The processing audio buffer length in seconds.

Examples

BioListener_demo.cpp, and IDListener_demo.cpp.

OutputBufferSize()

YOBE_SDK_API uint32_t Yobe::Info::OutputBufferSize

(

)

Returns the output buffer size in samples.

Returns

The output buffer size in samples.

Examples

BioListener_demo.cpp.

InputBufferSize()

YOBE_SDK_API uint32_t Yobe::Info::InputBufferSize

(

)

Returns the input buffer size in samples.

Note

This can be 128ms, 256ms, 512ms, or 1024ms at 16kHz.

Returns

The input buffer size in samples.

Examples

BioListener_demo.cpp, and IDListener_demo.cpp.

OutputChannels()

YOBE_SDK_API int32_t Yobe::Info::OutputChannels

(

)

Returns the number of processing output channels.

Note

This will always be two channels, one for near voice and one for far voice.

Returns

The number of processing output channels.

Examples

BioListener_demo.cpp, and IDListener_demo.cpp.

InputChannels()

YOBE_SDK_API int32_t Yobe::Info::InputChannels

(

)

Returns the number of input channels required for processing.

Note

This will always be two channels.

Returns

The number of input channels required for processing.

Examples

BioListener_demo.cpp, and IDListener_demo.cpp.

SamplingRate()

YOBE_SDK_API uint32_t Yobe::Info::SamplingRate

(

bool

output_sampling_rate = true

)

Returns the expected sampling rate of the input/output buffers.

Note

The sampling rate needs to be 16kHz.

Parameters

output_sampling_rate

If true, returns the output buffer's sampling rate, otherwise returns the input buffer's sampling rate.

Returns

The expected sampling rate of the input/output buffers.

Examples

BioListener_demo.cpp, and IDListener_demo.cpp.

RegisterCallback()

YOBE_SDK_API void Yobe::Info::RegisterCallback

(

std::function< void(const char *)>

log_callback

)

Registers a callback function to receive Yobe logging information.

Parameters

log_callback

The callback function which will receive logging information as a string.

Examples

BioListener_demo.cpp, and IDListener_demo.cpp.