1. References
  2. IOS SDK
  3. call
  4. VIEndpointDelegate
Rate this page:

VIEndpointDelegate

Delegate that may be used to handle the endpoint events.

Methods

didDetectVoiceActivityStart:

Optional
Copy URL
- (
void
)didDetectVoiceActivityStart:(
VIEndpoint *
)endpoint

Triggered when a voice activity of the endpoint is detected in a conference call.

Parameters

  • endpoint:

    VIEndpoint *

    Endpoint that triggered this event

Returns

  • type:

    void

didDetectVoiceActivityStop:

Optional
Copy URL
- (
void
)didDetectVoiceActivityStop:(
VIEndpoint *
)endpoint

Triggered when a voice activity of the endpoint is stopped in a conference call.

Parameters

  • endpoint:

    VIEndpoint *

    Endpoint that triggered this event

Returns

  • type:

    void

endpoint:didAddRemoteVideoStream:

Optional
Copy URL
- (
void
)endpoint:(
VIEndpoint *
)endpoint 
    didAddRemoteVideoStream:(
VIRemoteVideoStream *
)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

Returns

  • type:

    void

endpointDidRemove:

Optional
Copy URL
- (
void
)endpointDidRemove:(
VIEndpoint *
)endpoint

Triggered after the endpoint is removed from a call. Event is not triggered on the call end.

Parameters

  • endpoint:

    VIEndpoint *

    Endpoint that has been removed from the a call

Returns

  • type:

    void

endpoint:didRemoveRemoteVideoStream:

Optional
Copy URL
- (
void
)endpoint:(
VIEndpoint *
)endpoint 
    didRemoveRemoteVideoStream:(
VIRemoteVideoStream *
)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

Returns

  • type:

    void

endpoint:didStartReceivingVideoStream:

Optional
Copy URL
- (
void
)endpoint:(
VIEndpoint *
)endpoint 
    didStartReceivingVideoStream:(
VIRemoteVideoStream *
)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:

  1. [VIRemoteVideoStream startReceiving] has been called and the request has been processed successfully.
  2. 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

Returns

  • type:

    void

endpoint:didStopReceivingVideoStream:reason:

Optional
Copy URL
- (
void
)endpoint:(
VIEndpoint *
)endpoint 
    didStopReceivingVideoStream:(
VIRemoteVideoStream *
)videoStream 
                         reason:(
VIVideoStreamReceiveStopReason
)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:

  1. [VIRemoteVideoStream stopReceiving] has been called and the request has been processed successfully. In this case the value of the "reason" parameter is VIVideoStreamReceiveStopReasonManual
  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 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

Returns

  • type:

    void

endpointInfoDidUpdate:

Optional
Copy URL
- (
void
)endpointInfoDidUpdate:(
VIEndpoint *
)endpoint

Triggered when endpoint information such as display name, user name and sip uri is updated.

Parameters

  • endpoint:

    VIEndpoint *

    Endpoint which information is updated

Returns

  • type:

    void