tt::audio_device Class Reference

#include <ttauri/audio/audio_device.hpp>

Inheritance diagram for tt::audio_device:

Public Member Functions
virtual std::string	id () const noexcept=0
	The nonephemeral unique id that for an audio device on the system.
virtual std::string	name () const noexcept=0
	Get a user friendly name of the audio device.
virtual label	label () const noexcept=0
	Get a user friendly label of the audio device.
virtual audio_device_state	state () const noexcept=0
	Get the current state of the audio device.
virtual audio_direction	direction () const noexcept=0
virtual size_t	full_num_channels () const noexcept=0
virtual speaker_mapping	full_channel_mapping () const noexcept=0
	Get a bitmap of channel mappings for this audio device.

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 gfx_device, 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

full_channel_mapping()

virtual speaker_mapping tt::audio_device::full_channel_mapping ( ) const

pure virtualnoexcept

Get a bitmap of channel mappings for this audio device.

The value returned is independent on the how many channels are actually configured.

Returns

Mapping of audio channels to speaker locations.

Implemented in tt::audio_device_win32.

id()

virtual std::string tt::audio_device::id ( ) const

pure virtualnoexcept

The nonephemeral unique id that for an audio device on the system.

Implemented in tt::audio_device_win32.

label()

virtual label tt::audio_device::label ( ) const

pure virtualnoexcept

Get a user friendly label of the audio device.

This is a combination of the name of the device and the name of the end-point, plus an icon for the driver architecture.

Implemented in tt::audio_device_win32.

name()

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

pure virtualnoexcept

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.

Implemented in tt::audio_device_win32.

state()

virtual audio_device_state tt::audio_device::state ( ) const

pure virtualnoexcept

Get the current state of the audio device.

Implemented in tt::audio_device_win32.

---

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

• hikogui/src/ttauri/audio/audio_device.hpp