Call

`id()`

Description

Returns a unique call identifier.

Arguments

none

Returns

String - Call ID.

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
String callId = webrtcCall.id();

`status()`

Description

Returns current call status.

Arguments

none

Returns

CallStatus - Call status.

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
CallStatus callStatus = webrtcCall.status();

`duration()`

Description

Returns call duration in seconds calculated from the time call was established. 0 if the call has not been established yet.

Arguments

none

Returns

int - Call duration in seconds

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
int callDuration = webrtcCall.duration();

`startTime()`

Description

Returns the time when the call started (but was not yet established). Initially, startTime is null.

Arguments

none

Returns

Date - Time when the call was initiated

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
Date startTime = webrtcCall.startTime();

`establishTime()`

Description

Returns the time when the call was established. Initially, establishTime is null.

Arguments

none

Returns

Date - Time when the call was established

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
Date establishTime = webrtcCall.establishTime();

`endTime()`

Description

Returns the time when the call finished. Initially, endTime is null.

Arguments

none

Returns

Date - Time when the call finished

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
Date endTime = webrtcCall.endTime();

`source()`

Description

Returns the endpoint from which the call originated.

Arguments

none

Returns

Endpoint - Endpoint which initiated the call

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
Endpoint source = webrtcCall.source();

`destination()`

Description

Returns the endpoint which received the call.

Arguments

none

Returns

Endpoint - Endpoint which received the call

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
Endpoint destination = webrtcCall.destination();

`counterpart()`

Description

Returns the remote endpoint which is participating in the call.

Arguments

none

Returns

Endpoint - Remote endpoint which is participating in the call.

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
Endpoint counterpart = webrtcCall.counterpart();

`mute(shouldMute)`

Description

Controls whether the user's audio in the call should be muted after this action. Disabled by default.

Arguments

shouldMute: boolean - true if the audio should be muted, otherwise false.

Returns

N/A

Throws

ActionFailedException - if muting fails for any reason.

Example

private void example() {
    InfobipRTC infobipRTC = InfobipRTC.getInstance();
    WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
    try {
        webrtcCall.mute(true);
    } catch (ActionFailedException e) {
        Log.w("WebRTC", String.format("Failed to execute action. Error: %s", e.getErrorCode().getDescription()));
    }
}

`muted()`

Description

Returns the information whether the user's audio is muted or not.

Arguments

none

Returns

boolean - true if the audio is muted, otherwise false.

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
boolean muted = webrtcCall.muted();

`speakerphone(enabled)`

Description

Controls whether the audio should be played on the speakerphone. Disabled by default. If disabled, the audio will be played through the next available audio device based on the priority order.

Arguments

enabled: boolean - true if the audio should be played on the speakerphone, otherwise false.

Returns

N/A

Example

private void example() {
    InfobipRTC infobipRTC = InfobipRTC.getInstance();
    WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
    webrtcCall.speakerphone(true);
}

`speakerphone()`

Description

Returns information whether speakerphone is enabled.

Arguments

none

Returns

boolean - true if the speakerphone is enabled, otherwise false.

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
boolean speakerphone = webrtcCall.speakerphone();

`sendDTMF(dtmf)`

Description

Simulates key-press by sending DTMF (Dual-Tone Multi-Frequency) entry.

Arguments

dtmf: String - One of the allowed DTMF characters:
- digits: 0 to 9
- letters: A to D
- symbols: * and #

Returns

N/A

Throws

ActionFailedException - if sending DTMF fails for any reason.

Example

private void example() {
    InfobipRTC infobipRTC = InfobipRTC.getInstance();
    WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
    try {
        webrtcCall.sendDTMF("7");
    } catch (ActionFailedException e) {
        Log.w("WebRTC", String.format("Failed to execute action. Error: %s", e.getErrorCode().getDescription()));
    }
}

`setNetworkQualityEventListener(networkQualityEventListener)`

Description

Configures event handler for network quality events.

Arguments

networkQualityEventListener: NetworkQualityEventListener - Interface that should be implemented in order to handle network quality events properly.

Returns

N/A

Example

private void example() {
    InfobipRTC infobipRTC = InfobipRTC.getInstance();
    WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
    webrtcCall.setNetworkQualityEventListener(networkQualityChangedEvent -> {
        NetworkQuality networkQuality = networkQualityChangedEvent.getNetworkQuality();
        Log.d("WebRTC", String.format("Local network quality is: %s (score: %s)", networkQuality, networkQuality.getScore()));
    });
}

`getNetworkQualityEventListener()`

Description

Returns event handler for network quality events.

Arguments

none

Returns

NetworkQualityEventListener - Interface that should be implemented in order to handle network quality events properly.

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
NetworkQualityEventListner networkQualityEventListner = webrtcCall.getNetworkQualityEventListener();

`audioDeviceManager()`

Description

Returns the instance of AudioDeviceManager that should be used to manage the audio devices in the current call.

Arguments

none

Returns

AudioDeviceManager - An instance of AudioDeviceManager specifically designed for handling audio devices.

Example

InfobipRTC infobipRTC = InfobipRTC.getInstance();
WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
AudioDeviceManager audioDeviceManager = webrtcCall.audioDeviceManager();

`audioQualityMode(audioQualityMode)`

Description

Sets the audio quality mode to a given enum value.

Arguments

audioQualityMode: AudioOptions.AudioQualityMode - Enum value that corresponds to the audio quality mode.

Returns

N/A

Example

private void example() {
    InfobipRTC infobipRTC = InfobipRTC.getInstance();
    WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
    webrtcCall.audioQualityMode(AudioOptions.AudioQualityMode.LOW_DATA);
}

`audioQualityMode()`

Description

Returns the audio quality mode that is used during the call.

Arguments

none

Returns

AudioQualityMode - Enum value that corresponds to the audio quality mode.

Example

private void example() {
    InfobipRTC infobipRTC = InfobipRTC.getInstance();
    WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
    AudioOptions.AudioQualityMode audioQualityMode = webrtcCall.audioQualityMode();
}

`hangup()`

Description

Hangs up the call, which ends up in both parties receiving the CallHangupEvent, after the hangup is processed by Infobip WebRTC platform.

Arguments

none

Returns

N/A

Example

private void example() {
    InfobipRTC infobipRTC = InfobipRTC.getInstance();
    WebrtcCall webrtcCall = (WebrtcCall) infobipRTC.getActiveCall();
    webrtcCall.hangup();
}