Interface Call
-
- All Implemented Interfaces:
public interface CallCall object acts as a handler for managing a connection between call participants, accessing details such as start time, state and possible errors. It also allows to attach listeners to be notified about changes in it's lifecycle.
-
-
Method Summary
Modifier and Type Method Description abstract UnitaddCallListener(CallListener callListener)Adds a CallListener to the call. abstract UnitremoveCallListener(CallListener callListener)Removes a CallListener from the call. abstract Unitanswer()Answers the incoming call. abstract Unithangup()Ends the call, regardless of what state it is in. abstract UnitsendDTMF(String keys)Sends one or more DTMF tones for tone dialing. abstract UnitpauseVideo()Pauses the video capturing. abstract UnitresumeVideo()Resumes the video capturing. abstract UnitsetBandwidthLimits(Integer maxAudioBitrate, Integer maxVideoBitrate)Sets bandwidth limitations on negotiated media streams. abstract CallQualityControllergetQualityController()The CallQualityController associated with given call. abstract StringgetCallId()The call identifier. abstract StringgetRemoteUserId()The identifier of the remote participant of the call. abstract CallDetailsgetDetails()CallDetails containing information about the call. abstract CallStategetState()The CallState the call is currently in. abstract CallDirectiongetDirection()The CallDirection of the call. abstract Map<String, String>getHeaders()Call headers. -
-
Method Detail
-
addCallListener
abstract Unit addCallListener(CallListener callListener)
Adds a CallListener to the call.
- Parameters:
callListener- A CallListener to be added.
-
removeCallListener
abstract Unit removeCallListener(CallListener callListener)
Removes a CallListener from the call. If listener was not added before method is no-op.
- Parameters:
callListener- A CallListener to be removed.
-
hangup
abstract Unit hangup()
Ends the call, regardless of what state it is in. If the call is an incoming call that has not yet been answered, the call will be reported as denied to the caller.
-
sendDTMF
abstract Unit sendDTMF(String keys)
Sends one or more DTMF tones for tone dialing. (Only applicable for calls terminated to PSTN (Publicly Switched Telephone Network)).
- Parameters:
keys- May be a series of DTMF keys.
-
pauseVideo
abstract Unit pauseVideo()
Pauses the video capturing.
-
resumeVideo
abstract Unit resumeVideo()
Resumes the video capturing.
-
setBandwidthLimits
abstract Unit setBandwidthLimits(Integer maxAudioBitrate, Integer maxVideoBitrate)
Sets bandwidth limitations on negotiated media streams. Bitrate settings should be non-negative integers values in kbps. Setting bitrate to zero forces use of default values. Settings take effect only if applied before call starts.
- Parameters:
maxAudioBitrate- Max audio bitrate in kbps.maxVideoBitrate- Max video bitrate in kbps.
-
getQualityController
abstract CallQualityController getQualityController()
The CallQualityController associated with given call.
-
getRemoteUserId
abstract String getRemoteUserId()
The identifier of the remote participant of the call.
-
getDetails
abstract CallDetails getDetails()
CallDetails containing information about the call.
-
getDirection
abstract CallDirection getDirection()
The CallDirection of the call.
-
getHeaders
abstract Map<String, String> getHeaders()
Call headers.
IMPORTANT: If a call is initially received via remote push notifications, headers may not be immediately available due to push payload size limitations. If it's not immediately available, it will be available after the CallListener.onCallProgressing or CallListener.onCallEstablished callbacks of CallListener are called.
-
-
-
-