Have you explored the newest version of the OpenTok platform? Check out OpenTok 2.0, built on top of WebRTC. Learn more

Capabilities class

A class defining properties of the capabilities property of the Session class. See Session.capabilites.

Capabilities properties

The Capabilities class includes the following properties:

forceUnpublish (Number) — Specifies whether you can call the Session.forceUnpublish() method. To call the Session.forceUnpublish() method, the user must have a token that is assigned the role of moderator.

playback (Number) — If set to 1, the client can play back archives (by calling the Archive.startPlayback() method or the RecorderManager.displayPlayer() method). If set to 0, the client cannot play back archives. Currently, this property is set to 1 only if the client is assigned a token with a moderator role.

publish (Number) — Specifies whether you can publish to the session (1) or not (0). The ability to publish is based on a few factors. To publish, the user must have a token that is assigned a role that supports publishing. There must be a connected camera and microphone. Also, the client environment must support publishing. (Currently, publishing is not supported when running in the browser on Android OS.)

publishH264 (Boolean) — Specifies whether you can publish h.264 video (true) or not (false). You should check this property if your app needs to support the OpenTok iOS SDK, which supports h.264 video only.

record (Number) — If set to 1, the client can record archives (by calling the RecorderManager.displayRecorder() method, the Session.startRecording() method, or the Stream.startRecording() method). If set to 0, the client cannot record archives. Currently, this property is set to 1 only if the client is assigned a token with a moderator role.

subscribe (Number) — Specifies whether you can subscribe to streams in the session (1) or not (0). Currently, this capability is available for all users on all platforms.

See

IRC Live Chat

Have a quick question? Chat with TokBox Support on IRC. Join chat