OpenTok.AudioDevice

public class AudioDevice

A class that includes methods for setting the audio device to be used by publishers and subscribers.

Nested types: OpenTok.AudioDevice.InputAudioDevice, OpenTok.AudioDevice.OutputAudioDevice, OpenTok.AudioDevice.Notifications, OpenTok.AudioDevice.AudioBus

Methods

Name Description
(static) EnumerateInputAudioDevices() → {IList<InputAudioDevice>}
(static) EnumerateOutputAudioDevices() → {IList<OutputAudioDevice>}
(static) GetDefaultInputAudioDevice() → {InputAudioDevice}
(static) GetDefaultOutputAudioDevice() → {OutputAudioDevice}
(static) RestartInputAudioDevice() StopAudioCapturer; InitAudioCapturer (only if IsAudioCapturerInitialized returns false); StartAudioCapturer (only if IsAudioCapturerStarted returns false);
(static) RestartOutputAudioDevice() StopAudioRenderer; InitAudioRenderer (only if IsAudioRendererInitialized returns false); StartAudioRenderer (only if IsAudioRendererStarted returns false);
(static) SetCustomAudioDevice(context, audioDevice) Sets an instance of the IAudioDevice interface as the virtual audio device for a custom audio driver used by all publishers and subscribers.
(static) SetCustomAudioDevice(audioDevice) Sets an instance of the IAudioDevice interface as the virtual audio device for a custom audio driver used by all publishers and subscribers.
(static) SetInputAudioDevice(device)
(static) SetOutputAudioDevice(device)

(static) EnumerateInputAudioDevices() → {IList<InputAudioDevice>}

Returns:

A list of InputAudioDevice objects, representing available audio input devices on the system.

(static) EnumerateOutputAudioDevices() → {IList<OutputAudioDevice>}

Returns:

A list of OutputAudioDevice objects, representing available audio output devices on the system.

(static) GetDefaultInputAudioDevice() → {InputAudioDevice}

Returns:

The system default audio input device.

(static) GetDefaultOutputAudioDevice() → {OutputAudioDevice}

Returns:

The system default audio output device.

(static) RestartInputAudioDevice()

  • StopAudioCapturer
  • InitAudioCapturer (only if IsAudioCapturerInitialized returns false)
  • StartAudioCapturer (only if IsAudioCapturerStarted returns false)

(static) RestartOutputAudioDevice()

  • StopAudioRenderer
  • InitAudioRenderer (only if IsAudioRendererInitialized returns false)
  • StartAudioRenderer (only if IsAudioRendererStarted returns false)

(static) SetCustomAudioDevice(context, audioDevice)

Sets an instance of the IAudioDevice interface as the virtual audio device for a custom audio driver used by all publishers and subscribers.

Parameters:
Name Type Description
context Context
audioDevice IAudioDevice

(static) SetCustomAudioDevice(audioDevice)

Sets an instance of the IAudioDevice interface as the virtual audio device for a custom audio driver used by all publishers and subscribers.

Parameters:
Name Type Description
audioDevice IAudioDevice

(static) SetInputAudioDevice(device)

Parameters:
Name Type Description
device InputAudioDevice The selected device to configure as default audio input

(static) SetOutputAudioDevice(device)

Parameters:
Name Type Description
device OutputAudioDevice The selected device to configure as default audio output