Represents an audio device that can send and receive audio data.
More...
#include <AudioDevice.hpp>
Represents an audio device that can send and receive audio data.
AudioDevice class.
◆ getNumChannels()
| virtual uint switchboard::AudioDevice::getNumChannels |
( |
| ) |
|
|
pure virtual |
Gets the number of channels of the audio device.
- Returns
- The number of channels of the audio device.
◆ getSampleRate()
| virtual uint switchboard::AudioDevice::getSampleRate |
( |
| ) |
|
|
pure virtual |
Gets the sample rate of the audio device.
- Returns
- The sample rate of the audio device.
◆ isCapturing()
| virtual bool switchboard::AudioDevice::isCapturing |
( |
| ) |
|
|
pure virtual |
Gets whether the audio device can receive any audio.
- Returns
- True, if the audio device can receive data, false otherwise.
◆ isRendering()
| virtual bool switchboard::AudioDevice::isRendering |
( |
| ) |
|
|
pure virtual |
Gets whether the audio device has any data to provide.
- Returns
- True, if the audio device can provide data, false otherwise.
◆ readRenderData()
| virtual uint32_t switchboard::AudioDevice::readRenderData |
( |
void * |
data, |
|
|
uint32_t |
numberOfSamples |
|
) |
| |
|
pure virtual |
Renders the audio data into an audio buffer.
- Parameters
-
| data | Pointer to the memory where the data will be written. |
| numberOfSamples | The number of samples requested from the audio device. |
- Returns
- The number of samples that was written by the audio device.
◆ writeCaptureData()
| virtual void switchboard::AudioDevice::writeCaptureData |
( |
void * |
data, |
|
|
uint32_t |
numberOfSamples |
|
) |
| |
|
pure virtual |
Writes the audio data into the audio device.
- Parameters
-
| data | Pointer to the memory where the audio data is stored. |
| numberOfSamples | The number of samples in the audio buffer. |
The documentation for this class was generated from the following file:
- /Users/jenkins/.jenkins/workspace/Switchboard Developer Site - Production/SwitchboardSDK/src/all/AudioInterface/AudioDevice.hpp