pause

This method can be used to pause a remote participant's stream.

Pausing a stream stops receiving media data from the server for this stream, reducing bandwidth usage. The stream remains logically active but no media is delivered until resume is called.

Note: This is only applicable to streams received from remote participants (consumer streams).

Events:

• onStreamPaused — triggered when the stream is paused

Code Example:

// Pause a remote participant's video stream
for ((_, stream) in participant.streams) {
    if (stream.kind.equals("video", ignoreCase = true)) {
        stream.pause()
    }
}

See also