com.digium.respokesdk

Class RespokeCall

java.lang.Object

com.digium.respokesdk.RespokeCall

public class RespokeCall
extends java.lang.Object

WebRTC Call including getUserMedia, path and codec negotation, and call state.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RespokeCall.Listener An interface to notify the receiver of events occurring with the call

Field Summary

Fields

Modifier and Type	Field and Description
boolean	audioOnly
RespokeEndpoint	endpoint
java.util.Date	timestamp

Constructor Summary

Constructors

Constructor and Description
RespokeCall(RespokeSignalingChannel channel, org.json.JSONObject sdp, java.lang.String newSessionID, java.lang.String newConnectionID, java.lang.String endpointID, java.lang.String fromType, RespokeEndpoint newEndpoint, boolean directConnectionOnly, java.util.Date newTimestamp) Constructor used for inbound calls
RespokeCall(RespokeSignalingChannel channel, RespokeEndpoint newEndpoint, boolean directConnectionOnly) Constructor used for outbound calls
RespokeCall(RespokeSignalingChannel channel, java.lang.String remoteEndpoint, java.lang.String remoteType) Constructor primarily used for starting conference calls

Method Summary

Modifier and Type	Method and Description
void	answer(android.content.Context context, RespokeCall.Listener newListener) Answer the call and start the process of obtaining media.
void	answerReceived(org.json.JSONObject remoteSDP, java.lang.String remoteConnection) Process an answer message received from the remote endpoint.
void	attachVideoRenderer(android.opengl.GLSurfaceView glView) Attach the call's video renderers to the specified GLSurfaceView
boolean	audioIsMuted() Indicates if the local audio stream is muted
void	connectedReceived() Process a connected messsage received from the remote endpoint.
void	directConnectionDidAccept(android.content.Context context)
void	directConnectionDidClose(RespokeDirectConnection sender)
void	directConnectionDidOpen(RespokeDirectConnection sender)
PeerConnection	getPeerConnection() Retrieve the WebRTC peer connection handling the call
java.lang.String	getSessionID() Get the session ID of this call
void	hangup(boolean shouldSendHangupSignal) Tear down the call and release resources
void	hangupReceived() Process a hangup message received from the remote endpoint.
void	iceCandidatesReceived(org.json.JSONArray candidates) Process ICE candidates suggested by the remote endpoint.
boolean	isActive() Indicate whether a call is being setup or is in progress.
boolean	isCaller() Indicates if the local client initiated the call
void	muteAudio(boolean mute) Mute or unmute the local audio
void	muteVideo(boolean mute) Mute or unmute the local video
void	pause() Notify the call that the UI controls associated with rendering video are no longer available, such as during activity lifecycle changes
void	resume() Notify the call that the UI controls associated with rendering video are available again
static boolean	sdpHasVideo(org.json.JSONObject sdp) Determines if the specified SDP data contains definitions for a video stream
void	setListener(RespokeCall.Listener listener) Set a receiver for the Listener interface
void	startCall(android.content.Context context, android.opengl.GLSurfaceView glView, boolean isAudioOnly) Start the outgoing call process.
boolean	videoIsMuted() Indicates if the local video stream is muted

Methods inherited from class java.lang.Object

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

Field Detail

endpoint

public RespokeEndpoint endpoint

audioOnly

public boolean audioOnly

timestamp

public java.util.Date timestamp

Constructor Detail

RespokeCall

public RespokeCall(RespokeSignalingChannel channel,
                   java.lang.String remoteEndpoint,
                   java.lang.String remoteType)

Constructor primarily used for starting conference calls

Parameters:

channel - The signaling channel to use for the call

remoteEndpoint - The remote recipient of the call

remoteType - The type of remote recipient (i.e. "conference", "web", etc)

RespokeCall

public RespokeCall(RespokeSignalingChannel channel,
                   RespokeEndpoint newEndpoint,
                   boolean directConnectionOnly)

Constructor used for outbound calls

Parameters:

channel - The signaling channel to use for the call

newEndpoint - The remote recipient of the call

directConnectionOnly - Specify true if this call is only for establishing a direct data connection (i.e. no audio/video)

RespokeCall

public RespokeCall(RespokeSignalingChannel channel,
                   org.json.JSONObject sdp,
                   java.lang.String newSessionID,
                   java.lang.String newConnectionID,
                   java.lang.String endpointID,
                   java.lang.String fromType,
                   RespokeEndpoint newEndpoint,
                   boolean directConnectionOnly,
                   java.util.Date newTimestamp)

Constructor used for inbound calls

Parameters:

channel - The signaling channel to use for the call

sdp - The SDP data from the call offer

newSessionID - The session ID to use for the call signaling

newConnectionID - The ID of the remote connection initiating the call

endpointID - The ID of the remote endpoint

fromType - The type of remote recipient (i.e. "conference", "web", etc)

newEndpoint - The remote recipient of the call

directConnectionOnly - Specify true if this call is only for establishing a direct data connection (i.e. no audio/video)

newTimestamp - The timestamp when the call was initiated remotely

Method Detail

sdpHasVideo

public static boolean sdpHasVideo(org.json.JSONObject sdp)

Determines if the specified SDP data contains definitions for a video stream

Parameters:

sdp - The SDP data to examine

Returns:

True if a video stream definition is present, false otherwise

setListener

public void setListener(RespokeCall.Listener listener)

Set a receiver for the Listener interface

Parameters:

listener - The new receiver for events from the Listener interface for this call instance

getSessionID

public java.lang.String getSessionID()

Get the session ID of this call

Returns:

The session ID

startCall

public void startCall(android.content.Context context,
                      android.opengl.GLSurfaceView glView,
                      boolean isAudioOnly)

Start the outgoing call process. This method is used internally by the SDK and should never be called directly from your client application

Parameters:

context - An application context with which to access shared resources

glView - The GLSurfaceView on which to render video if applicable

isAudioOnly - Specify true if this call should be audio only

attachVideoRenderer

public void attachVideoRenderer(android.opengl.GLSurfaceView glView)

Attach the call's video renderers to the specified GLSurfaceView

Parameters:

glView - The GLSurfaceView on which to render video

answer

public void answer(android.content.Context context,
                   RespokeCall.Listener newListener)

Answer the call and start the process of obtaining media. This method is called automatically on the caller's side. This method must be called on the callee's side to indicate that the endpoint does wish to accept the call.

Parameters:

context - An application context with which to access shared resources

newListener - A listener to receive notifications of call-related events

hangup

public void hangup(boolean shouldSendHangupSignal)

Tear down the call and release resources

Parameters:

shouldSendHangupSignal - Send a hangup signal to the remote party if signal is not false and we have not received a hangup signal from the remote party.

muteVideo

public void muteVideo(boolean mute)

Mute or unmute the local video

Parameters:

mute - If true, mute the video. If false, unmute the video

videoIsMuted

public boolean videoIsMuted()

Indicates if the local video stream is muted

Returns:

returns true if the local video stream is currently muted

muteAudio

public void muteAudio(boolean mute)

Mute or unmute the local audio

Parameters:

mute - If true, mute the audio. If false, unmute the audio

audioIsMuted

public boolean audioIsMuted()

Indicates if the local audio stream is muted

Returns:

returns true if the local audio stream is currently muted

pause

public void pause()

Notify the call that the UI controls associated with rendering video are no longer available, such as during activity lifecycle changes

resume

public void resume()

Notify the call that the UI controls associated with rendering video are available again

hangupReceived

public void hangupReceived()

Process a hangup message received from the remote endpoint. This is used internally to the SDK and should not be called directly by your client application.

answerReceived

public void answerReceived(org.json.JSONObject remoteSDP,
                           java.lang.String remoteConnection)

Process an answer message received from the remote endpoint. This is used internally to the SDK and should not be called directly by your client application.

Parameters:

remoteSDP - Remote SDP data

remoteConnection - Remote connection that answered the call

connectedReceived

public void connectedReceived()

Process a connected messsage received from the remote endpoint. This is used internally to the SDK and should not be called directly by your client application.

iceCandidatesReceived

public void iceCandidatesReceived(org.json.JSONArray candidates)

Process ICE candidates suggested by the remote endpoint. This is used internally to the SDK and should not be called directly by your client application.

Parameters:

candidates - Array of candidates to evaluate

isCaller

public boolean isCaller()

Indicates if the local client initiated the call

Returns:

True if the local client initiated the call

getPeerConnection

public PeerConnection getPeerConnection()

Retrieve the WebRTC peer connection handling the call

Returns:

The WebRTC PeerConnection instance

isActive

public boolean isActive()

Indicate whether a call is being setup or is in progress.

Returns:

True if the call is active

directConnectionDidAccept

public void directConnectionDidAccept(android.content.Context context)

directConnectionDidOpen

public void directConnectionDidOpen(RespokeDirectConnection sender)

directConnectionDidClose

public void directConnectionDidClose(RespokeDirectConnection sender)