An audio endpoint device. More...

Inheritance diagram for VolumeControl.CoreAudio.AudioDevice:

Collaboration diagram for VolumeControl.CoreAudio.AudioDevice:

Public Member Functions
void	Dispose ()

override string	ToString ()
	Gets the FullName of this AudioDevice instance. More...

Properties
AudioDeviceSessionManager	SessionManager `[get]`
	Gets the AudioDeviceSessionManager instance that manages this AudioDevice instance's AudioSessions. More...

DataFlow	DataFlow `[get]`
	Gets the DataFlow direction of this audio device. More...

string	FullName `[get]`
	Gets the full name of this AudioDevice instance, including both the device name and the interface name. More...

string	Name `[get]`
	Gets the name of this AudioDevice instance as shown in the Windows sound settings window. More...

string	ID `[get]`
	Gets the ID string of this AudioDevice instance. More...

bool	IsDefault `[get, set]`
	Gets whether this is the default AudioDevice or not. More...

string	IconPath `[get]`
	Gets the path to the device's icon file. More...

float	NativeVolume `[get, set]`

int	Volume `[get, set]`

bool	Mute `[get, set]`

float	PeakMeterValue `[get]`

Properties inherited from VolumeControl.CoreAudio.Interfaces.IAudioControl
float	NativeVolume `[get, set]`
	Gets or sets the volume level of the audio instance, in the native float format. More...

int	Volume `[get, set]`
	Gets or sets the volume level of the audio instance. More...

bool	Mute `[get, set]`
	Gets or sets the mute state of the audio instance. More...

DataFlow	DataFlow `[get]`
	Gets whether this audio control is a capture or render instance. More...

Properties inherited from VolumeControl.CoreAudio.Interfaces.IReadOnlyAudioControl
float	NativeVolume `[get]`
	Gets the volume level, in the native float format. More...

int	Volume `[get]`
	Gets the volume level. More...

bool	Mute `[get]`
	Gets the mute state. More...

DataFlow	DataFlow `[get]`
	Gets whether this audio control is a capture or render instance. More...

Properties inherited from VolumeControl.CoreAudio.Interfaces.IAudioPeakMeter
float	PeakMeterValue `[get]`
	The current peak meter value. More...

Events
PropertyChangedEventHandler?	PropertyChanged

VolumeChangedEventHandler?	VolumeChanged
	Occurs when this AudioDevice instance's volume or mute state was changed. More...

Detailed Description

An audio endpoint device.

Member Function Documentation

◆ ToString()

override string VolumeControl.CoreAudio.AudioDevice.ToString ( )

Gets the FullName of this AudioDevice instance.

Returns: The FullName string of this AudioDevice instance.

Property Documentation

◆ DataFlow

DataFlow VolumeControl.CoreAudio.AudioDevice.DataFlow

get

Gets the DataFlow direction of this audio device.

◆ FullName

string VolumeControl.CoreAudio.AudioDevice.FullName

get

Gets the full name of this AudioDevice instance, including both the device name and the interface name.

◆ IconPath

string VolumeControl.CoreAudio.AudioDevice.IconPath

get

Gets the path to the device's icon file.

◆ ID

string VolumeControl.CoreAudio.AudioDevice.ID

get

Gets the ID string of this AudioDevice instance.

◆ IsDefault

bool VolumeControl.CoreAudio.AudioDevice.IsDefault

getset

Gets whether this is the default AudioDevice or not.

Returns: true when this is the default device; otherwise false.

◆ Name

string VolumeControl.CoreAudio.AudioDevice.Name

get

Gets the name of this AudioDevice instance as shown in the Windows sound settings window.

◆ SessionManager

AudioDeviceSessionManager VolumeControl.CoreAudio.AudioDevice.SessionManager

get

Gets the AudioDeviceSessionManager instance that manages this AudioDevice instance's AudioSessions.

Event Documentation

◆ VolumeChanged

VolumeChangedEventHandler? VolumeControl.CoreAudio.AudioDevice.VolumeChanged

Occurs when this AudioDevice instance's volume or mute state was changed.

The documentation for this class was generated from the following file:

/home/runner/work/volume-control/volume-control/VolumeControl.CoreAudio/AudioDevice.cs

Public Member Functions

Properties

Events