Rate this page:

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

Copy URL
@property (assign, readonly, nonatomic) 

NSUInteger

height

The current frame height of the video stream.

Returns

  • type:

    NSUInteger

isReceiving

Copy URL
@property (assign, readonly, nonatomic) 

BOOL

isReceiving

Indicates if the video stream is receiving video.

Valid only for conferences.

Returns

  • type:

    BOOL

width

Copy URL
@property (assign, readonly, nonatomic) 

NSUInteger

width

The current frame width of the video stream.

Returns

  • type:

    NSUInteger

Methods

requestVideoSizeWithWidth:height:

Copy URL
- (

void

)requestVideoSizeWithWidth:(

NSUInteger

)width
height:(

NSUInteger

)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:

    NSUInteger

    Requested width of the video stream

  • height:

    NSUInteger

    Requested height of the video stream

Returns

  • type:

    void

startReceivingWithCompletion:

Copy URL
- (

void

)startReceivingWithCompletion:(

nullable VICompletionBlock

)completion

Starts receiving video on the video stream.

Valid only for conferences.

Parameters

  • completion:

    nullable VICompletionBlock

    Completion block to handle the result of operation.

Returns

  • type:

    void

stopReceivingWithCompletion:

Copy URL
- (

void

)stopReceivingWithCompletion:(

nullable VICompletionBlock

)completion

Stops receiving video on the video stream.

Valid only for conferences.

Parameters

  • completion:

    nullable VICompletionBlock

    Completion block to handle the result of operation.

Returns

  • type:

    void