Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

OpenTok.IAudioDevice

Defines an Audio device to be used by all publishers and subscribers. More...

Inherited by OpenTok.MMAudioDevice.

Public Member Functions

void InitAudio (AudioDevice.AudioBus audioBus)
 Called when the AudioDevice is initialized. Use the AudioBus object to read write audio data. Call the AudioBus.ReadRenderData(IntPtr buffer, int numberOfSamples) and AudioBus.WriteCaptureData(IntPtr buffer, int numberOfSamples) methods to read render data from subscribers and write capture data to publishers. More...
void DestroyAudio ()
 Called when the IAudioDevice instance is destroyed. More...
void InitAudioCapturer ()
 Called when the audio capturer for the IAudioDevice instance is initialized. More...
void DestroyAudioCapturer ()
 Called when th audio capturer for the IAudioDevice instance is destroyed. More...
void StartAudioCapturer ()
 Called when the audio capturer starts. You should begin providing audio samples to the AudioBus.WriteCaptureData(IntPtr buffer, int numberOfSamples) method. More...
void StopAudioCapturer ()
 Called when the audio capturer stops. More...
bool IsAudioCapturerInitialized ()
 Checks if the audio capturer for the IAudioDevice instance is initialized. More...
bool IsAudioCapturerStarted ()
 Checks if the audio capturer for the IAudioDevice instance is started. More...
int GetEstimatedAudioCaptureDelay ()
 Gets the estimated audio capture delay. More...
AudioDeviceSettings GetAudioCapturerSettings ()
 Called when the IAudioDevice instance requires settings. In your implementation of this method, return an AudioDeviceSettings object. More...
void InitAudioRenderer ()
 Called when the audio renderer for the IAudioDevice instance is initialized. More...
void DestroyAudioRenderer ()
 Called when th audio renderer for the IAudioDevice instance is destroyed. More...
void StartAudioRenderer ()
 Called when the audio renderer starts. You should begin receiving audio samples from the AudioBus.ReadRenderData(IntPtr buffer, int numberOfSamples) method. More...
void StopAudioRenderer ()
 Called when the audio renderer stops. More...
bool IsAudioRendererInitialized ()
 Checks if the audio renderer for the IAudioDevice instance is initialized. More...
bool IsAudioRendererStarted ()
 Checks if the audio renderer for the IAudioDevice instance is started. More...
int GetEstimatedAudioRenderDelay ()
 Gets the estimated audio render delay. More...
AudioDeviceSettings GetAudioRendererSettings ()
 Gets settings for the audio renderer for the IAudioDevice instance. More...

Detailed Description

Defines an Audio device to be used by all publishers and subscribers.

Member Function Documentation

◆ DestroyAudio()

void OpenTok.IAudioDevice.DestroyAudio ( )

Called when the IAudioDevice instance is destroyed.

Implemented in OpenTok.MMAudioDevice.

◆ DestroyAudioCapturer()

void OpenTok.IAudioDevice.DestroyAudioCapturer ( )

Called when th audio capturer for the IAudioDevice instance is destroyed.

Implemented in OpenTok.MMAudioDevice.

◆ DestroyAudioRenderer()

void OpenTok.IAudioDevice.DestroyAudioRenderer ( )

Called when th audio renderer for the IAudioDevice instance is destroyed.

Implemented in OpenTok.MMAudioDevice.

◆ GetAudioCapturerSettings()

AudioDeviceSettings OpenTok.IAudioDevice.GetAudioCapturerSettings ( )

Called when the IAudioDevice instance requires settings. In your implementation of this method, return an AudioDeviceSettings object.

Implemented in OpenTok.MMAudioDevice.

◆ GetAudioRendererSettings()

AudioDeviceSettings OpenTok.IAudioDevice.GetAudioRendererSettings ( )

Gets settings for the audio renderer for the IAudioDevice instance.

Implemented in OpenTok.MMAudioDevice.

◆ GetEstimatedAudioCaptureDelay()

int OpenTok.IAudioDevice.GetEstimatedAudioCaptureDelay ( )

Gets the estimated audio capture delay.

Implemented in OpenTok.MMAudioDevice.

◆ GetEstimatedAudioRenderDelay()

int OpenTok.IAudioDevice.GetEstimatedAudioRenderDelay ( )

Gets the estimated audio render delay.

Implemented in OpenTok.MMAudioDevice.

◆ InitAudio()

void OpenTok.IAudioDevice.InitAudio ( AudioDevice.AudioBus  audioBus)

Called when the AudioDevice is initialized. Use the AudioBus object to read write audio data. Call the AudioBus.ReadRenderData(IntPtr buffer, int numberOfSamples) and AudioBus.WriteCaptureData(IntPtr buffer, int numberOfSamples) methods to read render data from subscribers and write capture data to publishers.

Parameters
audioBusThe instance of the AudioBus to use for all publishers and subscribers.

Implemented in OpenTok.MMAudioDevice.

◆ InitAudioCapturer()

void OpenTok.IAudioDevice.InitAudioCapturer ( )

Called when the audio capturer for the IAudioDevice instance is initialized.

Implemented in OpenTok.MMAudioDevice.

◆ InitAudioRenderer()

void OpenTok.IAudioDevice.InitAudioRenderer ( )

Called when the audio renderer for the IAudioDevice instance is initialized.

Implemented in OpenTok.MMAudioDevice.

◆ IsAudioCapturerInitialized()

bool OpenTok.IAudioDevice.IsAudioCapturerInitialized ( )

Checks if the audio capturer for the IAudioDevice instance is initialized.

Implemented in OpenTok.MMAudioDevice.

◆ IsAudioCapturerStarted()

bool OpenTok.IAudioDevice.IsAudioCapturerStarted ( )

Checks if the audio capturer for the IAudioDevice instance is started.

Implemented in OpenTok.MMAudioDevice.

◆ IsAudioRendererInitialized()

bool OpenTok.IAudioDevice.IsAudioRendererInitialized ( )

Checks if the audio renderer for the IAudioDevice instance is initialized.

Implemented in OpenTok.MMAudioDevice.

◆ IsAudioRendererStarted()

bool OpenTok.IAudioDevice.IsAudioRendererStarted ( )

Checks if the audio renderer for the IAudioDevice instance is started.

Implemented in OpenTok.MMAudioDevice.

◆ StartAudioCapturer()

void OpenTok.IAudioDevice.StartAudioCapturer ( )

Called when the audio capturer starts. You should begin providing audio samples to the AudioBus.WriteCaptureData(IntPtr buffer, int numberOfSamples) method.

Implemented in OpenTok.MMAudioDevice.

◆ StartAudioRenderer()

void OpenTok.IAudioDevice.StartAudioRenderer ( )

Called when the audio renderer starts. You should begin receiving audio samples from the AudioBus.ReadRenderData(IntPtr buffer, int numberOfSamples) method.

Implemented in OpenTok.MMAudioDevice.

◆ StopAudioCapturer()

void OpenTok.IAudioDevice.StopAudioCapturer ( )

Called when the audio capturer stops.

Implemented in OpenTok.MMAudioDevice.

◆ StopAudioRenderer()

void OpenTok.IAudioDevice.StopAudioRenderer ( )

Called when the audio renderer stops.

Implemented in OpenTok.MMAudioDevice.