AvayaWebRTCConnectSDK
<AOVideoInteractionDelegate> Protocol Reference

#import <AOVideoInteraction.h>

Inheritance diagram for <AOVideoInteractionDelegate>:

Instance Methods

(void) - interactionInitiating
 
(void) - interactionRemoteAlerting
 
(void) - interactionActive
 
(void) - interactionEnded
 
(void) - interactionFailed:
 
(void) - interactionAudioMuteStatusChanged:
 
(void) - interactionVideoMuteStatusChanged:
 
(void) - interactionVideoEnabledStatusChanged:
 
(void) - discardComplete
 
(void) - holdComplete
 
(void) - unholdComplete
 
(void) - remoteHoldComplete
 
(void) - remoteUnholdComplete
 
(void) - onInteractionQualityChanged:
 
(void) - onInteractionVideoMuteStatusChanged:
 
(void) - onInteractionVideoDisabledBelowThreshold:
 
(void) - onInteractionVideoCanBeEnabledThresholdCrossed:
 

Detailed Description

Describes methods that are implemented by the delegate of AOVideoInteractionDelegate.

Method Documentation

◆ discardComplete

- (void) discardComplete

Sent when the interaction has finished discarding.

◆ holdComplete

- (void) holdComplete

Sent when the interaction has held.

◆ interactionActive

- (void) interactionActive

Sent when the outgoing interaction has been established.

◆ interactionAudioMuteStatusChanged:

- (void) interactionAudioMuteStatusChanged: (BOOL)  isMuted

Sent when the interaction's audio is muted or unmuted.

Parameters
isMutedThe new audio mute state.

◆ interactionEnded

- (void) interactionEnded

Sent when the interaction has ended.

◆ interactionFailed:

- (void) interactionFailed: (NSError *)  error

Sent when the interaction has failed.

Parameters
errorAn error object describing the failure.

◆ interactionInitiating

- (void) interactionInitiating

Sent when the outgoing interaction is requesting a session from the Avaya Mobile Communications snap-in.

◆ interactionRemoteAlerting

- (void) interactionRemoteAlerting

Sent when the outgoing interaction begins alerting at the remote end.

In SIP this corresponds to the interaction receiving a 180 or 183 response from the network. It should be noted that this method may be sent multiple times during initiating an interaction as a result of changes to early media availability and/or redirections. Application developers should not make assumptions about exact ordering of provisional responses, as the sequence depends on different call routing features/topologies.

◆ interactionVideoEnabledStatusChanged:

- (void) interactionVideoEnabledStatusChanged: (BOOL)  isEnabled

Sent when the interaction's video is enabled or disabled.

Parameters
isEnabledThe new video state.

◆ interactionVideoMuteStatusChanged:

- (void) interactionVideoMuteStatusChanged: (BOOL)  isMuted

Sent when the interaction's video is muted or unmuted.

Parameters
isMutedThe new video mute state.

◆ onInteractionQualityChanged:

- (void) onInteractionQualityChanged: (AOCallQuality)  quality

Called when a interaction's quality state changes

Parameters
qualityAOCallQuality representing quality of the call

◆ onInteractionVideoCanBeEnabledThresholdCrossed:

- (void) onInteractionVideoCanBeEnabledThresholdCrossed: (AOCallQuality)  quality

Called when a interaction's video can be enabled in case the bandwidth is equivalent or above the threshold value when disableVideoInLowBandwidth() has been set to true with AOCallQuality threshold value in VideoInteraction object.

Parameters
qualityCurrent AOCallQuality value

◆ onInteractionVideoDisabledBelowThreshold:

- (void) onInteractionVideoDisabledBelowThreshold: (AOCallQuality)  quality

Called when a interaction's video is disabled in case of bandwidth going below the threshold level. This event will only be triggered when disableVideoInLowBandwidth() has been set to true with AOCallQuality threshold value in VideoInteraction object.

Parameters
qualityCurrent AOCallQuality value

◆ onInteractionVideoMuteStatusChanged:

- (void) onInteractionVideoMuteStatusChanged: (BOOL)  state

Called when a interaction's video mute state changes

Parameters
statetrue when video has been muted, false when video is active

◆ remoteHoldComplete

- (void) remoteHoldComplete

Sent when the interaction is on remotely hold

◆ remoteUnholdComplete

- (void) remoteUnholdComplete

Sent when the interaction has remotely unheld.

◆ unholdComplete

- (void) unholdComplete

Sent when the interaction has unheld.


The documentation for this protocol was generated from the following file: