Interface IJoinOptions

Options for joining the channel.

Since
   4.24.0

Hierarchy

  • IJoinOptions

Index

Properties

Optional autoReceiveAndPlayAudio

autoReceiveAndPlayAudio: boolean

Whether to automatically receive and try to play remote audio when joining the channel.

  • true: Yes
  • false: (Default) No

After setting this parameter as true, the SDK automatically receives and tries to play remote audio when the user joins the channel, reducing the waiting time before remote audio is heard.

This feature applies to scenarios such as voice chat rooms and online meetings where users need to hear audio as soon as possible after joining the channel, live streaming audience scenarios where receiving audio in the channel is required by default, and scenarios that require a faster first frame of remote audio.

Note: Due to browser autoplay policies, the first audio playback on a page may still require the user to click or touch the page.

Since
   4.24.6

Optional autoSubscribe

autoSubscribe: boolean

Whether to automatically subscribe to the media stream of the broadcaster.

  • true: Yes
  • false: (Default) No

In one-to-one or one-to-more real-time engagement scenarios, setting this parameter as true reduces the time duration for rendering the first video frame of the broadcaster.

Note: Once you set autoSubscribe as true, the server will start streaming media once the user joins the channel, and billing will begin.