Package com.twilio.voice

Class DefaultAudioDevice

java.lang.Object

com.twilio.voice.DefaultAudioDevice

All Implemented Interfaces:

AudioDevice, AudioDeviceCapturer, AudioDeviceRenderer

public class DefaultAudioDevice
extends java.lang.Object
implements AudioDevice

DefaultAudioDevice is the default audio device module SDK uses when a custom one is not provided. By default, the Voice SDK uses `DefaultAudioDevice` to capture and render audio. The SDK performs acoustic echo cancellation (AEC) and noise suppression (NS) using device hardware by default. Using device hardware is more efficient, but some devices do not implement these audio effects well. `DefaultAudioDevice` provides API `setUseHardwareAcousticEchoCanceler(...)` or `setUseHardwareNoiseSuppressor(...)` to toggle the default behavior. If you are experiencing echo or background noise on certain devices reference the following snippet for enabling software implementations of AEC and NS anytime before invoking `Voice.connect(...)` or `CallInvite.accept(...)`.

 // Use software AEC
 DefaultAudioDevice defaultAudioDevice=new DefaultAudioDevice();
 defaultAudioDevice.setUseHardwareAcousticEchoCanceler(false);
 Voice.setAudioDevice(defaultAudioDevice);

 // Use software NS
 DefaultAudioDevice defaultAudioDevice=new DefaultAudioDevice();
 defaultAudioDevice.setUseHardwareNoiseSuppressor(false);
 Voice.setAudioDevice(defaultAudioDevice);

 

Constructor Summary

Constructors

Constructor	Description
DefaultAudioDevice()

Method Summary

Modifier and Type	Method	Description
AudioFormat	getCapturerFormat()	This method is a no-op that returns null.
AudioFormat	getRendererFormat()	This method is a no-op that returns null.
boolean	onInitCapturer()	This method is a no-op that returns false.
boolean	onInitRenderer()	This method is a no-op that returns false.
boolean	onStartCapturing(AudioDeviceContext audioDeviceContext)	This method is a no-op that returns false.
boolean	onStartRendering(AudioDeviceContext audioDeviceContext)	This method is a no-op that returns false.
boolean	onStopCapturing()	This method is a no-op that returns false.
boolean	onStopRendering()	This method is a no-op that returns false.
void	setUseHardwareAcousticEchoCanceler(boolean useHardwareAcousticEchoCanceler)	Control if the built-in hardware AEC should be used or not.
void	setUseHardwareNoiseSuppressor(boolean useHardwareNoiseSuppressor)	Control if the built-in hardware noise suppressor should be used or not.
boolean	useHardwareAcousticEchoCanceler()	Indicates if the built-in hardware AEC is used or not.
boolean	useHardwareNoiseSuppressor()	Indicates if the built-in hardware noise suppressor is used or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultAudioDevice

public DefaultAudioDevice()

Method Detail

setUseHardwareAcousticEchoCanceler

public void setUseHardwareAcousticEchoCanceler(boolean useHardwareAcousticEchoCanceler)

Control if the built-in hardware AEC should be used or not. The default value is true.

Parameters:

useHardwareAcousticEchoCanceler - true if audio device should use hardware AEC, false otherwise

setUseHardwareNoiseSuppressor

public void setUseHardwareNoiseSuppressor(boolean useHardwareNoiseSuppressor)

Control if the built-in hardware noise suppressor should be used or not. The default value is true.

Parameters:

useHardwareNoiseSuppressor - true if audio device should use hardware noise suppressor, false otherwise.

useHardwareAcousticEchoCanceler

public boolean useHardwareAcousticEchoCanceler()

Indicates if the built-in hardware AEC is used or not. The default value is true.

Returns:

true if the built-in hardware AEC is used.

useHardwareNoiseSuppressor

public boolean useHardwareNoiseSuppressor()

Indicates if the built-in hardware noise suppressor is used or not. The default value is true.

Returns:

true if the built-in hardware noise suppressor is used.

getCapturerFormat

@Nullable
public AudioFormat getCapturerFormat()

This method is a no-op that returns null.

Specified by:

getCapturerFormat in interface AudioDeviceCapturer

Returns:

AudioFormat

onInitCapturer

public boolean onInitCapturer()

This method is a no-op that returns false.

Specified by:

onInitCapturer in interface AudioDeviceCapturer

Returns:

A boolean value to indicate if initialization was successful.

onStartCapturing

public boolean onStartCapturing(@NonNull
                                AudioDeviceContext audioDeviceContext)

This method is a no-op that returns false.

Specified by:

onStartCapturing in interface AudioDeviceCapturer

Returns:

A boolean value that indicates if capturing has started or not.

onStopCapturing

public boolean onStopCapturing()

This method is a no-op that returns false.

Specified by:

onStopCapturing in interface AudioDeviceCapturer

Returns:

A boolean value that indicates if capturing has stopped or not.

getRendererFormat

@Nullable
public AudioFormat getRendererFormat()

This method is a no-op that returns null.

Specified by:

getRendererFormat in interface AudioDeviceRenderer

Returns:

AudioFormat

onInitRenderer

public boolean onInitRenderer()

This method is a no-op that returns false.

Specified by:

onInitRenderer in interface AudioDeviceRenderer

Returns:

A boolean value to indicate if initialization was successful.

onStartRendering

public boolean onStartRendering(@NonNull
                                AudioDeviceContext audioDeviceContext)

This method is a no-op that returns false.

Specified by:

onStartRendering in interface AudioDeviceRenderer

Returns:

A boolean value that indicates if rendering has started or not.

onStopRendering

public boolean onStopRendering()

This method is a no-op that returns false.

Specified by:

onStopRendering in interface AudioDeviceRenderer

Returns:

A boolean value that indicates if rendering has stopped or not.