Namespace BroadcastStreamingClient

The client of broadcast streaming

Index

Functions

Functions

getBroadcastStreamingStatus

getBroadcastStreamingStatus(): { channelId: string; status: BroadcastStreamingStatus }

Get the broadcast streaming status.

since
2.2.5

Returns { channelId: string; status: BroadcastStreamingStatus }
- channelId: string
  
  Channel ID
- status: BroadcastStreamingStatus
  
  Status of broadcast streaming

isBroadcastStreamingEnable

isBroadcastStreamingEnable(): boolean

Is broadcast streaming enabled.

since
2.2.5

Returns boolean

startBroadcast

startBroadcast(): ExecutedResult | Promise<string>

Start broadcast streaming

since
2.2.5

Returns ExecutedResult | Promise<string>

stopBroadcast

stopBroadcast(channelId?: string): ExecutedResult | Promise<string>

Stop broadcast streaming

since
2.2.5

Parameters
- Optional channelId: string
  
  Optional. Required only if the original host started the broadcast and then transferred the host role to another user. In this case, the new host needs to provide the channelId to stop the broadcast.
Returns ExecutedResult | Promise<string>