CwclAudioSwitcher Class Reference

The class provides functional to select system default audio device. More...

#include <wclAudio.h>

Inheritance diagram for CwclAudioSwitcher:

Public Member Functions
	CwclAudioSwitcher ()
	Creates new Audio Switcher component.
virtual int	Open () override
	Opens the Audio Switcher component.
int	Enum (const wclAudioDeviceStates &States, wclAudioDevices &Devices)
	Enumerates available audio devices.
int	GetDeviceDetails (const tstring &Id, wclAudioDevice &Device)
	Gets the specified Audio Device information.
int	GetDefault (const wclAudioDeviceRole Role, const wclAudioDeviceDataFlow Flow, tstring &Id)
	Gets the default Audio Device for the specified Role and Data Flow.
int	SetDefault (const wclAudioDeviceRole Role, const tstring &Id)
	Sets the specified Audio Device as default for the specified Role.
int	Connect (const tstring &Id)
	Connects to the specified Audio Device.
int	Connect (const __int64 Address)
	Connects to the specified Audio Device.
int	Disconnect (const tstring &Id)
	Disconnects from the specified Audio Device.
int	Disconnect (const __int64 Address)
	Disconnects from the specified Audio Device.
__event void	OnDefaultDeviceChanged (void *Sender, const tstring &Id, const wclAudioDeviceDataFlow Flow, const wclAudioDeviceRole Role)
	The event fires when default audio device changed.
__event void	OnDeviceAdded (void *Sender, const tstring &Id)
	The event fires when new audio device added.
__event void	OnDeviceRemoved (void *Sender, const tstring &Id)
	The event fires when audio device removed.
__event void	OnStateChanged (void *Sender, const tstring &Id, const wclAudioDeviceState State)
	The event fires when audio device state changed.
Public Member Functions inherited from CwclCustomAudio
	CwclCustomAudio ()
	Creates new Audio component.
virtual	~CwclCustomAudio ()
	Frees the component.
virtual int	Close ()
	Closes the Audio component.
bool	GetActive () const
	Gets the Audio Switcher state.
	__declspec (property(get=GetActive)) bool Active
	Gets the Audio Switcher state.
wclMessageProcessingMethod	GetMessageProcessing () const
	Gets a message processing method that should be used by the Audio component.
void	SetMessageProcessing (const wclMessageProcessingMethod Value)
	Sets a message processing method that should be used by the Audio component.
	__declspec (property(get=GetMessageProcessing, put=SetMessageProcessing)) wclMessageProcessingMethod MessageProcessing
	Gets and sets a message processing method that should be used by the Audio component.
__event void	OnClosed (void *Sender)
	The event fires when the Audio Switcher was closed.
__event void	OnOpened (void *Sender)
	The event fires when the Audio Switcher was opened.

Protected Member Functions
virtual void	MessageReceived (const CwclMessage *const Message) override
	The method called when a new notification message received.
virtual void	DoDefaultDeviceChanged (const tstring &Id, const wclAudioDeviceDataFlow Flow, const wclAudioDeviceRole Role)
	Calls the OnDefaultDeviceChanged event.
virtual void	DoDeviceAdded (const tstring &Id)
	Calls the OnDeviceAdded event.
virtual void	DoDeviceRemoved (const tstring &Id)
	Calls the OnDeviceRemoved event.
virtual void	DoStateChanged (const tstring &Id, const wclAudioDeviceState State)
	Calls the OnStateChanged event.
Protected Member Functions inherited from CwclCustomAudio
virtual int	InternalClose ()
	The method called during audio subsystem finalization.
virtual int	InternalOpen ()
	The method called during audio subsystem initialization.
virtual void	DoClosed ()
	Calls the OnClosed event.
virtual void	DoOpened ()
	Calls the OnOpend event.
AudioApi::IMMDeviceEnumerator *	GetEnumerator () const
	Gets the Audio devices enumerator interface.
__declspec(property(get=GetEnumerator)) AudioApi CwclMessageReceiver *	GetReceiver () const
	Gets the Audio devices enumerator interface.
	__declspec (property(get=GetReceiver)) CwclMessageReceiver *Receiver
	Gets the message receiver.

Detailed Description

The class provides functional to select system default audio device.

See also

CwclCustomAudio