Skip to main content
Paid plans only stopLiveStreaming(options?) Requires the initiating participant to be an owner or streaming admin (a participant with 'streaming' in their canAdmin permission). If multiple RTMP endpoints are being live streamed, calling stopLiveStreaming() will stop all live streams. To remove specific endpoints without ending the stream, use removeLiveStreamingEndpoints(). If multiple instances are running, each must be stopped individually with its instanceId.

​
Parameters

​
instanceId
string
The UUID of the streaming instance to stop. Omit to stop the default instance.

​
Return value

Returns void. Listen for live-streaming-stopped to confirm the stream has ended.

​
Example

// Stop the default stream
call.stopLiveStreaming();

// Stop a specific instance
call.stopLiveStreaming({ instanceId: 'my-instance-id' });

​
See also

Types

Methods

Events

Guides

REST API