tt::AudioDevice Class Reference

#include <TTauri/Audio/AudioDevice.hpp>

Inheritance diagram for tt::AudioDevice:

Public Member Functions
virtual std::string	name () const noexcept=0
virtual std::string	deviceName () const noexcept=0
virtual std::string	endPointName () const noexcept=0
virtual AudioDevice_state	state () const noexcept=0

Data Fields
std::string	id

Detailed Description

A set of audio channels which can be rendered and/or captures at the same time. On win32 this would be Audio Endpoint GUIDevice, which can either render or capture but not at the same time.

On MacOS this would contain all the inputs and outputs of either a physical or aggregate device that can run in the same clock domain, with both render and capture at the same time.

Member Function Documentation

deviceName()

virtual std::string tt::AudioDevice::deviceName ( ) const

pure virtualnoexcept

Get a user friendly name of the audio device. This is the name of the audio device itself, such as "Realtek High Definition Audio".

Implemented in tt::AudioDevice_win32.

endPointName()

virtual std::string tt::AudioDevice::endPointName ( ) const

pure virtualnoexcept

Get a user friendly name of the audio end-point device. This is the name of the end point, such as "Microphone".

Implemented in tt::AudioDevice_win32.

name()

virtual std::string tt::AudioDevice::name ( ) const

pure virtualnoexcept

Get a identfier for this device which can be stored into a preferences file and be used after a reboot to get the same device.

Get a user friendly name of the audio device. This is a combination of the name of the device and the name of the end-point. Such as

Implemented in tt::AudioDevice_win32.

state()

virtual AudioDevice_state tt::AudioDevice::state ( ) const

pure virtualnoexcept

Get the current state of the audio device.

Implemented in tt::AudioDevice_win32.

---

The documentation for this class was generated from the following file:

• hikogui/src/TTauri/Audio/AudioDevice.hpp