VIEndpointDelegate
Delegate that may be used to handle endpoint events.
Methods
didDetectVoiceActivityStart:
- (void
)didDetectVoiceActivityStart:()endpoint Invoked when a voice activity of the endpoint is detected in a conference call.
Parameters
endpoint:
The endpoint that triggered this event.
Returns
type:
void
didDetectVoiceActivityStop:
- (void
)didDetectVoiceActivityStop:()endpoint Invoked when a voice activity of the endpoint is stopped in a conference call.
Parameters
endpoint:
The endpoint that triggered this event.
Returns
type:
void
endpoint:didAddRemoteVideoStream:
- (void
)endpoint:()endpoint
didAddRemoteVideoStream:()videoStream Triggered after endpoint added video stream to the call.
Triggered always on the main thread, even if delegateQueue (set in [VIClient initWithDelegateQueue:]) is not the main thread.
Parameters
endpoint:
The endpoint that triggered this event.
videoStream:
The remote video stream added to the call.
Returns
type:
void
endpointDidRemove:
- (void
)endpointDidRemove:()endpoint Invoked after the endpoint is removed from a call. Event is not triggered on call end.
Parameters
endpoint:
The endpoint that has been removed from the a call
Returns
type:
void
endpoint:didRemoveRemoteVideoStream:
- (void
)endpoint:()endpoint
didRemoveRemoteVideoStream:()videoStream Triggered after endpoint removed video stream from the call.
Triggered always on the main thread, even if delegateQueue (set in [VIClient initWithDelegateQueue:]) is not the main thread.
Parameters
endpoint:
Endpoint that triggered this event.
videoStream:
Remote video stream removed from the call.
Returns
type:
void
endpoint:didStartReceivingVideoStream:
- (void
)endpoint:()endpoint
didStartReceivingVideoStream:()videoStream Triggered when video receive on a remote video stream is started after previously being stopped. Available only for the conference calls.
The event is triggered if:
- [VIRemoteVideoStream startReceiving] was called and the request has been processed successfully.
- A network issue that caused the Voximplant Cloud to stop video receive of the remote video stream is gone.
The event is not triggered if the endpoint client has started sending video using [VICall setSendVideo:completion:] API.
Parameters
endpoint:
The endpoint that triggered this event.
videoStream:
The remote video stream where video receive is started
Returns
type:
void
endpoint:didStopReceivingVideoStream:reason:
- (void
)endpoint:()endpoint
didStopReceivingVideoStream:()videoStream
reason:()reason Triggered when 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:
- [VIRemoteVideoStream stopReceiving] was called and the request has been processed successfully. In this case the value of the "reason" parameter is VIVideoStreamReceiveStopReasonManual
- 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 VIVideoStreamReceiveStopReasonAutomatic
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 [VIEndpointDelegate endpoint:didStartReceivingVideoStream:] event will be invoked.
The event is not triggered if the endpoint client has stopped sending video using [VICall setSendVideo:completion:] API.
Parameters
endpoint:
The endpoint that triggered this event.
videoStream:
The remote video stream where video receive is stopped
The reason for the event, such as video receive is disabled by client or automatically
Returns
type:
void
endpointInfoDidUpdate:
- (void
)endpointInfoDidUpdate:()endpoint Invoked when endpoint information such as display name, user name and sip uri is updated.
Parameters
endpoint:
Endpoint which information is updated.
Returns
type:
void