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