TestimoX

API Reference

Class

WindowsAudioStatus

Namespace ComputerX.Audio
Assembly ComputerX
Implements
ILocalStatusSnapshot IEquatable<WindowsAudioStatus>
Modifiers sealed

Snapshot of the default Windows audio render endpoint state.

Inheritance

  • Object
  • WindowsAudioStatus

Constructors

public WindowsAudioStatus(Boolean IsAvailable, Nullable<Int32> OutputVolume, Nullable<Boolean> IsMuted, String Message) #

Snapshot of the default Windows audio render endpoint state.

Parameters

IsAvailable System.Boolean requiredposition: 0
True when the default audio endpoint could be queried.
OutputVolume System.Nullable{System.Int32} requiredposition: 1
Current output volume percentage when available.
IsMuted System.Nullable{System.Boolean} requiredposition: 2
Current mute state when available.
Message System.String requiredposition: 3
Optional status detail or failure message.

Methods

public WindowsAudioStatus <Clone>$() #
Returns: WindowsAudioStatus
public Void Deconstruct(out Boolean IsAvailable, out Nullable<Int32> OutputVolume, out Nullable<Boolean> IsMuted, out String Message) #
Returns: Void

Parameters

IsAvailable Boolean requiredposition: 0
OutputVolume Nullable<Int32> requiredposition: 1
IsMuted Nullable<Boolean> requiredposition: 2
Message String requiredposition: 3
public virtual Boolean Equals(WindowsAudioStatus other) #
Returns: Boolean

Parameters

obj Object requiredposition: 0
public override Int32 GetHashCode() #
Returns: Int32
public override String ToString() #
Returns: String

Properties

public virtual Boolean IsAvailable { get; set; } #

True when the default audio endpoint could be queried.

public Nullable<Int32> OutputVolume { get; set; } #

Current output volume percentage when available.

public Nullable<Boolean> IsMuted { get; set; } #

Current mute state when available.

public virtual String Message { get; set; } #

Optional status detail or failure message.