AudioEndpointControl

java.lang.Object
- com.zoiper.zdk.Controllers.AudioEndpointControl

```
public class AudioEndpointControl
extends java.lang.Object
```
Audio endpoint's main entry point Entry point for controlling the audio endpoint

Constructor Summary

Constructors
Constructor and Description

AudioEndpointControl(long handle)
Constructor storing the pointer/address to the underlying native object

Constructors
Constructor and Description
`AudioEndpointControl(long handle)` Constructor storing the pointer/address to the underlying native object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Sound`	`addSoundFromFile(java.lang.String filePath, AudioFileFormat fileFormat, boolean repeat, int pauseMs)` Load a sound from a file Loads a sound from a file.
`Sound`	`addSoundFromMemory(byte[] data, int length, int sampleLen, int frequency, boolean repeat, int pauseMs)` Load a sound from a memory buffer Creates a sound structure and copies the provided samples into its buffers.
`void`	`addStatusListener(AudioEventsHandler value)` Adds audio events listener
`java.util.List<AudioDevice>`	`audioDevices()` Gets a list with all available audio devices
`AudioRoutingEndpoint`	`audioEndpoint()` Gets the configured audio routing endpoint to be used !!!NOT MPLEMENTED!!! The ZDK does not provide a mean for controlling the audio routing!
`void`	`audioEndpoint(AudioRoutingEndpoint value)` Configures the audio routing endpoint to be used !!!NOT MPLEMENTED!!! The ZDK does not provide a mean for controlling the audio routing!
`AudioSourcePresetType`	`audioSourcePreset()` Gets the configured Audio Source Recorder Preset Currently used only for Android's OpenSLES, but this can change in the future.
`void`	`audioSourcePreset(AudioSourcePresetType value)` Configures the Audio Source Recorder Preset Currently used only for Android's OpenSLES, but this can change in the future.
`void`	`dropStatusListener(AudioEventsHandler value)` Drops audio events listener
`EchoCancellationType`	`echoCancellation()` Gets the configured acoustic echo cancellation working mode Default is enabled in software mode.
`void`	`echoCancellation(EchoCancellationType value)` Configures the acoustic echo cancellation working mode Default is enabled in software mode.
`boolean`	`enableFixedSpeakerGain()` Enables or disables the fixed gain on the audio output Enable or disable the fixed speaker gain confgured by setfixedSpeakerGain.
`void`	`enableFixedSpeakerGain(boolean value)` Enables or disables the fixed gain on the audio output Enable or disable the fixed speaker gain confgured by setfixedSpeakerGain.
`protected void`	`finalize()` Ensures the underlying native object destruction
`double`	`fixedSpeakerGain()` Configures the fixed gain on the audio output Configures the gain to be applied when the gain filter is enabled by enableFixedSpeakerGain.
`void`	`fixedSpeakerGain(double value)` Configures the fixed gain on the audio output Configures the gain to be applied when the gain filter is enabled by enableFixedSpeakerGain.
`float`	`getAutomaticGainControlGain()` Gets the configured Automatic Gain Control (AGC) fixed gain The additional fixed gain (defaults to 0.f) added when using SoftwareDigitalV2 or SoftwareHybrid mode.
`AutomaticGainControlType`	`getAutomaticGainControlMode()` Gets the configured Automatic Gain Control (AGC) filter working mode Works on all platforms.
`AudioDevice`	`getCurrentInputDevice()` Gets the selected input audio device
`AudioDevice`	`getCurrentOutputDevice()` Gets the selected output audio device
`AudioDevice`	`getCurrentRingDevice()` Gets the selected ringing audio device
`AudioDevice`	`getDeviceByName(java.lang.String name)` Gets an audio device with the given name if exists, otherwise - nullptr
`long`	`handle()` Gets the pointer/address to the underlying native object
`boolean`	`highPassFilter()` Controls the High Pass filter Enables or disables the High Pass filter.
`void`	`highPassFilter(boolean value)` Controls the High Pass filter Enables or disables the High Pass filter.
`Result`	`hostApi(HostAPI value)` Configures the audio host API to be used
`boolean`	`micBoost()` Controls the microphone boost option Enables or disables the microphone boost.
`void`	`micBoost(boolean value)` Controls the microphone boost option Enables or disables the microphone boost.
`double`	`micLevel()` Gets the configured audio input/microphone level The volume setting for the input device.
`void`	`micLevel(double value)` Configures the audio input/microphone level The volume setting for the input device.
`Result`	`muteInput(boolean value)` Mute or unmute the input device/microphone
`Result`	`muteOutput(boolean value)` Mute or unmute the output device/speaker
`boolean`	`noiseSuppression()` Controls the Noise Suppression filter Enables or disables the Noise Suppression filter.
`void`	`noiseSuppression(boolean value)` Controls the Noise Suppression filter Enables or disables the Noise Suppression filter.
`double`	`outputLevel()` Gets the configured audio output level The volume setting for the input device.
`void`	`outputLevel(double value)` Configures the audio output level The volume setting for the input device.
`float`	`preAmplifier()` Controls the Pre Amplifier Enables or disables the Pre Amplifier which amplifies the input signal before any other porcessing occurs.
`void`	`preAmplifier(float value)` Controls the Pre Amplifier Enables or disables the Pre Amplifier which amplifies the input signal before any other porcessing occurs.
`Result`	`resampler(AudioResampler value)` Configures the audio resampler to be used Selects the resampler to be used by the audio engine.
`double`	`ringLevel()` Gets the configured audio ringing level The volume setting for the ringing device.
`void`	`ringLevel(double value)` Configures the audio ringing level The volume setting for the ringing device.
`Result`	`setAutomaticGainControlMode(AutomaticGainControlType type, float gain)` Configures the Automatic Gain Control (AGC) filter working mode Works on all platforms.
`Result`	`setCallRecordingNotifySound(Sound sound, AudioOutputDeviceType monitorDevice)` Sets the sound to be played over the current call on every recording start Sets the sound to be played back to the remote peer(s) (instead of the microphone input) on every start of call recording.
`Result`	`setCurrentInputDevice(AudioDevice device)` Select the input audio device
`Result`	`setCurrentOutputDevice(AudioDevice device)` Select the output audio device
`Result`	`setCurrentRingDevice(AudioDevice device)` Select the ringing audio device
`Result`	`startPlayback(Sound sound, AudioOutputDeviceType monitorDevice)` Starts playback over the current call Starts playing back the sound to the remote peer(s) (if there are active calls) instead of the microphone input.
`Result`	`startSound(Sound sound, AudioOutputDeviceType outputType)` Start playback of a sound Start playing the sound on one of the two output devices (either the selected output device or the selected ringing device).
`Result`	`stopPlayback()` Stops any playback Stops any playback and monitored sound immediately if there is such.
`Result`	`stopSound(Sound sound, AudioOutputDeviceType outputType)` Stops playback of a sound Stops playing the sound.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AudioEndpointControl
```
public AudioEndpointControl(long handle)
```
    Constructor storing the pointer/address to the underlying native object
    
    Parameters:
    
    handle - Pointer/address to the underlying native object
- Method Detail
  - handle
```
public long handle()
```
    Gets the pointer/address to the underlying native object
    
    Returns:
    
    Pointer/address to the underlying native object
  - finalize
```
protected void finalize()
```
    Ensures the underlying native object destruction
    
    Overrides:
    
    finalize in class java.lang.Object
  - audioEndpoint
```
public AudioRoutingEndpoint audioEndpoint()
```
    Gets the configured audio routing endpoint to be used !!!NOT MPLEMENTED!!! The ZDK does not provide a mean for controlling the audio routing!
    
    Returns:
    
    The audio routing endpoint
    
    See Also:
    
    AudioRoutingEndpoint
  - audioEndpoint
```
public void audioEndpoint(AudioRoutingEndpoint value)
```
    Configures the audio routing endpoint to be used !!!NOT MPLEMENTED!!! The ZDK does not provide a mean for controlling the audio routing!
    
    Parameters:
    
    value - The audio routing endpoint
    
    See Also:
    
    AudioRoutingEndpoint
  - micLevel
```
public double micLevel()
```
    Gets the configured audio input/microphone level The volume setting for the input device. Values are between 0.0 (muted) and 1.0 (maximum volume).
    
    Returns:
    
    The volume setting for the input device between 0.0 and 1.0
    
    See Also:
    
    ringLevel
  - micLevel
```
public void micLevel(double value)
```
    Configures the audio input/microphone level The volume setting for the input device. Values are between 0.0 (muted) and 1.0 (maximum volume).
    
    Parameters:
    
    value - The volume setting for the input device between 0.0 and 1.0
    
    See Also:
    
    ringLevel
  - outputLevel
```
public double outputLevel()
```
    Gets the configured audio output level The volume setting for the input device. Values are between 0.0 (muted) and 1.0 (maximum volume). In many cases the ringing device and the output device are the same, so chaning one level will also change and the other.
    
    Returns:
    
    The volume setting for the output device between 0.0 and 1.0
    
    See Also:
    
    ringLevel
  - outputLevel
```
public void outputLevel(double value)
```
    Configures the audio output level The volume setting for the input device. Values are between 0.0 (muted) and 1.0 (maximum volume). In many cases the ringing device and the output device are the same, so chaning one level will also change and the other.
    
    Parameters:
    
    value - The volume setting for the output device between 0.0 and 1.0
    
    See Also:
    
    ringLevel
  - ringLevel
```
public double ringLevel()
```
    Gets the configured audio ringing level The volume setting for the ringing device. Values are between 0.0 (muted) and 1.0 (maximum volume). In many cases the ringing device and the output device are the same, so chaning one level will also change and the other.
    
    Returns:
    
    The volume setting for the ringing device between 0.0 and 1.0
    
    See Also:
    
    outputLevel
  - ringLevel
```
public void ringLevel(double value)
```
    Configures the audio ringing level The volume setting for the ringing device. Values are between 0.0 (muted) and 1.0 (maximum volume). In many cases the ringing device and the output device are the same, so chaning one level will also change and the other.
    
    Parameters:
    
    value - The volume setting for the ringing device between 0.0 and 1.0
    
    See Also:
    
    outputLevel
  - echoCancellation
```
public EchoCancellationType echoCancellation()
```
    Gets the configured acoustic echo cancellation working mode Default is enabled in software mode.
    
    Returns:
    
    The acoustic echo cancellation mode
    
    See Also:
    
    EchoCancellationType
  - echoCancellation
```
public void echoCancellation(EchoCancellationType value)
```
    Configures the acoustic echo cancellation working mode Default is enabled in software mode.
    
    Parameters:
    
    value - The acoustic echo cancellation mode
    
    See Also:
    
    EchoCancellationType
  - highPassFilter
```
public boolean highPassFilter()
```
    Controls the High Pass filter Enables or disables the High Pass filter. Works on all platforms.
    Returns:
    0 - disable
    1 - enable
  - highPassFilter
```
public void highPassFilter(boolean value)
```
    Controls the High Pass filter Enables or disables the High Pass filter. Works on all platforms.
    Parameters:
    value -
    
    0 - disable
    1 - enable
  - preAmplifier
```
public float preAmplifier()
```
    Controls the Pre Amplifier Enables or disables the Pre Amplifier which amplifies the input signal before any other porcessing occurs. Works on all platforms. The amount of the fixed gain done by the pre amplifier. The gain value is a positive value between 1.f (does nothing) and 49.f db. This value is interpreted as a negative value. Disabled by default - less than 1.f!
    
    Returns:
    
    The amount of the fixed gain done by the pre amplifier.
  - preAmplifier
```
public void preAmplifier(float value)
```
    Controls the Pre Amplifier Enables or disables the Pre Amplifier which amplifies the input signal before any other porcessing occurs. Works on all platforms. The amount of the fixed gain done by the pre amplifier. The gain value is a positive value between 1.f (does nothing) and 49.f db. This value is interpreted as a negative value. Disabled by default - less than 1.f!
    
    Parameters:
    
    value - The amount of the fixed gain done by the pre amplifier.
  - noiseSuppression
```
public boolean noiseSuppression()
```
    Controls the Noise Suppression filter Enables or disables the Noise Suppression filter. Enabled by default. Works on all platforms.
    Returns:
    0 - disable
    1 - enable
  - noiseSuppression
```
public void noiseSuppression(boolean value)
```
    Controls the Noise Suppression filter Enables or disables the Noise Suppression filter. Enabled by default. Works on all platforms.
    Parameters:
    value -
    
    0 - disable
    1 - enable
  - audioSourcePreset
```
public AudioSourcePresetType audioSourcePreset()
```
    Gets the configured Audio Source Recorder Preset Currently used only for Android's OpenSLES, but this can change in the future.
    
    Returns:
    
    The audio source preset
    
    See Also:
    
    AudioSourcePresetType
  - audioSourcePreset
```
public void audioSourcePreset(AudioSourcePresetType value)
```
    Configures the Audio Source Recorder Preset Currently used only for Android's OpenSLES, but this can change in the future.
    
    Parameters:
    
    value - The audio source preset
    
    See Also:
    
    AudioSourcePresetType
  - audioDevices
```
public java.util.List<AudioDevice> audioDevices()
```
    Gets a list with all available audio devices
    
    Returns:
    
    List with all available audio devices
    
    See Also:
    
    AudioDevice
  - micBoost
```
public boolean micBoost()
```
    Controls the microphone boost option Enables or disables the microphone boost. On some platforms the boost option is controlled via a text field and this might not work properly.
    Returns:
    0 - disable
    1 - enable
  - micBoost
```
public void micBoost(boolean value)
```
    Controls the microphone boost option Enables or disables the microphone boost. On some platforms the boost option is controlled via a text field and this might not work properly.
    Parameters:
    value -
    
    0 - disable
    1 - enable
  - enableFixedSpeakerGain
```
public boolean enableFixedSpeakerGain()
```
    Enables or disables the fixed gain on the audio output Enable or disable the fixed speaker gain confgured by setfixedSpeakerGain. By default, the gain is not applied. The filter that applies the gain is using a fixed point calculation (multiplication + shift + saturation checks). It should be very fast but you should not enable the gain unless you have set it to something different than 0.0. The effect will be immediate. You can call this function at any time after initialization. This means you can enable/disable the gain during a call.
    Returns:
    0 - disable
    1 - enable
    See Also:
    
    fixedSpeakerGain
  - enableFixedSpeakerGain
```
public void enableFixedSpeakerGain(boolean value)
```
    Enables or disables the fixed gain on the audio output Enable or disable the fixed speaker gain confgured by setfixedSpeakerGain. By default, the gain is not applied. The filter that applies the gain is using a fixed point calculation (multiplication + shift + saturation checks). It should be very fast but you should not enable the gain unless you have set it to something different than 0.0. The effect will be immediate. You can call this function at any time after initialization. This means you can enable/disable the gain during a call.
    Parameters:
    value -
    
    0 - disable
    1 - enable
    See Also:
    
    fixedSpeakerGain
  - fixedSpeakerGain
```
public double fixedSpeakerGain()
```
    Configures the fixed gain on the audio output Configures the gain to be applied when the gain filter is enabled by enableFixedSpeakerGain. The gain is expressed in decibels (dB). It can be anything but some values will produce very distorted and loud noise, while others will effectively mute the audio. Here are some example values, but please do tests and choose what best suits your case. The precision of the fixed-point calculation is 0.001. +20.0 dB: Huge audio boost. Almost certain to produce loud noise unless the input is very quiet. Don't use values above this. +6.0 dB: Moderate boost +2.0 dB: Small boost 0.0 dB: No boost -6.0 dB: Moderate decrease in volume. Better use the hardware volume controls. -100 dB: Almost always will produce complete silence. If you are familiar with how the audio is processed, here is the filter formula: gain(s) = s * 10 ^ ( db / 20.0 ) Here gain is the gain filter, s is the sample being processed, db is the gain value in dB. We're using the amplitude forumla because of the way PCM is representing the audio. As with enableFixedSpeakerGain, you can call this function at any time after initialization.
    
    Returns:
    
    Gain in dB
    
    See Also:
    
    enableFixedSpeakerGain
  - fixedSpeakerGain
```
public void fixedSpeakerGain(double value)
```
    Configures the fixed gain on the audio output Configures the gain to be applied when the gain filter is enabled by enableFixedSpeakerGain. The gain is expressed in decibels (dB). It can be anything but some values will produce very distorted and loud noise, while others will effectively mute the audio. Here are some example values, but please do tests and choose what best suits your case. The precision of the fixed-point calculation is 0.001. +20.0 dB: Huge audio boost. Almost certain to produce loud noise unless the input is very quiet. Don't use values above this. +6.0 dB: Moderate boost +2.0 dB: Small boost 0.0 dB: No boost -6.0 dB: Moderate decrease in volume. Better use the hardware volume controls. -100 dB: Almost always will produce complete silence. If you are familiar with how the audio is processed, here is the filter formula: gain(s) = s * 10 ^ ( db / 20.0 ) Here gain is the gain filter, s is the sample being processed, db is the gain value in dB. We're using the amplitude forumla because of the way PCM is representing the audio. As with enableFixedSpeakerGain, you can call this function at any time after initialization.
    
    Parameters:
    
    value - Gain in dB
    
    See Also:
    
    enableFixedSpeakerGain
  - getAutomaticGainControlMode
```
public AutomaticGainControlType getAutomaticGainControlMode()
```
    Gets the configured Automatic Gain Control (AGC) filter working mode Works on all platforms. For Desktop platforms the AGC includes both analog and digital adaptive control by controlling the analog gain for the microphone device. For mobile platforms only an adaptive digital gain is applied to the audio coming from the microphone. The GUI is advised to bar the user from manipulating the hardware gain of the microphone. The GUI can also poll the audio input level via micLevel once or twice a second.
    
    Returns:
    
    The AGC mode
    
    See Also:
    
    setAutomaticGainControlMode AutomaticGainControlType
  - getAutomaticGainControlGain
```
public float getAutomaticGainControlGain()
```
    Gets the configured Automatic Gain Control (AGC) fixed gain The additional fixed gain (defaults to 0.f) added when using SoftwareDigitalV2 or SoftwareHybrid mode. It can have values between 0.f and 49.f db. The value is positive but it is interpreted as negative.
    
    Returns:
    
    The AGC additional fixed gain
    
    See Also:
    
    setAutomaticGainControlMode
  - setAutomaticGainControlMode
```
public Result setAutomaticGainControlMode(AutomaticGainControlType type,
                                          float gain)
```
    Configures the Automatic Gain Control (AGC) filter working mode Works on all platforms. For Desktop platforms the AGC includes both analog and digital adaptive control by controlling the analog gain for the microphone device. For mobile platforms only an adaptive digital gain is applied to the audio coming from the microphone. The GUI is advised to bar the user from manipulating the hardware gain of the microphone. The GUI can also poll the audio input level via micLevel once or twice a second.
    
    Parameters:
    
    type - The AGC mode
    
    gain - The additional fixed gain added when using SoftwareDigitalV2 or SoftwareHybrid mode. It can have values between 0.f and 49.f db. The value is positive but it is interpreted as negative.
    
    Returns:
    
    Result of the invocation
    
    See Also:
    
    getAutomaticGainControlGain Result AutomaticGainControlType
  - hostApi
```
public Result hostApi(HostAPI value)
```
    Configures the audio host API to be used
    
    Parameters:
    
    value - The host API
    
    Returns:
    
    Result of the invocation
    
    See Also:
    
    Result
  - resampler
```
public Result resampler(AudioResampler value)
```
    Configures the audio resampler to be used Selects the resampler to be used by the audio engine. In most cases the native sampling rate of the audio hardware will not match the sampling rate of the active VoIP call. In this case a resampler is employed to do sample rate conversion. Different methods produce different quality and use algorithms of different complexity resulting in different CPU usage. In some cases the resampler cannot be selected. The default behavior is the audio driver select the reampler.
    
    Parameters:
    
    value - The audio resampler type
    
    Returns:
    
    Result of the invocation
    
    See Also:
    
    Result
  - getDeviceByName
```
public AudioDevice getDeviceByName(java.lang.String name)
```
    Gets an audio device with the given name if exists, otherwise - nullptr
    
    Parameters:
    
    name - The name of the audio device to be retrieved
    
    Returns:
    
    The audio device with the specified name
    
    See Also:
    
    AudioDevice
  - getCurrentInputDevice
```
public AudioDevice getCurrentInputDevice()
```
    Gets the selected input audio device
    
    Returns:
    
    The currently selected input audio device
    
    See Also:
    
    AudioDevice
  - setCurrentInputDevice
```
public Result setCurrentInputDevice(AudioDevice device)
```
    Select the input audio device
    
    Parameters:
    
    device - The input device to be selected
    
    Returns:
    
    Result of the selection
    
    See Also:
    
    Result
  - getCurrentOutputDevice
```
public AudioDevice getCurrentOutputDevice()
```
    Gets the selected output audio device
    
    Returns:
    
    The currently selected output audio device
    
    See Also:
    
    AudioDevice
  - setCurrentOutputDevice
```
public Result setCurrentOutputDevice(AudioDevice device)
```
    Select the output audio device
    
    Parameters:
    
    device - The output device to be selected
    
    Returns:
    
    Result of the selection
    
    See Also:
    
    Result
  - getCurrentRingDevice
```
public AudioDevice getCurrentRingDevice()
```
    Gets the selected ringing audio device
    
    Returns:
    
    The currently selected ringing audio device
    
    See Also:
    
    AudioDevice
  - setCurrentRingDevice
```
public Result setCurrentRingDevice(AudioDevice device)
```
    Select the ringing audio device
    
    Parameters:
    
    device - The ringing device to be selected
    
    Returns:
    
    Result of the selection
    
    See Also:
    
    Result
  - addSoundFromMemory
```
public Sound addSoundFromMemory(byte[] data,
                                int length,
                                int sampleLen,
                                int frequency,
                                boolean repeat,
                                int pauseMs)
```
    Load a sound from a memory buffer Creates a sound structure and copies the provided samples into its buffers. While playing the resulting sound through startSound or startPlayback it can undergo resampling (to match frequencies) or remixing (to match the channels) based on the current audio settings.
    
    Parameters:
    
    data - The samples to copy
    
    length - Size of the data to be coppied in bytes
    
    sampleLen - Size of a sample in bytes (must be 2)
    
    frequency - Frequency of the sound in Hz (must be 8000)
    
    repeat - 1/TRUE if the sound should be looped when played
    
    pauseMs - If the sound is to be looped, the amount of silence in milliseconds between each loop
    
    Returns:
    
    The newly loaded sound or NULL in case of error
    
    See Also:
    
    AudioFileFormat addSoundFromFile
  - addSoundFromFile
```
public Sound addSoundFromFile(java.lang.String filePath,
                              AudioFileFormat fileFormat,
                              boolean repeat,
                              int pauseMs)
```
    Load a sound from a file Loads a sound from a file. The sound will inherit the file's format with the only exception that 8-bit, 24-bit and 32-bit PCM samples will be automatically converted to 16-bit while the sound is being loaded. The frequency and channel count will be left unchanged. While playing the resulting sound through startSound or startPlayback it can undergo resampling (to match frequencies) or remixing (to match the channels) based on the current audio settings.
    
    Parameters:
    
    filePath - Name of the file to load from, UTF-8
    
    fileFormat - Type of the file to load from - !!!currently limited only to WAV!!!
    
    repeat - 1/TRUE if the sound should be looped when played
    
    pauseMs - If the sound is to be looped, the amount of silence in milliseconds between each loop
    
    Returns:
    
    The newly loaded sound or NULL in case of error
    
    See Also:
    
    AudioFileFormat addSoundFromMemory
  - startSound
```
public Result startSound(Sound sound,
                         AudioOutputDeviceType outputType)
```
    Start playback of a sound Start playing the sound on one of the two output devices (either the selected output device or the selected ringing device). Use setCurrentOutputDevice and setCurrentRingDevice to select the output devices. The sound will be played on the device and will not be sent over the communication channel (see startPlayback).
    
    Parameters:
    
    sound - The sound to be played
    
    outputType - The output device to play the sound
    
    Returns:
    
    Result of the playback
    
    See Also:
    
    setCurrentRingDevice addSoundFromFile addSoundFromMemory stopSound startPlayback
  - stopSound
```
public Result stopSound(Sound sound,
                        AudioOutputDeviceType outputType)
```
    Stops playback of a sound Stops playing the sound. Must be called with the same parameters as startSound.
    
    Parameters:
    
    sound - Sound to stop playing
    
    outputType - The output device to play the sound
    
    Returns:
    
    Result of the stop
    
    See Also:
    
    startSound
  - startPlayback
```
public Result startPlayback(Sound sound,
                            AudioOutputDeviceType monitorDevice)
```
    Starts playback over the current call Starts playing back the sound to the remote peer(s) (if there are active calls) instead of the microphone input. Microphone input will be discared during the playback. Optionally plays the sound on the output/ringing device (this is the "monitor" device). When the whole sound has been played out the microphone will be reconnected again. All changes made to the microphone during the playback will be applied after normal operation has been resumed.
    
    Parameters:
    
    sound - The sound to play over the network
    
    monitorDevice - Monitoring device - optional local output device to play the sound
    
    Returns:
    
    Result of the playback
    
    See Also:
    
    stopPlayback
  - stopPlayback
```
public Result stopPlayback()
```
    Stops any playback Stops any playback and monitored sound immediately if there is such.
    
    Returns:
    
    Result of the stop
    
    See Also:
    
    startPlayback
  - setCallRecordingNotifySound
```
public Result setCallRecordingNotifySound(Sound sound,
                                          AudioOutputDeviceType monitorDevice)
```
    Sets the sound to be played over the current call on every recording start Sets the sound to be played back to the remote peer(s) (instead of the microphone input) on every start of call recording. (The sound must be added beforehand with addSoundFromFile or addSoundFromMemory). Optionally plays the sound on the output/ringing device (this is the "monitor" device). When the whole sound has been played out the microphone will be reconnected again. All changes made to the microphone during the playback will be applied after normal operation has been resumed.
    
    Parameters:
    
    sound - The sound to play over the network
    
    monitorDevice - Monitoring device
    
    Returns:
    
    Result of the setting
    
    See Also:
    
    addSoundFromMemory startPlayback stopPlayback
  - muteInput
```
public Result muteInput(boolean value)
```
    Mute or unmute the input device/microphone
    Parameters:
    value -
    
    0 - unmute
    1 - mute
    Returns:
    
    Result of the mute
    
    See Also:
    
    muteOutput
  - muteOutput
```
public Result muteOutput(boolean value)
```
    Mute or unmute the output device/speaker
    Parameters:
    value -
    
    0 - unmute
    1 - mute
    Returns:
    
    Result of the mute
    
    See Also:
    
    muteOutput
  - addStatusListener
```
public void addStatusListener(AudioEventsHandler value)
```
    Adds audio events listener
    
    Parameters:
    
    value - The audio events handler
    
    See Also:
    
    AudioEventsHandler
  - dropStatusListener
```
public void dropStatusListener(AudioEventsHandler value)
```
    Drops audio events listener
    
    Parameters:
    
    value - The audio events handler
    
    See Also:
    
    AudioEventsHandler

Class AudioEndpointControl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AudioEndpointControl

Method Detail

handle

finalize

audioEndpoint

audioEndpoint

micLevel

micLevel

outputLevel

outputLevel

ringLevel

ringLevel

echoCancellation

echoCancellation

highPassFilter

highPassFilter

preAmplifier

preAmplifier

noiseSuppression

noiseSuppression

audioSourcePreset

audioSourcePreset

audioDevices

micBoost

micBoost

enableFixedSpeakerGain

enableFixedSpeakerGain

fixedSpeakerGain

fixedSpeakerGain

getAutomaticGainControlMode

getAutomaticGainControlGain

setAutomaticGainControlMode

hostApi

resampler

getDeviceByName

getCurrentInputDevice

setCurrentInputDevice

getCurrentOutputDevice

setCurrentOutputDevice

getCurrentRingDevice

setCurrentRingDevice

addSoundFromMemory

addSoundFromFile

startSound

stopSound

startPlayback

stopPlayback

setCallRecordingNotifySound

muteInput

muteOutput

addStatusListener

dropStatusListener