RemoteVideo

The RemoteVideo model allows the local participant to locally start and stop remote participants` video streams transmission.

This model is supported only in SDK 3.7 and later.

Methods

start

start(participant: Participant): Promise<void>

If the local participant used the stop method to stop receiving video streams from selected remote participants, the start method allows the participant to start receiving video streams from these participants. The start method does not impact the video transmission between remote participants and a conference and does not allow the local participant to force sending remote participants’ streams to the conference or to the local participant.

The start method requires a few seconds to become effective.

Example:

var someRemoteParticipant = ...
 
await VoxeetSDK.video.remote.start(someRemoteParticipant);

Parameters:

NameTypeDescription
participantParticipantThe selected remote participants whose video streams the local participant would like to receive.

Returns: Promise<void> A Promise which resolves when the remote video is successfully started. If the remote video cannot be started, the promise is rejected with the VideoServiceError.


stop

stop(participant: Participant): Promise<void>

Allows the local participant to stop receiving video from specific remote participants. This method does not impact audio transmission between remote participants and a conference and does not allow the local participant to stop sending remote participants’ streams to the conference.

The stop method requires a few seconds to become effective.

Example:

var someRemoteParticipant = ...
 
await VoxeetSDK.video.remote.stop(someRemoteParticipant);

Parameters:

NameTypeDescription
participantParticipantThe selected remote participants whose video streams the local participants wouldn't like to receive.

Returns: Promise<void> A Promise which resolves when the remote video is successfully stopped. If the remote video cannot be stopped, the promise is rejected with the VideoServiceError.