Introduction

This documentation serves as an introduction to the Yobe SDK. The library requires two channels of interleaved input audio data (either 16 bit PCM or double encoded) at a sampling rate of 16kHz. The library returns one channel audio data as output with a sampling rate of 16 kHz and some additional data in some cases.

Getting Started

You can check the Quickstart Guides to find a guide for each specific YobeSDK variant.

Example source code can be found in the cpp_samples folder. This folder also contains a README.md that explains how to compile and run the example code. You can view the example code within this documentation in the examples page.

YobeSDK Variants

The Yobe SDK offers the following variants of Yobe:

• Near-CAFE Listening (BioListener) - Use cases when the voice of interest is closer to the microphone inputs than the background noise
• Far-CAFE Listening (BioListener) - Use cases when the voice of interest is farther from the microphone inputs than the background noise
• Near-LATTE ASR-Listening (IDListener) - Use cases when a registered speaker needs to be transcribed in an environment with noise and other un-registered speakers
• Near-LATTE AVR-Listening (IDListener) - Use cases when a registered speaker needs only their speech in the output audio and no noise nor the speech of other un-registered speakers
• GrandE (BioListener + IDListener) - Can be configured to serve all the above use cases

Depending upon your use case, you must use one of the 4 variants mentioned above.

Note: The variants are mutually exclusive i.e. only one of them can be instantiated at a time.

Further Information

• There are functions in Yobe::Info to assist integrating the Yobe library into your project.
• If you run into any problems, take a look at the logging capabilities in Yobe::Info and the Yobe::Status values to get more information.