Audio device parameters. More...

#include <aspl/Device.hpp>

Public Attributes
std::string	Name = "libASPL Device"
	Human-readable name of the device. Used by default implementation of Device::GetName().

std::string	Manufacturer = "libASPL"
	Human readable name of the maker of the plug-in. Used by default implementation of Device::GetManufacturer().

std::string	DeviceUID = ""
	Persistent token that can identify the same audio device across boot sessions. Used by default implementation of Device::GetDeviceUID().

std::string	ModelUID = "libaspl"
	Persistent token that can identify audio devices of the same kind. Used by default implementation of Device::GetModelUID().

std::string	SerialNumber = ""
	Human readable serial number of the device. Used by default implementation of Device::GetSerialNumber().

std::string	FirmwareVersion = ""
	Human readable firmware version of the device. Used by default implementation of Device::GetFirmwareVersion().

std::string	IconURL = ""
	URL that points to the device icon, e.g. in plugin resource bundle. Used by default implementation of Device::GetIconURL().

std::string	ConfigurationApplicationBundleID = ""
	Bundle ID for an application that provides a GUI for configuring the device. Used by default implementation of Device::GetConfigurationApplicationBundleID().

bool	CanBeDefault = true
	Whether the device can be the default device for content. Used by default implementation of Device::GetCanBeDefaultDevice().

bool	CanBeDefaultForSystemSounds = true
	Whether the device can be the default device for system sounds. Used by default implementation of Device::GetCanBeDefaultSystemDevice().

UInt32	SampleRate = 44100
	Device sample rate. Used by default implementation of Device::GetNominalSampleRate().

UInt32	ChannelCount = 2
	Preferred number of channels. Used by default implementations of Device::GetPreferredChannelCount().

UInt32	Latency = 0
	The presentation latency of the device, number of frames. Used by default implementation of Device::GetLatency().

UInt32	SafetyOffset = 0
	How close to now it is allowed to read and write, number of frames. Used by default implementation of Device::GetSafetyOffset().

UInt32	ZeroTimeStampPeriod = 0
	How many frames to expect between successive timestamps returned from Device::GetZeroTimeStamp() Used by default implementation of Device::GetZeroTimeStampPeriod(). If zero, assigned to SampleRate value, which means one second.

bool	ClockIsStable = true
	Whether the device clock should be considered stable. Used by default implementation of Device::GetClockIsStable().

AudioDeviceClockAlgorithmSelector	ClockAlgorithm
	Clock algorithm. Used by default implementation of Device::GetClockAlgorithm().

UInt32	ClockDomain = 0
	Clock domain. Used by default implementation of Device::GetClockDomain().

bool	EnableMixing = true
	Whether IORequestHandler will handle mixed output from all clients, or handle individual clients and perform mixing by itself.

bool	EnableRealtimeTracing = false
	If true, realtime calls are logged to tracer. This is not suitable for production use because tracer is not realtime-safe and because realtime operations are too frequent.

Detailed Description

Audio device parameters.

Definition at line 33 of file Device.hpp.

Member Data Documentation

◆ CanBeDefault

bool aspl::DeviceParameters::CanBeDefault = true

Whether the device can be the default device for content. Used by default implementation of Device::GetCanBeDefaultDevice().

Definition at line 69 of file Device.hpp.

◆ CanBeDefaultForSystemSounds

bool aspl::DeviceParameters::CanBeDefaultForSystemSounds = true

Whether the device can be the default device for system sounds. Used by default implementation of Device::GetCanBeDefaultSystemDevice().

Definition at line 73 of file Device.hpp.

◆ ChannelCount

UInt32 aspl::DeviceParameters::ChannelCount = 2

Preferred number of channels. Used by default implementations of Device::GetPreferredChannelCount().

Definition at line 81 of file Device.hpp.

◆ ClockAlgorithm

AudioDeviceClockAlgorithmSelector aspl::DeviceParameters::ClockAlgorithm

Initial value:

=

kAudioDeviceClockAlgorithmSimpleIIR

Clock algorithm. Used by default implementation of Device::GetClockAlgorithm().

Definition at line 103 of file Device.hpp.

◆ ClockDomain

UInt32 aspl::DeviceParameters::ClockDomain = 0

Clock domain. Used by default implementation of Device::GetClockDomain().

Definition at line 108 of file Device.hpp.

◆ ClockIsStable

bool aspl::DeviceParameters::ClockIsStable = true

Whether the device clock should be considered stable. Used by default implementation of Device::GetClockIsStable().

Definition at line 99 of file Device.hpp.

◆ ConfigurationApplicationBundleID

std::string aspl::DeviceParameters::ConfigurationApplicationBundleID = ""

Bundle ID for an application that provides a GUI for configuring the device. Used by default implementation of Device::GetConfigurationApplicationBundleID().

Definition at line 65 of file Device.hpp.

◆ DeviceUID

std::string aspl::DeviceParameters::DeviceUID = ""

Persistent token that can identify the same audio device across boot sessions. Used by default implementation of Device::GetDeviceUID().

Definition at line 45 of file Device.hpp.

◆ EnableMixing

bool aspl::DeviceParameters::EnableMixing = true

Whether IORequestHandler will handle mixed output from all clients, or handle individual clients and perform mixing by itself.

When true, Device will invoke IORequestHandler::OnProcessMixedOutput() and IORequestHandler::WriteMixedOutput(). It will be provided with the result of mixing of all clients.
When false, Device will invoke IORequestHandler::OnProcessClientOutput() and IORequestHandler::WriteClientOutput(). It will be repeatedly called with the output from each client. IORequestHandler is responsible for mixing in this case.

Definition at line 121 of file Device.hpp.

◆ EnableRealtimeTracing

bool aspl::DeviceParameters::EnableRealtimeTracing = false

If true, realtime calls are logged to tracer. This is not suitable for production use because tracer is not realtime-safe and because realtime operations are too frequent.

Definition at line 126 of file Device.hpp.

◆ FirmwareVersion

std::string aspl::DeviceParameters::FirmwareVersion = ""

Human readable firmware version of the device. Used by default implementation of Device::GetFirmwareVersion().

Definition at line 57 of file Device.hpp.

◆ IconURL

std::string aspl::DeviceParameters::IconURL = ""

URL that points to the device icon, e.g. in plugin resource bundle. Used by default implementation of Device::GetIconURL().

Definition at line 61 of file Device.hpp.

◆ Latency

UInt32 aspl::DeviceParameters::Latency = 0

The presentation latency of the device, number of frames. Used by default implementation of Device::GetLatency().

Definition at line 85 of file Device.hpp.

◆ Manufacturer

std::string aspl::DeviceParameters::Manufacturer = "libASPL"

Human readable name of the maker of the plug-in. Used by default implementation of Device::GetManufacturer().

Definition at line 41 of file Device.hpp.

◆ ModelUID

std::string aspl::DeviceParameters::ModelUID = "libaspl"

Persistent token that can identify audio devices of the same kind. Used by default implementation of Device::GetModelUID().

Definition at line 49 of file Device.hpp.

◆ Name

std::string aspl::DeviceParameters::Name = "libASPL Device"

Human-readable name of the device. Used by default implementation of Device::GetName().

Definition at line 37 of file Device.hpp.

◆ SafetyOffset

UInt32 aspl::DeviceParameters::SafetyOffset = 0

How close to now it is allowed to read and write, number of frames. Used by default implementation of Device::GetSafetyOffset().

Definition at line 89 of file Device.hpp.

◆ SampleRate

UInt32 aspl::DeviceParameters::SampleRate = 44100

Device sample rate. Used by default implementation of Device::GetNominalSampleRate().

Definition at line 77 of file Device.hpp.

◆ SerialNumber

std::string aspl::DeviceParameters::SerialNumber = ""

Human readable serial number of the device. Used by default implementation of Device::GetSerialNumber().

Definition at line 53 of file Device.hpp.

◆ ZeroTimeStampPeriod

UInt32 aspl::DeviceParameters::ZeroTimeStampPeriod = 0

How many frames to expect between successive timestamps returned from Device::GetZeroTimeStamp() Used by default implementation of Device::GetZeroTimeStampPeriod(). If zero, assigned to SampleRate value, which means one second.

Definition at line 95 of file Device.hpp.

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

aspl/Device.hpp

Public Attributes