AvayaWebRTCConnectSDK
AOVideoInteraction Class Reference

#import <AOVideoInteraction.h>

Inheritance diagram for AOVideoInteraction:
AOAbstractInteraction

Instance Methods

(void) - start
 
(void) - end
 
(void) - discard
 
(void) - muteAudio:
 
(void) - muteVideo:
 
(void) - holdWithCompletionHandler:
 
(void) - unholdWithCompletionHandler:
 
(void) - enableVideo:
 
(long) - getInteractionTimeElapsed
 
(void) - sendDTMF:
 
(AOInteractionState) - getInteractionState
 
(void) - readVideoDetailsWithCompletionHandler:
 
(void) - readAudioDetailsWithCompletionHandler:
 
(void) - readCallTypeWithCompletionHandler:
 
(void) - setPlatformType:
 
- Instance Methods inherited from AOAbstractInteraction
(id) - init
 
(void) - startCallQualityTimer
 
(void) - stopCallQualityTimer
 
(void) - sendCallQualityEvent:
 

Properties

NSString * authorizationToken
 
AOVideoDevicevideoDevice
 
id< AOVideoInteractionDelegatedelegate
 
id< AOConnectionListenerDelegateconnectionListenerDelegate
 
BOOL audioMuted
 
BOOL videoMuted
 
BOOL videoEnabled
 
BOOL held
 
NSString * destinationAddress
 

Additional Inherited Members

- Protected Attributes inherited from AOAbstractInteraction
NSDate * poorQualityStartTime
 
NSInteger previousMOSValue
 
NSTimer * timerCallQuality
 

Method Documentation

◆ discard

- (void) discard

Shutdown the SDK after the interaction has ended.

◆ enableVideo:

- (void) enableVideo: (BOOL)  enable

Enables or disables the interaction's video.

Parameters
enableThe new video state.

◆ end

- (void) end

End the active video interaction.

◆ getInteractionState

- (AOInteractionState) getInteractionState

Returns the current interaction state.

◆ getInteractionTimeElapsed

- (long) getInteractionTimeElapsed

Gets time elapsed of the current interaction.

◆ holdWithCompletionHandler:

- (void) holdWithCompletionHandler: (void(^)(NSError *))  handler

Hold active call

◆ muteAudio:

- (void) muteAudio: (BOOL)  mute

Mutes or unmutes the interaction's audio.

Parameters
muteThe new audio mute state.

◆ muteVideo:

- (void) muteVideo: (BOOL)  mute

Mutes or unmutes the interaction's video.

Parameters
muteThe new video mute state.

◆ readAudioDetailsWithCompletionHandler:

- (void) readAudioDetailsWithCompletionHandler: (void(^)(AOAudioDetails *audioDetails))  handler

Reads detailed information about the audio channel associated with the call.

If the audio channel has ended the audio details contain the information received from the channel just before it was ended.

Parameters
handlerA block to be called to with audio details in AOAudioDetails.

Implements AOAbstractInteraction.

◆ readCallTypeWithCompletionHandler:

- (void) readCallTypeWithCompletionHandler: (void(^)(NSString *csCallTypeString))  handler

Reads Call Type information associated with the call.

Parameters
handlerA block to be called to with Call Type in NSString.

◆ readVideoDetailsWithCompletionHandler:

- (void) readVideoDetailsWithCompletionHandler: (void(^)(AOVideoDetails *videoDetails))  handler

Reads list of AOVideoDetails objects representing details of all video streams in the interaction.

Parameters
handlerA block to be called to with video details in AOVideoDetails.

◆ sendDTMF:

- (void) sendDTMF: (AODTMFTone)  tone

Sends the specified DTMF tone.

Parameters
toneThe tone to transmit.

◆ setPlatformType:

- (void) setPlatformType: (AOPlatformType)  type

Set the platform types for the client configurations (Elite and Oceana)

Parameters
typean AOPlatformType to be passed to set the platform.

◆ start

- (void) start

Initiate a video interaction.

◆ unholdWithCompletionHandler:

- (void) unholdWithCompletionHandler: (void(^)(NSError *))  handler

Unhold active call

Property Documentation

◆ audioMuted

- (BOOL) audioMuted
readnonatomicassign

A Boolean value indicating whether audio has been explicitly muted for this interaction.

◆ authorizationToken

- (NSString*) authorizationToken
readwritenonatomicassign

Set the authorization token. The authorization token identifies the customer within Avaya Aura Web Gateway. This identity is used for the lifetime of the current interaction in Oceana.

◆ connectionListenerDelegate

- (id<AOConnectionListenerDelegate>) connectionListenerDelegate
readwritenonatomicweak

The delegate responsible for handling connection listener events.

◆ delegate

- (id<AOVideoInteractionDelegate>) delegate
readwritenonatomicassign

The delegate responsible for handling video interaction-related events.

◆ destinationAddress

- (NSString*) destinationAddress
readwritenonatomicstrong

The remote address for this interaction.

For SIP this is the unescaped URI of the remote end of the interaction.

◆ held

- (BOOL) held
readnonatomicassign

A Boolean value indicating whether call has been explicitly held for this interaction.

◆ videoDevice

- (AOVideoDevice*) videoDevice
readnonatomicassign

Returns a VideoDevice instance that provides media control services.

◆ videoEnabled

- (BOOL) videoEnabled
readnonatomicassign

A Boolean value indicating whether video has been explicity enabled for this interaction.

◆ videoMuted

- (BOOL) videoMuted
readnonatomicassign

A Boolean value indicating whether video has been explicitly muted for this interaction.


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