VIRemoteVideoStream
Interface that represents remote video streams.
Extends VIVideoStream 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.
Props
height
height: Current frame height of the video stream.
Returns
type:
NSUInteger
isReceiving
isReceiving: Whether the video stream is receiving video.
Valid only for conferences.
Returns
type:
BOOL
width
width: Current frame width of the video stream.
Returns
type:
NSUInteger
Methods
requestVideoSizeWithWidth:height:
requestVideoSizeWithWidth:height:(width: NSUInteger
, height: NSUInteger
): void
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:
NSUInteger
Requested width of the video stream
height:
NSUInteger
Requested height of the video stream
Returns
type:
void
startReceiving
startReceiving(): void
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, [VIEndpointDelegate endpoint:didStartReceivingVideoStream:] event is invoked.
Returns
type:
void
stopReceiving
stopReceiving(): void
Stops receiving video on the remote video stream. Available only for the conference calls.
If the request is processed successfully, [VIEndpointDelegate endpoint:didStopReceivingVideoStream:reason:] event is invoked with the reason VIVideoStreamReceiveStopReasonManual
Returns
type:
void