Represents a mixer control. More...

Inheritance diagram for NAudio.Mixer.MixerControl:

Collaboration diagram for NAudio.Mixer.MixerControl:

Public Member Functions
override string	ToString ()
	Returns a string representation of the object, including the Name and ControlType properties.

Static Public Member Functions
static IList< MixerControl >	GetMixerControls (IntPtr mixerHandle, MixerLine mixerLine, MixerFlags mixerHandleType)
	Retrieves the mixer controls associated with the specified mixer line.

static MixerControl	GetMixerControl (IntPtr mixerHandle, int nLineId, int controlId, int nChannels, MixerFlags mixerFlags)
	Retrieves the specified mixer control.

Protected Member Functions
void	GetControlDetails ()
	Retrieves details of the mixer control.

void	GetDetails (IntPtr pDetails)
	Retrieves the details using the provided pointer to details.

Protected Attributes
IntPtr	mixerHandle
	Mixer Handle.

int	nChannels
	Number of Channels.

MixerFlags	mixerHandleType
	Mixer Handle Type.

Properties
String	Name `[get]`
	Mixer control name.

MixerControlType	ControlType `[get]`
	Mixer control type.

bool	IsBoolean `[get]`
	Is this a boolean control.

bool	IsListText `[get]`
	True if this is a list text control.

bool	IsSigned `[get]`
	True if this is a signed control.

bool	IsUnsigned `[get]`
	True if this is an unsigned control.

bool	IsCustom `[get]`
	True if this is a custom control.

Static Private Member Functions
static bool	IsControlBoolean (MixerControlType controlType)
	Checks if the given MixerControlType is a boolean control type.

static bool	IsControlListText (MixerControlType controlType)
	Checks if the given MixerControlType is a type of control list text.

static bool	IsControlSigned (MixerControlType controlType)
	Checks if the given MixerControlType is signed.

static bool	IsControlUnsigned (MixerControlType controlType)
	Determines if the given MixerControlType is of an unsigned type.

static bool	IsControlCustom (MixerControlType controlType)
	Checks if the given MixerControlType is custom.

Detailed Description

Represents a mixer control.

Member Function Documentation

◆ GetControlDetails()

void NAudio.Mixer.MixerControl.GetControlDetails ( )

inlineprotected

Retrieves details of the mixer control.

This method retrieves the details of the specified mixer control and populates the mixerControlDetails structure with the retrieved information. The method first sets the size of the mixerControlDetails structure and assigns the control ID from the mixerControl . It then determines the number of channels for the control based on whether it is custom, uniform, or has a specific number of channels. If the control is a multiple item control, it sets the owner window handle to the value of mixerControl.cMultipleItems . It then determines the size of the details based on the type of control (boolean, list text, signed, unsigned, or custom) and the number of channels. After allocating memory for the details, it retrieves the control details using MixerInterop.mixerGetControlDetails and populates the details in the allocated buffer. If successful, it calls the GetDetails method to process the retrieved details and then frees the allocated memory. If an error occurs during the retrieval process, it throws a MmException with the error message "mixerGetControlDetails".

Exceptions

MmException Thrown when an error occurs during the retrieval of mixer control details.

Here is the call graph for this function:

◆ GetDetails()

void NAudio.Mixer.MixerControl.GetDetails ( IntPtr pDetails )

abstractprotected

Retrieves the details using the provided pointer to details.

Parameters

pDetails A pointer to the details.

This method retrieves the details using the provided pointer to details and is intended to be implemented in derived classes.

Here is the caller graph for this function:

◆ GetMixerControl()

static MixerControl NAudio.Mixer.MixerControl.GetMixerControl	(	IntPtr	mixerHandle,
		int	nLineId,
		int	controlId,
		int	nChannels,
		MixerFlags	mixerFlags )

inlinestatic

Retrieves the specified mixer control.

Parameters

mixerHandle	The handle to the mixer device.
nLineId	The line identifier.
controlId	The control identifier.
nChannels	The number of channels.
mixerFlags	The mixer flags.

Returns: The retrieved mixer control based on the specified parameters.

Exceptions

MmException Thrown when an error occurs during the retrieval of the mixer control.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMixerControls()

static IList< MixerControl > NAudio.Mixer.MixerControl.GetMixerControls	(	IntPtr	mixerHandle,
		MixerLine	mixerLine,
		MixerFlags	mixerHandleType )

inlinestatic

Retrieves the mixer controls associated with the specified mixer line.

Parameters

mixerHandle	The handle to the mixer device.
mixerLine	The mixer line for which controls are to be retrieved.
mixerHandleType	The type of handle to be retrieved.

Returns: A list of mixer controls associated with the specified mixer line.

Exceptions

MmException Thrown when an error occurs while retrieving the mixer controls.

Here is the call graph for this function:

◆ IsControlBoolean()

static bool NAudio.Mixer.MixerControl.IsControlBoolean ( MixerControlType controlType )

inlinestaticprivate

Checks if the given MixerControlType is a boolean control type.

Parameters

controlType The MixerControlType to be checked.

Returns: True if the controlType is a boolean control type; otherwise, false.

Here is the caller graph for this function:

◆ IsControlCustom()

static bool NAudio.Mixer.MixerControl.IsControlCustom ( MixerControlType controlType )

inlinestaticprivate

Checks if the given MixerControlType is custom.

Parameters

controlType The MixerControlType to be checked.

Returns: True if the controlType is custom; otherwise, false.

Here is the caller graph for this function:

◆ IsControlListText()

static bool NAudio.Mixer.MixerControl.IsControlListText ( MixerControlType controlType )

inlinestaticprivate

Checks if the given MixerControlType is a type of control list text.

Parameters

controlType The MixerControlType to be checked.

Returns: True if the control type is Equalizer, Mixer, MultipleSelect, Mux, or SingleSelect; otherwise, false.

Here is the caller graph for this function:

◆ IsControlSigned()

static bool NAudio.Mixer.MixerControl.IsControlSigned ( MixerControlType controlType )

inlinestaticprivate

Checks if the given MixerControlType is signed.

Parameters

controlType The type of mixer control to be checked.

Returns: True if the controlType is a signed control; otherwise, false.

This method checks if the specified controlType is one of the signed mixer control types, such as PeakMeter, SignedMeter, Signed, Decibels, Pan, QSoundPan, or Slider. If the controlType matches any of the signed types, it returns true; otherwise, it returns false.

Here is the caller graph for this function:

◆ IsControlUnsigned()

static bool NAudio.Mixer.MixerControl.IsControlUnsigned ( MixerControlType controlType )

inlinestaticprivate

Determines if the given MixerControlType is of an unsigned type.

Parameters

controlType The MixerControlType to be checked.

Returns: True if the controlType is of an unsigned type; otherwise, false.

Here is the caller graph for this function:

◆ ToString()

override string NAudio.Mixer.MixerControl.ToString ( )

Returns a string representation of the object, including the Name and ControlType properties.

Returns: A string containing the Name and ControlType properties of the object.

Member Data Documentation

◆ mixerHandle

IntPtr NAudio.Mixer.MixerControl.mixerHandle

protected

Mixer Handle.

◆ mixerHandleType

MixerFlags NAudio.Mixer.MixerControl.mixerHandleType

protected

Mixer Handle Type.

◆ nChannels

int NAudio.Mixer.MixerControl.nChannels

protected

Number of Channels.

Property Documentation

◆ ControlType

MixerControlType NAudio.Mixer.MixerControl.ControlType

get

Mixer control type.

◆ IsBoolean

bool NAudio.Mixer.MixerControl.IsBoolean

get

Is this a boolean control.

◆ IsCustom

bool NAudio.Mixer.MixerControl.IsCustom

get

True if this is a custom control.

◆ IsListText

bool NAudio.Mixer.MixerControl.IsListText

get

True if this is a list text control.

◆ IsSigned

bool NAudio.Mixer.MixerControl.IsSigned

get

True if this is a signed control.

◆ IsUnsigned

bool NAudio.Mixer.MixerControl.IsUnsigned

get

True if this is an unsigned control.

◆ Name

String NAudio.Mixer.MixerControl.Name

get

Mixer control name.

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

/Users/sumansaurabh/Documents/my-startup/xeno-rat/Plugins/LiveMicrophone/lib/NAudio.WinMM/Mixer/MixerControl.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ GetControlDetails()

◆ GetDetails()

◆ GetMixerControl()

◆ GetMixerControls()

◆ IsControlBoolean()

◆ IsControlCustom()

◆ IsControlListText()

◆ IsControlSigned()

◆ IsControlUnsigned()

◆ ToString()

Member Data Documentation

◆ mixerHandle

◆ mixerHandleType

◆ nChannels

Property Documentation

◆ ControlType

◆ IsBoolean

◆ IsCustom

◆ IsListText

◆ IsSigned

◆ IsUnsigned

◆ Name