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

SubscriberProperties class

An object defining properties of the properties parameter of the Session.subscribe() method. See Session.subscribe().

SubscriberProperties properties

The SubscriberProperties class includes the following properties:

audioEnabled (String) — The desired audio state when the Subscriber is first opened (default: true).

audioVolume (Number) — The desired audio volume, between 0 and 100, when the Subscriber is first opened (default: 50).

styles (Object) — Includes the following properties:

  • buttonDisplayMode (String) — How to display the speaker controls. Possible values are: "auto" (controls are displayed when the stream is first displayed and when the user mouses over the display), "off" (controls are not displayed), and "on" (controls are displayed).
  • nameDisplayMode (String) — Whether to display the stream name. Possible values are: "auto" (the name is displayed when the stream is first displayed and when the user mouses over the display), "off" (the name is not displayed), and "on" (the name is displayed).

See

IRC Live Chat

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