VIStopReceivingVideoStream typedef

VIStopReceivingVideoStream = void Function(VIEndpoint endpoint, VIVideoStream videoStream, VIVideoStreamReceiveStopReason reason)

Signature for callbacks reporting that video receive on a remote video stream is stopped. Available only for the conference calls.

Video receive on a remote video stream can be stopped due to:

1. VIEndpoint.stopReceiving was called and the request has been processed successfully. In this case the value of the reason parameter is VIVideoStreamReceiveStopReason.MANUAL. 2.Voximplant Cloud has detected a network issue on the client and automatically stopped the video. In this case the value of the reason parameter is VIVideoStreamReceiveStopReason.AUTOMATIC.

If the video receive is disabled automatically, it may be automatically enabled as soon as the network condition on the device is good and there is enough bandwidth to receive the video on this remote video stream. In this case event will be invoked.

The event is not triggered if the endpoint client has started sending video using VICall.sendVideo API.

Used in VIEndpoint.

endpoint - VIEndpoint instance initiated the event

videoStream - The remote video stream where video receive is stopped

reason - The reason for the event, such as video receive is disabled by client or automatically

Implementation

typedef void VIStopReceivingVideoStream(VIEndpoint endpoint,
    VIVideoStream videoStream, VIVideoStreamReceiveStopReason reason);