Suggestions

close search

Session Creation — Java

You can use the OpenTok Java library to generate OpenTok sessions. Each session has a unique session ID, which you can use in an OpenTok client library to connect to an OpenTok session. (See "Joining a Session" for Web, iOS, or Android.)

Creating a session that uses the OpenTok Media Router

The following code session that uses the OpenTok Media Router:

// Set the following constants to your OpenTok API key and API secret.
// See https://tokbox.com/account/.
OpenTok sdk = new OpenTok(API_KEY, API_SECRET);
SessionProperties sessionProperties = new SessionProperties.Builder()
  .mediaMode(MediaMode.ROUTED)
  .build();
Session session = sdk.createSession(sessionProperties);
String sessionId = session.getSessionId();

Use the session ID in an OpenTok client library to connect to an OpenTok session.

You will also need to generate a token for each user connecting to the OpenTok session. See Connection Token Creation for information on the generateToken() method.

The OpenTok Media Router provides the following benefits:

Creating a relayed session

Here is Java sample code that creates a new session with the media mode set to relayed:

// Set the following constants to your OpenTok API key and API secret.
// See https://tokbox.com/account/.
OpenTok sdk = new OpenTok(API_KEY, API_SECRET);
Session session = sdk.createSession();
String sessionId = session.getSessionId();

In a relayed session, clients will attempt to send streams directly between each other. However, if clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay audio-video streams.

Important: Some features, such as archiving, are only available in routed (not relayed) sessions. See the previous section for instructions on creating a routed session.

Creating an automatically archived session

You can create a session that is automatically archived. Here is Java sample code that creates an automatically archived session:

Session session = opentok.createSession(new SessionProperties.Builder()
  .mediaMode(MediaMode.ROUTED)
  .archiveMode(ArchiveMode.ALWAYS)
  .build());
String sessionId = session.getSessionId();

Note that archived sessions must use the routed media mode.

For more information, see the archiving developer guide.

Using sessions in client applications

Use the session ID in an OpenTok client SDK to connect to an OpenTok session.

You will also need to generate a token for each user connecting to the OpenTok session. See Connection Token Creation for information on the generateToken() method.