Intel® Collaboration Suite for WebRTC  version 4.3
Open WebRTC Toolkit (OWT) Client SDK for Android*
ConferenceClient Class Reference

ConferenceClient handles PeerConnection interactions between client and server. More...

Inheritance diagram for ConferenceClient:
Collaboration diagram for ConferenceClient:

Classes

interface  ConferenceClientObserver
 Interface for observing conference client events. More...
 

Public Member Functions

 ConferenceClient (ConferenceClientConfiguration configuration)
 Constructor for ConferenceClient. More...
 
void addObserver (ConferenceClientObserver observer)
 Add a ConferenceClientObserver. More...
 
void removeObserver (ConferenceClientObserver observer)
 Remove a ConferenceClientObserver. More...
 
ConferenceInfo info ()
 Get the ConferenceInfo of this ConferenceClient. More...
 
synchronized void join (String token, ActionCallback< ConferenceInfo > callback)
 Join a conference specified by |token|. More...
 
synchronized void leave ()
 Leave the conference.
 
void publish (LocalStream localStream, ActionCallback< Publication > callback)
 Publish a LocalStream to the conference. More...
 
synchronized void publish (final LocalStream localStream, final PublishOptions options, final ActionCallback< Publication > callback)
 Publish a LocalStream to the conference. More...
 
void subscribe (RemoteStream remoteStream, ActionCallback< Subscription > callback)
 Subscribe a RemoteStream from the conference. More...
 
synchronized void subscribe (final RemoteStream remoteStream, final SubscribeOptions options, final ActionCallback< Subscription > callback)
 Subscribe a RemoteStream from the conference. More...
 
void send (String message, ActionCallback< Void > callback)
 Send a text message to all participants in the conference. More...
 
synchronized void send (String participantId, String message, final ActionCallback< Void > callback)
 Send a text message to a specific participant in the conference. More...
 

Detailed Description

ConferenceClient handles PeerConnection interactions between client and server.

Constructor & Destructor Documentation

Constructor for ConferenceClient.

Parameters
configurationConferenceClientConfiguration for ConferenceClient

Member Function Documentation

void addObserver ( ConferenceClientObserver  observer)
inline

Add a ConferenceClientObserver.

Parameters
observerConferenceClientObserver to be added.
ConferenceInfo info ( )
inline

Get the ConferenceInfo of this ConferenceClient.

Returns
current ConferenceInfo of this ConferenceClient.

Here is the caller graph for this function:

synchronized void join ( String  token,
ActionCallback< ConferenceInfo callback 
)
inline

Join a conference specified by |token|.

Parameters
tokentoken issued by conference server (nuve).
callbackActionCallback.onSuccess will be invoked with the ConferenceInfo when succeeds to join the conference room. Otherwise when fails to do so, ActionCallback .onFailure will be invoked with the corresponding OwtError.
void publish ( LocalStream  localStream,
ActionCallback< Publication callback 
)
inline

Publish a LocalStream to the conference.

Parameters
localStreamLocalStream to be published.
callbackActionCallback.onSuccess will be invoked with the Publication when succeeds to publish the LocalStream. Otherwise when fails to do so, ActionCallback .onFailure will be invoked with the corresponding OwtError.
synchronized void publish ( final LocalStream  localStream,
final PublishOptions  options,
final ActionCallback< Publication callback 
)
inline

Publish a LocalStream to the conference.

Parameters
localStreamLocalStream to be published.
optionsPublishOptions for publishing this LocalStream.
callbackActionCallback.onSuccess will be invoked with the Publication when succeeds to publish the LocalStream. Otherwise when fails to do so, ActionCallback .onFailure will be invoked with the corresponding OwtError.

Here is the call graph for this function:

void removeObserver ( ConferenceClientObserver  observer)
inline

Remove a ConferenceClientObserver.

Parameters
observerConferenceClientObserver to be removed.
void send ( String  message,
ActionCallback< Void >  callback 
)
inline

Send a text message to all participants in the conference.

Parameters
messagemessage to be sent.
callbackActionCallback.onSuccess will be invoked succeeds to send the message. Otherwise when fails to do so, ActionCallback.onFailure will be invoked with the corresponding OwtError.
synchronized void send ( String  participantId,
String  message,
final ActionCallback< Void >  callback 
)
inline

Send a text message to a specific participant in the conference.

Parameters
participantIdid of Participant the message to be sent to.
messagemessage to be sent.
callbackActionCallback.onSuccess will be invoked succeeds to send the message. Otherwise when fails to do so, ActionCallback.onFailure will be invoked with the corresponding OwtError.

Here is the call graph for this function:

void subscribe ( RemoteStream  remoteStream,
ActionCallback< Subscription callback 
)
inline

Subscribe a RemoteStream from the conference.

Parameters
remoteStreamRemoteStream to be subscribed.
callbackActionCallback.onSuccess will be invoked with the Subscription when succeeds to subscribe the RemoteStream. Otherwise when fails to do so, ActionCallback .onFailure will be invoked with the corresponding OwtError.
synchronized void subscribe ( final RemoteStream  remoteStream,
final SubscribeOptions  options,
final ActionCallback< Subscription callback 
)
inline

Subscribe a RemoteStream from the conference.

Parameters
remoteStreamRemoteStream to be subscribed.
optionsSubscribeOptions for subscribing the RemoteStream.
callbackActionCallback.onSuccess will be invoked with the Subscription when succeeds to subscribe the RemoteStream. Otherwise when fails to do so, ActionCallback .onFailure will be invoked with the corresponding OwtError.