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

Subscription handles the actions on a RemoteStream subscribed by a ConferenceClient. More...

Public Member Functions

void mute (final TrackKind trackKind, final ActionCallback< Void > callback)
 Stop receiving the media track data to conference. More...
 
void unmute (final TrackKind trackKind, final ActionCallback< Void > callback)
 Start to receive the media track data that has been stopped before to conference. More...
 
void applyOptions (VideoUpdateOptions updateOptions, final ActionCallback< Void > callback)
 Update the media track parameters of the Subscription. More...
 
void getStats (ActionCallback< RTCStatsReport > callback)
 Get the PeerConnection stats. More...
 
void stop ()
 Stop subscribing the RemoteStream associated with the Subscription from the conference.
 
void addObserver (SubscriptionObserver observer)
 Add a SubscriptionObserver. More...
 
void removeObserver (SubscriptionObserver observer)
 Removed a SubscriptionObserver. More...
 

Public Attributes

final String id
 Id of the Subscription.
 

Detailed Description

Subscription handles the actions on a RemoteStream subscribed by a ConferenceClient.

Member Function Documentation

void addObserver ( SubscriptionObserver  observer)
inline

Add a SubscriptionObserver.

Parameters
observerSubscriptionObserver to be added.
void applyOptions ( VideoUpdateOptions  updateOptions,
final ActionCallback< Void >  callback 
)
inline

Update the media track parameters of the Subscription.

Currently only updating for video tracks is supported.

Parameters
updateOptionsUpdateOptions
callbackActionCallback.onSuccess will be invoked when succeeds to get the update. Otherwise when fails to do so, ActionCallback .onFailure will be invoked with the corresponding OwtError.

Here is the call graph for this function:

void getStats ( ActionCallback< RTCStatsReport >  callback)
inline

Get the PeerConnection stats.

Parameters
callbackActionCallback.onSuccess will be invoked with RTCStatsReport when succeeds to get the stats. Otherwise when fails to do so, ActionCallback.onFailure will be invoked with the corresponding OwtError.
void mute ( final TrackKind  trackKind,
final ActionCallback< Void >  callback 
)
inline

Stop receiving the media track data to conference.

Parameters
trackKindTrackKind of the media to be stopped.
callbackActionCallback.onSuccess will be invoked when succeeds to mute. Otherwise when fails to do so, ActionCallback.onFailure will be invoked with the corresponding OwtError.

Here is the call graph for this function:

Here is the caller graph for this function:

void removeObserver ( SubscriptionObserver  observer)
inline

Removed a SubscriptionObserver.

Parameters
observerSubscriptionObserver to be removed.
void unmute ( final TrackKind  trackKind,
final ActionCallback< Void >  callback 
)
inline

Start to receive the media track data that has been stopped before to conference.

Parameters
trackKindTrackKind of the media to be started.
callbackActionCallback.onSuccess will be invoked when succeeds to unmute. Otherwise when fails to do so, ActionCallback.onFailure will be invoked with the corresponding OwtError.

Here is the call graph for this function: