CwclAudioMeter Class Reference

The Audio Meter component represents a peak meter on an audio stream to or from an audio endpoint device. More...

#include <wclAudio.h>

Inheritance diagram for CwclAudioMeter:

Public Member Functions
	CwclAudioMeter ()
	Creates new audio meter component.
virtual int	GetChannels (unsigned long &Count) override
	Gets the number of channels in the audio stream that are monitored by peak meters.
int	GetChannelsPeak (wclAudioPeakValues &Values)
	Gets the peak sample value for the channels in the audio stream.
virtual int	GetHardwareFeatures (wclAudioHardwareFeatures &Features) override
	Queries the audio endpoint device for its hardware-supported functions.
int	GetPeak (float &Value)
	Gets the peak sample value in the audio stream.
Public Member Functions inherited from CwclCustomAudioEndpoint
	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.
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.
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 int	InternalClose () override
	The method called during audio subsystem finalization.
virtual int	InternalOpen () override
	The method called during audio subsystem initialization.
Protected Member Functions inherited from CwclCustomAudioEndpoint
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 void	DoClosed ()
	Calls the OnClosed event.
virtual void	DoOpened ()
	Calls the OnOpend event.
virtual int	Open ()
	Opens the Audio component.
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 Audio Meter component represents a peak meter on an audio stream to or from an audio endpoint device.

See also

CwclCustomAudioEndpoint