com.quickblox.videochat.webrtc

Class QBRTCClient

java.lang.Object

BaseClient

com.quickblox.videochat.webrtc.QBRTCClient

public final class QBRTCClient
extends BaseClient

WebRTC singletone class. For getting it instance use static generation method getInstance() Listens RTCSignallingMessageProcessor callbacks, manages QBRTCSession Also this class responsible for storrng listeners which implements interfaces below:

• QBRTCClientSessionCallbacks - inteface for listenning session lifecycle
• QBRTCClientVideoTracksCallbacks - interface for litenning cretion of new local or remote videotracks
• QBRTCClientConnectionCallbacks - interface for lilstenning org.webrtc.PeerConnection lifecycle

Next steps should be executed before users start conversating:

1. The RTCClient should be setted up
2. You must start call or reciev it from opponent
3. You must handle incomming QBRTCSession in case of opponent call to you
4. You must handle incomming of new sessions

For more info about webrtc module look through @see http://quickblox.com/developers/Sample-webrtc-android Also you could get sample app from @see https://github.com/QuickBlox/quickblox-android-sdk

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,QBRTCSession>	sessions
static java.lang.String	TAG

Method Summary

Modifier and Type	Method and Description
void	addRTCSignallingMessageProcessorCallbackListener(RTCSignallingMessageProcessorCallback callback) Adds the QBRTCSmackMessageProcessorListener implementation to the list of observers
void	addSessionCallbacksListener(QBRTCSessionEventsCallback callback) Adds the QBRTCClientSessionCallbacks implementation to the list of observers
void	addSignaling(QBSignaling signaling)
QBRTCSession	createNewSessionWithOpponents(java.util.List<java.lang.Integer> userIds, QBRTCTypes.QBConferenceType qbConferenceType) Use QBRTCMediaConfig to set audio and video constraints before creating QBRTCSession.
void	destroy()
static QBRTCClient	getInstance(Context context) Returns QBRTCClient instance, which must be initiated before any actions
QBRTCSession	getSession(java.lang.String sessionId)
boolean	isLastActiveSession()
void	onAddUserNeed(java.lang.Integer userToAdd, QBRTCSessionDescription sessionDescription)
void	onReceiveAcceptFromUser(java.lang.Integer from, QBRTCSessionDescription sessionDescription, SessionDescription sdp)
void	onReceiveCallFromUser(java.lang.Integer from, QBRTCSessionDescription sessionDescription, SessionDescription sdp) Returns is client ready to process income call or start new one
void	onReceiveIceCandidatesFromUser(java.util.List<IceCandidate> iceCandidates, java.lang.Integer from, QBRTCSessionDescription sessionDescription)
void	onReceiveRejectFromUser(java.lang.Integer opponentID, QBRTCSessionDescription sessionDescription)
void	onReceiveUserHungUpCall(java.lang.Integer opponentID, QBRTCSessionDescription sessionDescription)
void	prepareToProcessCalls() Adds this instance in xmppRTCMessageProcessor's callbacks list and set Context instance for org.webrtc.PeerConnectionFactory initiation
void	removeRTCSignallingMessageProcessorCallbackListener(RTCSignallingMessageProcessorCallback callback) Removes the QBRTCSmackMessageProcessorListener implementation from the list of observers
void	removeSessionsCallbacksListener(QBRTCSessionEventsCallback callback) Removes the QBRTCClientSessionCallbacks implementation from the list of observers
void	stopProcessCalls() Stopping receiving any session packets

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

sessions

protected final java.util.Map<java.lang.String,QBRTCSession> sessions

Method Detail

getInstance

public static QBRTCClient getInstance(Context context)

Returns QBRTCClient instance, which must be initiated before any actions

Returns:

QBRTCClient instance

createNewSessionWithOpponents

public QBRTCSession createNewSessionWithOpponents(java.util.List<java.lang.Integer> userIds,
                                                  QBRTCTypes.QBConferenceType qbConferenceType)
                                           throws java.lang.IllegalStateException

Use QBRTCMediaConfig to set audio and video constraints before creating QBRTCSession.

Returns new session in case of successful creation ore throws exceptions if current user wasn't logged in chat or count of opponents aren't more then 0.

Parameters:

userIds - - list of call participant id's

qbConferenceType - - current conference type

Throws:

java.lang.IllegalStateException

addSignaling

public void addSignaling(QBSignaling signaling)

isLastActiveSession

public boolean isLastActiveSession()

getSession

public QBRTCSession getSession(java.lang.String sessionId)

prepareToProcessCalls

public void prepareToProcessCalls()

Adds this instance in xmppRTCMessageProcessor's callbacks list and set Context instance for org.webrtc.PeerConnectionFactory initiation

stopProcessCalls

public void stopProcessCalls()

Stopping receiving any session packets

addSessionCallbacksListener

public void addSessionCallbacksListener(QBRTCSessionEventsCallback callback)

Adds the QBRTCClientSessionCallbacks implementation to the list of observers

Parameters:

callback - - WEBRTC calback for call processing

removeSessionsCallbacksListener

public void removeSessionsCallbacksListener(QBRTCSessionEventsCallback callback)

Removes the QBRTCClientSessionCallbacks implementation from the list of observers

Parameters:

callback - - WEBRTC calback for call processing

addRTCSignallingMessageProcessorCallbackListener

public void addRTCSignallingMessageProcessorCallbackListener(RTCSignallingMessageProcessorCallback callback)

Adds the QBRTCSmackMessageProcessorListener implementation to the list of observers

Parameters:

callback - - Smack signalling callback for call processing

removeRTCSignallingMessageProcessorCallbackListener

public void removeRTCSignallingMessageProcessorCallbackListener(RTCSignallingMessageProcessorCallback callback)

Removes the QBRTCSmackMessageProcessorListener implementation from the list of observers

Parameters:

callback - - Smack signalling callback for call processing

onReceiveCallFromUser

public void onReceiveCallFromUser(java.lang.Integer from,
                                  QBRTCSessionDescription sessionDescription,
                                  SessionDescription sdp)

Returns is client ready to process income call or start new one

Parameters:

from - sender id

sessionDescription - current session description

sdp - Protocol of session description according to RFC 4566.

onReceiveAcceptFromUser

public void onReceiveAcceptFromUser(java.lang.Integer from,
                                    QBRTCSessionDescription sessionDescription,
                                    SessionDescription sdp)

onReceiveRejectFromUser

public void onReceiveRejectFromUser(java.lang.Integer opponentID,
                                    QBRTCSessionDescription sessionDescription)

onReceiveIceCandidatesFromUser

public void onReceiveIceCandidatesFromUser(java.util.List<IceCandidate> iceCandidates,
                                           java.lang.Integer from,
                                           QBRTCSessionDescription sessionDescription)

onReceiveUserHungUpCall

public void onReceiveUserHungUpCall(java.lang.Integer opponentID,
                                    QBRTCSessionDescription sessionDescription)

onAddUserNeed

public void onAddUserNeed(java.lang.Integer userToAdd,
                          QBRTCSessionDescription sessionDescription)

destroy

public void destroy()