java.lang.Object

com.opentok.StreamProperties.Builder

Enclosing class: : StreamProperties


public static class StreamProperties.Builder extends Object

Use this class to create a StreamProperties object.

See Also: : - StreamProperties

Constructor Summary

Constructors

Constructor

Description

Builder()

Method Summary

All MethodsInstance MethodsConcrete Methods

Modifier and Type

Method

Description

StreamProperties.Builder

addLayoutClass(String layoutClass)

Call this method to set an individual layout class for the stream.

StreamProperties

build()

Builds the StreamProperties object.

StreamProperties.Builder

id(String id)

Call this method to set the ID of the stream.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

id

public StreamProperties.Builder id(String id)

Call this method to set the ID of the stream.

Parameters: : id - The stream ID.

Returns: : The StreamProperties.Builder object with the ID setting.

addLayoutClass

public StreamProperties.Builder addLayoutClass(String layoutClass)

Call this method to set an individual layout class for the stream. Call this method multiple times to set multiple classes for a stream. If you do not call this method when building the StreamProperties object, the stream's layout class list will be cleared.

Parameters: : layoutClass - A layout class string for the stream. We do not check for null, empty, or duplicate strings.

Returns: : The StreamListProperties.Builder object.

build

public StreamProperties build()

Builds the StreamProperties object.

Returns: : The StreamProperties object.