CwclAudioVolume Class Reference

The component provides methods to control volume control for an audio endpoints. More...

#include <wclAudio.h>

Inheritance diagram for CwclAudioVolume:

Public Member Functions
	CwclAudioVolume ()
	Creates new audio volume component.
virtual int	GetChannels (unsigned long &Count) override
	Gets the number of channels in the audio stream that are controlled by the volume control.
virtual int	GetHardwareFeatures (wclAudioHardwareFeatures &Features) override
	Queries the audio endpoint device for its hardware-supported functions.
int	GetChannelVolume (const unsigned long Channel, float &Volume)
	Gets the channel volume level of the audio stream that enters or leaves the audio endpoint device. The volume level is expressed as a normalized, audio-tapered value in the range from 0.0 to 1.0.
int	GetMute (bool &Mute)
	Gets the audio endpoint mute.
int	GetVolume (float &Volume)
	Gets the master volume level of the audio stream that enters or leaves the audio endpoint device. The volume level is expressed as a normalized, audio-tapered value in the range from 0.0 to 1.0.
int	SetChannelVolume (const unsigned long Channel, const float Value)
	Sets the channel volume level of the audio stream that enters or leaves the audio endpoint device. The volume level is expressed as a normalized, audio-tapered value in the range from 0.0 to 1.0.
int	SetMute (const bool Mute)
	Sets the audio endpoint mute.
int	SetVolume (const float Value)
	Sets the master volume level of the audio stream that enters or leaves the audio endpoint device. The volume level is expressed as a normalized, audio-tapered value in the range from 0.0 to 1.0.
__event void	OnChanged (void *Sender, const bool Muted, const float Volume, const wclAudioPeakValues &Volumes)
	The event fires when the volumes of the specified audio endpoint changed.
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 void	MessageReceived (const CwclMessage *const Message) override
	The method called when a new notification message received.
virtual int	InternalClose () override
	The method called during audio subsystem finalization.
virtual int	InternalOpen () override
	The method called during audio subsystem initialization.
virtual void	DoChanged (const bool Muted, const float Volume, const wclAudioPeakValues &Volumes)
	The method fires the OnChanged event.
Protected Member Functions inherited from CwclCustomAudioEndpoint
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 component provides methods to control volume control for an audio endpoints.

See also

CwclCustomAudioEndpoint