Enums.h File Reference

Enumeration types. More...

Go to the source code of this file.

Enumerations
enum	XtSetup { XtSetupProAudio, XtSetupSystemAudio, XtSetupConsumerAudio }
	Platform-independent service setup. More...
enum	XtSample {   XtSampleUInt8, XtSampleInt16, XtSampleInt24, XtSampleInt32,   XtSampleFloat32 }
	Audio sample format. More...
enum	XtCause {   XtCauseFormat, XtCauseService, XtCauseGeneric, XtCauseUnknown,   XtCauseEndpoint }
	Platform-independent error cause value. More...
enum	XtSystem {   XtSystemALSA = 1, XtSystemASIO, XtSystemJACK, XtSystemWASAPI,   XtSystemPulse, XtSystemDSound }
	Platform-specific service identifier. More...
enum	XtEnumFlags { XtEnumFlagsInput = 0x1, XtEnumFlagsOutput = 0x2, XtEnumFlagsAll = XtEnumFlagsInput | XtEnumFlagsOutput }
	Device enumeration flags. More...
enum	XtDeviceCaps {   XtDeviceCapsNone = 0x0, XtDeviceCapsInput = 0x1, XtDeviceCapsOutput = 0x2, XtDeviceCapsLoopback = 0x4,   XtDeviceCapsHwDirect = 0x8 }
	Audio device capabilities. More...
enum	XtServiceCaps {   XtServiceCapsNone = 0x0, XtServiceCapsTime = 0x1, XtServiceCapsLatency = 0x2, XtServiceCapsFullDuplex = 0x4,   XtServiceCapsAggregation = 0x8, XtServiceCapsChannelMask = 0x10, XtServiceCapsControlPanel = 0x20, XtServiceCapsXRunDetection = 0x40 }
	Audio service capabilities. More...

Detailed Description

Enumeration types.

Enumeration Type Documentation

enum XtCause

Platform-independent error cause value.

See also

XtServiceError

XtPrintCause

Enumerator
XtCauseFormat	Invalid or unsupported audio format.
XtCauseService	A required system service is not running or otherwise unavailable.
XtCauseGeneric	A generic, but anticipated, error occurred.
XtCauseUnknown	An unknown error occurred.
XtCauseEndpoint	Device or channel disconnected, in use, or otherwise unavailable.

enum XtDeviceCaps

Audio device capabilities.

See also

XtDeviceListGetCapabilities

XtPrintDeviceCaps

Enumerator
XtDeviceCapsNone	No capabilities.
XtDeviceCapsInput	The device supports input streams. This includes input and full-duplex devices.
XtDeviceCapsOutput	The device supports output streams. This includes output and full-duplex devices.
XtDeviceCapsLoopback	The device is a loopback device. Loopback devices capture the output of other applications. Currently supported for WASAPI only.
XtDeviceCapsHwDirect	The device corresponds directly to a hardware device. HwDirect devices have system-wide exclusive access to the audio device. No audio mixers run on top of it. Currently corresponds to ASIO, exclusive-mode WASAPI and ALSA hw: devices.

enum XtEnumFlags

Device enumeration flags.

See also

XtServiceOpenDeviceList

Enumerator
XtEnumFlagsInput	Enumerate only input devices.
XtEnumFlagsOutput	Enumerate only output devices.
XtEnumFlagsAll	Enumerate both input and output devices.

enum XtSample

Audio sample format.

See also

XtMix

XtPrintSample

XtAudioGetSampleAttributes

Enumerator
XtSampleUInt8	8-bit unsigned integer.
XtSampleInt16	16-bit signed integer.
XtSampleInt24	24-bit signed integer (packed).
XtSampleInt32	32-bit signed integer.
XtSampleFloat32	32-bit floating-point.

enum XtServiceCaps

Audio service capabilities.

See also

XtServiceGetCapabilities

XtPrintServiceCaps

Enumerator
XtServiceCapsNone	No capabilities.
XtServiceCapsTime	Time stamping. Audio streams are able to provide accurate position and time stamp information which may be used for stream synchronization. See also XtBuffer XtOnBuffer
XtServiceCapsLatency	Latency information. Applications can query the end-to-end latency of a running audio stream. See also XtStreamGetLatency
XtServiceCapsFullDuplex	Full duplex operation. Devices support streams with both input and output channels. See also XtFormat XtChannels
XtServiceCapsAggregation	Audio stream aggregation. Applications are allowed to call XtServiceAggregateStream. Stream aggregatrion is primarily intended to emulate full-duplex on backends which do not natively support this, but may be used to combine any number of input and output devices into a single audio stream. Currently supported for WASAPI, DirectSound, PulseAudio and ALSA. Unsupported for JACK and ASIO (because they natively provide full-duplex already, but also because they are natively callback based API's instead of blocking API's which would greatly complicate implementing stream combining). See also XtServiceAggregateStream
XtServiceCapsChannelMask	Channel masking. Applications can route stream channels from/to specific input/ output channels, for example to specific speaker positions. See also XtFormat XtChannels
XtServiceCapsControlPanel	Backend specific control panel. Applications are allowed to call XtDeviceShowControlPanel. See also XtDeviceShowControlPanel
XtServiceCapsXRunDetection	Under/overflow detection. Streams support xrun detection and will invoke the application's xrun callback when an under/overflow occurs. See also XtOnXRun

enum XtSetup

Platform-independent service setup.

See also

XtPrintSetup

XtPlatformSetupToSystem

Enumerator
XtSetupProAudio	Pro audio setup (ASIO and JACK). Focused on full-duplex operation and low latency. Device sharing and automatic format conversions are less important. May require specialized software and/or hardware.
XtSetupSystemAudio	System audio setup (WASAPI and ALSA). Focused on direct hardware access and low latency. Full duplex operation, device sharing and automatic format conversions are less important. Does not require additional software.
XtSetupConsumerAudio	Consumer audio setup (DirectSound and PulseAudio). Focused on device sharing and automatic format conversions. Full duplex operation, direct hardware access and low latency are less important. Usually does not require additional software.

enum XtSystem

Platform-specific service identifier.

See also

XtErrorInfo

XtPlatformGetService

XtPlatformGetSystems

XtPrintSystem

Enumerator
XtSystemALSA	Linux ALSA backend.
XtSystemASIO	Windows Steinberg ASIO backend.
XtSystemJACK	Linux JACK backend.
XtSystemWASAPI	Windows WASAPI backend.
XtSystemPulse	Linux PulseAudio backend.
XtSystemDSound	Windows DirectSound backend.