SMCallServiceDelegate Protocol Reference

Conforms to NSObject
Declared in SMCallServiceDelegate.h

  useManualAudio required method

If YES, MobileSDK will not initialize the audio unit automatically when an audio track is ready for playout or recording. Instead, applications should call setVoipAudioEnabled. If NO, MobileSDK will initialize the audio unit as soon as an audio track is ready for playout or recording. Default value is NO.

@property (nonatomic) BOOL useManualAudio

Availability

4.3.1

Discussion

If YES, MobileSDK will not initialize the audio unit automatically when an audio track is ready for playout or recording. Instead, applications should call setVoipAudioEnabled. If NO, MobileSDK will initialize the audio unit as soon as an audio track is ready for playout or recording. Default value is NO.

Declared In

SMCallServiceDelegate.h

  voipAudioEnabled required method

This property is only effective if useManualAudio is YES. Represents permission for MobileSDK to initialize the VoIP audio unit. When set to NO, if the VoIP audio unit used by MobileSDK is active, it will be stopped and uninitialized. This will stop incoming and outgoing audio. When set to YES, MobileSDK will initialize and start the audio unit when it is needed (e.g. due to establishing an audio connection). Default value is NO.

@property (nonatomic, getter=isVoipAudioEnabled) BOOL voipAudioEnabled

Availability

4.3.1

Discussion

This property is only effective if useManualAudio is YES. Represents permission for MobileSDK to initialize the VoIP audio unit. When set to NO, if the VoIP audio unit used by MobileSDK is active, it will be stopped and uninitialized. This will stop incoming and outgoing audio. When set to YES, MobileSDK will initialize and start the audio unit when it is needed (e.g. due to establishing an audio connection). Default value is NO.

Declared In

SMCallServiceDelegate.h

– setCallApplication: required method

Set the event handler CallApplicationDelegate for the CallService.

- (void)setCallApplication:(nonnull id<SMCallApplicationDelegate>)app

Parameters

app

CallApplicationDelegate

Availability

2.0.0

Declared In

SMCallServiceDelegate.h

– createOutGoingCall:andTerminator:completion: required method

This method is to create outgoing/mobile originated calls

- (void)createOutGoingCall:(nonnull id<SMCallApplicationDelegate>)app andTerminator:(nonnull SMUriAddress *)terminator completion:(nonnull void ( ^ ) ( id<SMOutgoingCallDelegate> _Nullable call , SMMobileError *_Nullable error ))callHandler

Parameters

app

delegete of application to return callbacks for call
terminator

address of callee
completion

block

Return Value

call to establish call

Availability

3.1.4

Declared In

SMCallServiceDelegate.h

– createOutGoingCall:withAccount:andOriginator:andTerminator:completion: required method

This method creates anonymous calls

- (void)createOutGoingCall:(nonnull id<SMCallApplicationDelegate>)app withAccount:(nonnull SMUriAddress *)account andOriginator:(nonnull SMUriAddress *)originator andTerminator:(nonnull SMUriAddress *)terminator completion:(nonnull void ( ^ ) ( id<SMOutgoingCallDelegate> _Nullable call , SMMobileError *_Nullable error ))callHandler

Parameters

app

delegete of application to return callbacks for call
account

address defining the anonymous account
originator

address defining the source of the call
terminator

address defining the destination of the call
completion

block

Return Value

call to establish call

Availability

4.5.9

Declared In

SMCallServiceDelegate.h

– createOutGoingCall:withAccountToken:andOriginatorToken:andTerminatorToken:andTokenRealm:completion: required method

This method creates anonymous calls with time-limited token

- (void)createOutGoingCall:(nonnull id<SMCallApplicationDelegate>)app withAccountToken:(nonnull NSString *)accountToken andOriginatorToken:(nonnull NSString *)originatorToken andTerminatorToken:(nonnull NSString *)terminatorToken andTokenRealm:(nonnull NSString *)tokenRealm completion:(nonnull void ( ^ ) ( id<SMOutgoingCallDelegate> _Nullable call , SMMobileError *_Nullable error ))callHandler

Parameters

app

delegete of application to return callbacks for call
accountToken

encrypted address defining the anonymous account
originatorToken

encrypted address defining the source of the call
terminatorToken

encrypted address defining the destination of the call
tokenRealm

the realm used to encrypt the tokens
completion

block

Return Value

call to establish call

Availability

4.5.9

Declared In

SMCallServiceDelegate.h

– rotateCameraOrientationToPosition: required method

Rotates camera to specified orientation

- (void)rotateCameraOrientationToPosition:(AVCaptureVideoOrientation)orientation

Parameters

orientation

AVCaptureVideoOrientation value that will be used for camera orientation

Availability

2.0.0

Declared In

SMCallServiceDelegate.h

– getActiveCalls required method

Returns the active call objects.

- (nonnull NSArray<id<SMCallDelegate> > *)getActiveCalls

Return Value

Immutable call list

Availability

4.0

Discussion

Returns the active call objects.

Declared In

SMCallServiceDelegate.h