Bluetooth Framework C++ Edition
wclAudio Namespace Reference

Classes

class  CwclAudioMeter
 The Audio Meter component represents a peak meter on an audio stream to or from an audio endpoint device. More...
 
class  CwclAudioSwitcher
 The class provides functional to select system default audio device. More...
 
class  CwclAudioVolume
 The component provides methods to control volume control for an audio endpoints. More...
 
class  CwclBluetoothAudioReceiver
 A Bluetooth audio Receiver. More...
 
class  CwclBluetoothAudioWatcher
 The Bluetooth Audio device watcher class. More...
 
class  CwclCustomAudio
 The custom Audio component. More...
 
class  CwclCustomAudioEndpoint
 The base component for Audio components that works with a single Audio endpoint. More...
 
struct  wclAudioDevice
 Contains information about audio device. More...
 
class  wclEAudio
 The base exception class for all Audio exceptions. More...
 

Typedefs

typedef std::set< wclAudioDeviceRole > wclAudioDeviceRoles
 The device roles set.
 
typedef std::set< wclAudioDeviceState > wclAudioDeviceStates
 Set of audio device states.
 
typedef std::vector< float > wclAudioPeakValues
 The audio peak values array.
 
typedef std::set< wclAudioHardwareFeature > wclAudioHardwareFeatures
 The hardware support flags for an audio endpoint device.
 
typedef std::vector< wclAudioDevice > wclAudioDevices
 The array of audio devices.
 

Enumerations

enum  wclAudioDeviceDataFlow { dfRender , dfCapture }
 The audio device data flow direction. More...
 
enum  wclAudioDeviceRole { drConsole , drMultimedia , drCommunications }
 The audio device role. More...
 
enum  wclAudioDeviceState { asActive , asDisabled , asNotPresent , asUnplugged }
 Audio device state. More...
 
enum  wclAudioHardwareFeature { hfVolume , hfMute , hfMeter }
 The hardware support features for an audio endpoint device. More...
 
enum  wclBluetoothAudioReceiverState {
  arClosed , arOpening , arListen , arConnecting ,
  arConnected , arClosing
}
 A Bluetooth audio receiver state. More...
 

Variables

const int WCL_E_AUDIO_BASE = 0x00080000
 The base error code for audio errors.
 
const int WCL_E_AUDIO_COM_INIT_FAILED = WCL_E_AUDIO_BASE + 0x0000
 COM initialization failed.
 
const int WCL_E_AUDIO_CREATE_ENUMERATOR_FAILED = WCL_E_AUDIO_BASE + 0x0001
 Create device enumerator failed.
 
const int WCL_E_AUDIO_FEATURE_NOT_SUPPORTED = WCL_E_AUDIO_BASE + 0x0002
 Audio features is not supported on this platform.
 
const int WCL_E_AUDIO_CLOSED = WCL_E_AUDIO_BASE + 0x0003
 The Audio component is already closed.
 
const int WCL_E_AUDIO_OPENED = WCL_E_AUDIO_BASE + 0x0004
 The Audio component is already opened.
 
const int WCL_E_AUDIO_REGISTER_EVENT_FAILED = WCL_E_AUDIO_BASE + 0x0005
 Unable to register audio device changes event handler.
 
const int WCL_E_AUDIO_ENDPOINT_NOT_FOUND = WCL_E_AUDIO_BASE + 0x0006
 The specified audio endpoint not found.
 
const int WCL_E_AUDIO_GET_CHANNELS_COUNT_FAILED = WCL_E_AUDIO_BASE + 0x0007
 Unable to get audio endpoint channels number.
 
const int WCL_E_AUDIO_GET_HARDWARE_FEATURES_FAILED = WCL_E_AUDIO_BASE + 0x0008
 Unable to get hardware supported features of the specified audio endpoint.
 
const int WCL_E_AUDIO_SWITCHER_BASE = WCL_E_AUDIO_BASE + 0x1000
 The base error code for audio switcher errors.
 
const int WCL_E_AUDIO_SWITCHER_NOT_OPENED = WCL_E_AUDIO_SWITCHER_BASE + 0x0000
 The Audio Switcher is not opened.
 
const int WCL_E_AUDIO_SWITCHER_ENUM_ENDPOINTS_FAILED = WCL_E_AUDIO_SWITCHER_BASE + 0x0001
 Unable to enumerate audio endpoints.
 
const int WCL_E_AUDIO_SWITCHER_GET_ENDPOIN_COUNT_FAILED = WCL_E_AUDIO_SWITCHER_BASE + 0x0002
 Get audio endpoints count failed.
 
const int WCL_E_AUDIO_SWITCHER_CREATE_CONFIGURATOR_FAILED = WCL_E_AUDIO_SWITCHER_BASE + 0x0003
 Create Audio configurator failed.
 
const int WCL_E_AUDIO_SWITCHER_SET_DEFAULT_DEVICE_FAILED = WCL_E_AUDIO_SWITCHER_BASE + 0x0004
 Unable to change default Audio Device.
 
const int WCL_E_AUDIO_SWITCHER_DEVICE_NOT_FOUND = WCL_E_AUDIO_SWITCHER_BASE + 0x0005
 The specified device not found.
 
const int WCL_E_AUDIO_SWITCHER_INVALID_DEVICE = WCL_E_AUDIO_SWITCHER_BASE + 0x0006
 Invalid device selected. Connect and Disconnect features are supported for Bluetooth Audio Devices only.
 
const int WCL_E_AUDIO_SWITCHER_DEVICE_CONNECTED = WCL_E_AUDIO_SWITCHER_BASE + 0x0007
 The device is already connected.
 
const int WCL_E_AUDIO_SWITCHER_DEVICE_DISCONNECTED = WCL_E_AUDIO_SWITCHER_BASE + 0x0008
 The device is disconnected.
 
const int WCL_E_AUDIO_SWITCHER_CREATE_TOPOLOGY_FAILED = WCL_E_AUDIO_SWITCHER_BASE + 0x0009
 Unable to create device topology object.
 
const int WCL_E_AUDIO_SWITCHER_GET_CONNECTORS_COUNT_FAILED = WCL_E_AUDIO_SWITCHER_BASE + 0x000A
 Unable to get device topology connectors number.
 
const int WCL_E_AUDIO_SWITCHER_CONNECT_FAILED = WCL_E_AUDIO_SWITCHER_BASE + 0x000B
 Unable to connect to device.
 
const int WCL_E_AUDIO_SWITCHER_DISCONNECT_FAILED = WCL_E_AUDIO_SWITCHER_BASE + 0x000C
 Unable to disconnect from device.
 
const int WCL_E_AUDIO_SWITCHER_NO_CONNECTORS_FOUND = WCL_E_AUDIO_SWITCHER_BASE + 0x000D
 No device connectors found.
 
const int WCL_E_AUDIO_SWITCHER_GET_DEFAULT_DEVICE_FAILED = WCL_E_AUDIO_SWITCHER_BASE + 0x000E
 Unable to get default Audio Device.
 
const int WCL_E_AUDIO_SWITCHER_GET_DEVICE_ID_FAILED = WCL_E_AUDIO_SWITCHER_BASE + 0x000F
 Get Audio Device ID failed.
 
const int WCL_E_AUDIO_SWITCHER_DEFAULT_DEVICE_NOT_FOUND = WCL_E_AUDIO_SWITCHER_BASE + 0x0010
 Default audio device not found.
 
const int WCL_E_AUDIO_METER_BASE = WCL_E_AUDIO_BASE + 0x2000
 The base error code for audio meter errors.
 
const int WCL_E_AUDIO_METER_GET_PEAK_VALUE_FAILED = WCL_E_AUDIO_METER_BASE + 0x0000
 Unable to get audio stream peak value.
 
const int WCL_E_AUDIO_METER_CREATE_FAILED = WCL_E_AUDIO_METER_BASE + 0x0001
 Unable to create Audio meter instance.
 
const int WCL_E_AUDIO_VOLUME_BASE = WCL_E_AUDIO_BASE + 0x3000
 The base error code for audio volume errors.
 
const int WCL_E_AUDIO_VOLUME_CREATE_FAILED = WCL_E_AUDIO_VOLUME_BASE + 0x0000
 Unable to create Audio volume instance.
 
const int WCL_E_AUDIO_VOLUME_GET_VOLUME_FAILED = WCL_E_AUDIO_VOLUME_BASE + 0x0001
 Unable to get audio volume level.
 
const int WCL_E_AUDIO_VOLUME_SET_VOLUME_FAILED = WCL_E_AUDIO_VOLUME_BASE + 0x0002
 Unable to set audio volume level.
 
const int WCL_E_AUDIO_VOLUME_GET_MUTE_FAILED = WCL_E_AUDIO_VOLUME_BASE + 0x0003
 Unable to get audio endpoint mute status.
 
const int WCL_E_AUDIO_VOLUME_SET_MUTE_FAILED = WCL_E_AUDIO_VOLUME_BASE + 0x0004
 Unable to set audio endpoint mute status.
 
const int WCL_E_BT_AUDIO_BASE = WCL_E_AUDIO_BASE + 0x4000
 The base error code for Bluetooth Audio errors.
 
const int WCL_E_BT_AUDIO_FEATURE_NOT_SUPPORTED = WCL_E_BT_AUDIO_BASE + 0x0000
 This Bluetooth audio feature is not supported on this platform.
 
const int WCL_E_BT_AUDIO_WATCHER_BASE = WCL_E_BT_AUDIO_BASE + 0x0100
 The base error code for Bluetooth Audio Watcher errors.
 
const int WCL_E_BT_AUDIO_WATCHER_STARTED = WCL_E_BT_AUDIO_WATCHER_BASE + 0x0000
 Bluetooth Audio Watcher already started.
 
const int WCL_E_BT_AUDIO_WATCHER_STOPPED = WCL_E_BT_AUDIO_WATCHER_BASE + 0x0001
 Bluetooth Audio Watcher already stopped.
 
const int WCL_E_BT_AUDIO_WATCHER_CREATE_INIT_EVENT_FAILED = WCL_E_BT_AUDIO_WATCHER_BASE + 0x0002
 Unable to create Bluetooth Audio Watcher initialization event.
 
const int WCL_E_BT_AUDIO_WATCHER_CREATE_TERM_EVENT_FAILED = WCL_E_BT_AUDIO_WATCHER_BASE + 0x0003
 Create Bluetooth Audio Watcher termination event failed.
 
const int WCL_E_BT_AUDIO_WATCHER_START_THREAD_FAILED = WCL_E_BT_AUDIO_WATCHER_BASE + 0x0004
 Unable to start Bluetooth Audio Watcher working thread.
 
const int WCL_E_BT_AUDIO_WATCHER_GET_SELECTOR_FAILED = WCL_E_BT_AUDIO_WATCHER_BASE + 0x0005
 Unable to get Bluetooth Audio Device selector.
 
const int WCL_E_BT_AUDIO_WATCHER_CREATE_FAILED = WCL_E_BT_AUDIO_WATCHER_BASE + 0x0006
 Create device watcher failed.
 
const int WCL_E_BT_AUDIO_WATCHER_SET_ADDED_EVENT_FAILED = WCL_E_BT_AUDIO_WATCHER_BASE + 0x0007
 Set Device Added event handler failed.
 
const int WCL_E_BT_AUDIO_WATCHER_SET_REMOVED_EVENT_FAILED = WCL_E_BT_AUDIO_WATCHER_BASE + 0x0008
 Set Device Removed event handler failed.
 
const int WCL_E_BT_AUDIO_WATCHER_START_FAILED = WCL_E_BT_AUDIO_WATCHER_BASE + 0x0009
 Unable to start Bluetooth Audio device watcher.
 
const int WCL_E_BT_AUDIO_RECEIVER_BASE = WCL_E_BT_AUDIO_BASE + 0x0200
 The base error code for Bluetooth Audio Receiver errors.
 
const int WCL_E_BT_AUDIO_RECEIVER_CLOSED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x0000
 The audio receiver is closed.
 
const int WCL_E_BT_AUDIO_RECEIVER_OPENED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x0001
 The audio receiver is opened closed.
 
const int WCL_E_BT_AUDIO_RECEIVER_CREATE_INIT_EVENT_FAILED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x0002
 Unable to create Bluetooth Audio Receiver initialization event.
 
const int WCL_E_BT_AUDIO_RECEIVER_CREATE_TERM_EVENT_FAILED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x0003
 Create Bluetooth Audio Receiver termination event failed.
 
const int WCL_E_BT_AUDIO_RECEIVER_START_THREAD_FAILED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x0004
 Unable to start Bluetooth Audio Receiver working thread.
 
const int WCL_E_BT_AUDIO_RECEIVER_CREATE_CONNECTION_FAILED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x0005
 Unable to create Audio Connection Listener for the specified Bluetooth Audio device.
 
const int WCL_E_BT_AUDIO_RECEIVER_SET_EVENT_HANDLER_FAILED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x0006
 Unable to add Audio Connect Listener event handler.
 
const int WCL_E_BT_AUDIO_RECEIVER_ENABLE_FAILED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x0007
 Enable incoming Bluetooth Audio connection failed.
 
const int WCL_E_BT_AUDIO_RECEIVER_DEVICE_CONNECTED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x0008
 A Bluetooth audio device is already connected.
 
const int WCL_E_BT_AUDIO_RECEIVER_START_CONNECT_FAILED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x0009
 Start Bluetooth Audio connection failed.
 
const int WCL_E_BT_AUDIO_RECEIVER_START_TIMEOUT = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x000A
 Start Bluetooth Audio connection timedout.
 
const int WCL_E_BT_AUDIO_RECEIVER_START_DENIED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x000B
 Start Bluetooth Audio connection denied by system.
 
const int WCL_E_BT_AUDIO_RECEIVER_START_UNKNOWN_FAILED = WCL_E_BT_AUDIO_RECEIVER_BASE + 0x000C
 Unknow error occured during starting Bluetooth Audio connection.