Rate this page:

IRemoteVideoStream

Interface that represents remote video streams.

Extends IVideoStream which provides functionality to add or remove video renderers.

For conference calls it also provides additional functionality to start or stop receiving video from the stream and to request video in another size.

Methods

getFrameHeight

Copy URL

int

getFrameHeight()

The current frame height of the video stream.

Returns

  • type:

    int

getFrameWidth

Copy URL

int

getFrameWidth()

The current frame width of the video stream.

Returns

  • type:

    int

isReceiving

Copy URL

boolean

isReceiving()

Indicates if the video stream is receiving video.

Valid only for conferences.

Returns

  • type:

    boolean

requestVideoSize

Copy URL

void

requestVideoSize(

int

width,

int

height
)

Requests the specified video size for the video stream.

The stream resolution may be changed to the closest to the specified width and height.

Valid only for conferences.

Parameters

  • width:

    int

    Requested width of the video stream

  • height:

    int

    Requested height of the video stream

Returns

  • type:

    void

startReceiving

Copy URL

void

startReceiving()

Starts receiving video on the remote video stream. Available only for the conference calls.

If the video is already receiving, this method call is ignored.

If the request is processed successfully, IEndpointListener.onStartReceivingVideoStream(IEndpoint, IRemoteVideoStream) event will be invoked.

Returns

  • type:

    void

stopReceiving

Copy URL

void

stopReceiving()

Stops receiving video on the remote video stream. Available only for the conference calls.

If the request is processed successfully, IEndpointListener.onStopReceivingVideoStream(IEndpoint, IRemoteVideoStream, VideoStreamReceiveStopReason) event will be invoked with the reason VideoStreamReceiveStopReason.MANUAL

Returns

  • type:

    void