com.opentok

Class SessionProperties.Builder

java.lang.Object

com.opentok.SessionProperties.Builder

Enclosing class:

SessionProperties

public static class SessionProperties.Builder
extends java.lang.Object

Use this class to create a SessionProperties object.

See Also:

SessionProperties

Constructor Summary

Constructors

Constructor and Description
SessionProperties.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
SessionProperties	build() Builds the SessionProperties object.
SessionProperties.Builder	location(java.lang.String location) Call this method to set an IP address that the OpenTok servers will use to situate the session in its global network.
SessionProperties.Builder	mediaMode(MediaMode mediaMode) Call this method to determine whether the session will transmit streams using the OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED).

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionProperties.Builder

public SessionProperties.Builder()

Method Detail

location

public SessionProperties.Builder location(java.lang.String location)
                                   throws InvalidArgumentException

Call this method to set an IP address that the OpenTok servers will use to situate the session in its global network. If you do not set a location hint, the OpenTok servers will be based on the first client connecting to the session.

Parameters:

location - The IP address to serve as the locaion hint.

Returns:

The SessionProperties.Builder object with the location hint setting.

Throws:

InvalidArgumentException

mediaMode

public SessionProperties.Builder mediaMode(MediaMode mediaMode)

Call this method to determine whether the session will transmit streams using the OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED). By default, the mediaMode property is set to MediaMode.RELAYED.

With the mediaMode property set to MediaMode.RELAYED, the session will attempt to transmit streams directly between clients. If clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay audio-video streams.

The OpenTok Media Router provides the following benefits:

• The OpenTok Media Router can decrease bandwidth usage in multiparty sessions. (When the mediaMode property is set to MediaMode.RELAYED, each client must send a separate audio-video stream to each client subscribing to it.)
• The OpenTok Media Router can improve the quality of the user experience through Intelligent Quality Control. With Intelligent Quality Control, if a client's connectivity degrades to a degree that it does not support video for a stream it's subscribing to, the video is dropped on that client (without affecting other clients), and the client receives audio only. If the client's connectivity improves, the video returns.
• The OpenTok Media Router supports the archiving and playback feature, which lets you record, save, and retrieve OpenTok sessions.

You will be billed for streamed minutes if you use the OpenTok Media Router or if the session uses the OpenTok TURN server to relay streams. For information on pricing, see the OpenTok pricing page.

Parameters:

mediaMode - Set to a value defined in the MediaMode enum.

Returns:

The SessionProperties.Builder object with the media mode setting.

build

public SessionProperties build()

Builds the SessionProperties object.

Returns:

The SessionProperties object.