Bluetooth Framework C++ Edition
Public Member Functions | Protected Member Functions | List of all members
CwclCustomAudioEndpoint Class Referenceabstract

The base component for Audio components that works with a single Audio endpoint. More...

#include <wclAudio.h>

Inheritance diagram for CwclCustomAudioEndpoint:
CwclCustomAudio CwclAudioMeter CwclAudioVolume

Public Member Functions

 CwclCustomAudioEndpoint ()
 Creates new custom audio endpoint component.
 
int Close () override
 Closes the audio endpoint.
 
virtual int Open (const tstring &Id)
 Opens the specified audio endpoint.
 
virtual int GetChannels (unsigned long &Count)=0
 Gets the number of channels in the audio stream that are monitored by peak meters.
 
virtual int GetHardwareFeatures (wclAudioHardwareFeatures &Features)=0
 Queries the audio endpoint device for its hardware-supported functions.
 
tstring GetId () const
 Gets the endpoint ID.
 
 __declspec (property(get=GetId)) tstring Id
 Gets the endpoint ID.
 
__event void OnDisconnected (void *Sender)
 The even fires when the endpoint used by this class has been disconnected or removed.
 
- 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.
 
__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 DoDisconnected ()
 Fires the OnDisconnected 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 MessageReceived (const CwclMessage *const Message)
 The method called when a new notification message received.
 
virtual void DoClosed ()
 Calls the OnClosed event.
 
virtual void DoOpened ()
 Calls the OnOpend event.
 
virtual int Open ()
 Opens the Audio component.
 
IMMDeviceEnumerator * GetEnumerator () const
 Gets the Audio devices enumerator interface.
 
 __declspec (property(get=GetEnumerator)) IMMDeviceEnumerator *Enumerator
 Gets the Audio devices enumerator interface.
 
CwclMessageReceiverGetReceiver () const
 Gets the message receiver.
 
 __declspec (property(get=GetReceiver)) CwclMessageReceiver *Receiver
 Gets the message receiver.
 

Detailed Description

The base component for Audio components that works with a single Audio endpoint.

See also
CwclCustomAudio