Package com.opentok.android

Class Subscriber.Builder

java.lang.Object

com.opentok.android.SubscriberKit.Builder

com.opentok.android.Subscriber.Builder

Enclosing class:

Subscriber

public static class Subscriber.Builder
extends SubscriberKit.Builder

Used to build a Subscriber object. Instantiate a Builder object using the Subscriber.Builder#Builder(Context context, Stream stream) constructor. Then call methods of the Builder instance to add settings for the subscriber. Then call the build() method, which returns a SubscriberKit object.

Use the Session.subscribe(SubscriberKit subscriber) method to start streaming video for the subscriber.

Constructor Summary

Constructors

Constructor	Description
Builder(android.content.Context context, Stream stream)	Instantiates a Subscriber.Builder object.

Method Summary

Modifier and Type	Method	Description
Subscriber	build()	Returns a new Subscriber instance based on the Builder settings.
Subscriber.Builder	renderer(BaseVideoRenderer renderer)	Sets the video renderer to use for the subscriber.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(android.content.Context context,
 Stream stream)

Instantiates a Subscriber.Builder object.

Parameters:

context - The android.content.Context for the SubscriberKit object.

stream - The Stream object corresponding to the stream you will subscribe to.

Method Details

renderer

public Subscriber.Builder renderer(BaseVideoRenderer renderer)

Sets the video renderer to use for the subscriber. If you do not call this method, the subscriber will use the default Subscriber renderer.

Overrides:

renderer in class SubscriberKit.Builder

build

public Subscriber build()

Returns a new Subscriber instance based on the Builder settings.

Overrides:

build in class SubscriberKit.Builder