AudioDevice

Represents an audio device.


This object is used to describe an audio device available in the system. Each device, both for audio capturing and playback, is represented by a separate object. The object is returned by the related methods of the SFSAudioManager class.

Members

(readonly) id :string

Identifier of the audio device.
Type:
  • string

(readonly) isDefault :boolean

Indicates whether this is the default audio device, for either audio capturing or playback, in case no device is specifically selected.
Type:
  • boolean

(readonly) isSelected :boolean

Indicates whether this audio device is currently selected for either audio capturing or playback.
Type:
  • boolean

(readonly) name :string

Name of the audio device.
Type:
  • string

Methods

toString() → {string}

Returns a string showing the name of the audio device and its selected and default flags.
Returns:
The string representation of the AudioDevice object.
Type: 
string