SMCallDelegate Protocol Reference

Conforms to NSObject
Declared in SMCallDelegate.h

  callerAddress required method

Address of the user who starts call

@property (strong, nonatomic, nonnull) SMUriAddress *callerAddress

Availability

2.0.0

Declared In

SMCallDelegate.h

  calleeAddress required method

Address of the user who is being called

@property (strong, nonatomic, nonnull) SMUriAddress *calleeAddress

Availability

2.0.0

Declared In

SMCallDelegate.h

  callerName required method

Name of the user who starts call

@property (strong, nonatomic, nullable) NSString *callerName

Availability

2.0.0

Declared In

SMCallDelegate.h

  calleeName required method

Name of the user who receives the call

@property (strong, nonatomic, nullable) NSString *calleeName

Availability

4.5.9

Declared In

SMCallDelegate.h

  localVideoView required method

Holds video view which retrieved from local camera Should be linked with GUI object which is a UIView

@property (strong, nonatomic, nullable) UIView *localVideoView

Availability

2.0.0

Declared In

SMCallDelegate.h

  remoteVideoView required method

Holds video view which received from remote participant of call Should be linked with GUI object which is a UIView

@property (strong, nonatomic, nullable) UIView *remoteVideoView

Availability

2.0.0

Declared In

SMCallDelegate.h

– endCall required method

Perform end operation on the call.

- (void)endCall

Availability

2.0.0

Declared In

SMCallDelegate.h

– endCallWithReason: required method

Perform end operation with end reason on the call.

- (void)endCallWithReason:(NSString *_Nullable)reason

Parameters

reason

reason which specifies why call ended (Reason text character size shouldn’t be larger than 600)

Availability

4.4.1

Declared In

SMCallDelegate.h

– mute required method

Puts the speaker (microphone) into (in) mute

- (void)mute

Availability

2.0.0

Declared In

SMCallDelegate.h

– unMute required method

Resumes the speaker

- (void)unMute

Availability

2.0.0

Declared In

SMCallDelegate.h

– videoUnMute required method

Starts the local video unmute The video unmute for the active call. The call should be a video call and it should be disabled previously. Otherwise, SDK will return an error

- (void)videoUnMute

Availability

6.6.0

Declared In

SMCallDelegate.h

– videoMute required method

Stops the local video track The video mute for the active call. The call should be a video call and it should be enabled previously. Otherwise, SDK will return an error

- (void)videoMute

Availability

6.6.0

Declared In

SMCallDelegate.h

– videoStop required method

Stops the video for the call

- (void)videoStop

Availability

2.0.0

Declared In

SMCallDelegate.h

– videoStart required method

Starts the video for the call

- (void)videoStart

Availability

2.0.0

Declared In

SMCallDelegate.h

– holdCall required method

Perform hold operation on this call

- (void)holdCall

Availability

2.0.0

Declared In

SMCallDelegate.h

– unHoldCall required method

Perform un-hold (resume) operation on this call

- (void)unHoldCall

Availability

2.0.0

Declared In

SMCallDelegate.h

– sendCustomParameters: required method

Sends the given custom SIP headers to SPiDR server.

- (void)sendCustomParameters:(NSDictionary *_Nullable)customParameters

Parameters

customParameters

key-value pairs of custom SIP headers to send

Availability

4.5.0

Declared In

SMCallDelegate.h

– setCustomParameters: required method

Sets given custom SIP Headers as custom parameters to call in order to send them in all mid-call event requests.

- (void)setCustomParameters:(NSDictionary *_Nullable)customParameters

Parameters

customParameters

key-value pairs of custom SIP headers to send

Availability

4.5.0

Declared In

SMCallDelegate.h

– getCustomParameters required method

Gets custom SIP Headers which are set to the Call as custom parameters to call in order to send them in all mid-call event requests.

- (NSDictionary *_Nullable)getCustomParameters

Return Value

customParameters key-value pairs of custom SIP headers to send

Availability

4.5.0

Declared In

SMCallDelegate.h

– transferCall: required method

Method used by the application to transfer this call to another endpoint.

- (void)transferCall:(SMUriAddress *_Nonnull)newAddress

Parameters

newAddress

address of the endpoint to replace this endpoint in the call

Availability

2.0.0

Declared In

SMCallDelegate.h

– consultativeTransfer: required method

Transfers the current call to the transfer target given with another call session in a consultative transfer manner.

- (void)consultativeTransfer:(id<SMCallDelegate> _Nonnull)call

Parameters

call

other call session as transfer target

Availability

4.5.1

Declared In

SMCallDelegate.h

– sendDTMF: required method

Inserts Dual Tone Multi Frequency Signal to sending queue and returns the success

- (BOOL)sendDTMF:(char)tone

Parameters

tone

character value of DTMF tone. Can only be 0,1…,9,*,#,a,b,c,d,A,B,C,D;

Return Value

YES if tone can be successfully inserted to queue otherwise NO

Availability

3.0.1

Declared In

SMCallDelegate.h

– setCaptureDevice:withVideoResolution:completionHandler: required method

Sets device capture and video resolution to specified position and resolution of the related call. If nil resolution value is provided then resotion value in configuration will be used. If resolution in configuration is set to nil default VGA (640x480) value will be set.

If a resolution value is not suitable to camera session then camera will not be changed and handler will be triggered with an error

- (void)setCaptureDevice:(AVCaptureDevicePosition)position withVideoResolution:(NSString *_Nonnull)videoResolution completionHandler:(void ( ^ _Nullable ) ( SMMobileError *_Nullable error ))handler

Parameters

position

AVCaptureDevicePosition of the camera which will be used
videoResolution

that intended to resolution
handler

that returns error

Availability

2.0.0 @modified 4.0.2

Declared In

SMCallDelegate.h

– setExternalVideoSource:completionHandler: required method

Allow applications to set image buffers as external video source.

SDK can transmit any image to remote peer if application uses this API. Applications that want to use this API should set setVideoSourceType to EXTERNAL_VIDEO

- (void)setExternalVideoSource:(CVImageBufferRef _Nullable)imageBuffer completionHandler:(void ( ^ _Nullable ) ( SMMobileError *_Nullable error ))handler

Parameters

imageBuffer

will be converted to RTCVideoFrame
handler

that returns error

Availability

6.4.0

Declared In

SMCallDelegate.h

– getCallId required method

Returns callId that related with SIP session id For the outgoing call, this value is not set until establish call is succeeded

- (nonnull NSString *)getCallId

Return Value

callId unique identifier of call that related SIP session

Availability

2.0.0

Declared In

SMCallDelegate.h

– getCallState required method

Retrieve state of the call.

- (nonnull SMCallState *)getCallState

Return Value

CallStates state of the call

Availability

2.0.0

Declared In

SMCallDelegate.h

– getMediaAttributes required method

Retrieve media attributes of the call.

- (nonnull SMMediaAttributes *)getMediaAttributes

Return Value

MediaAttributes attributes of the call’s media

Availability

2.0.0 @modified 4.0.1

Declared In

SMCallDelegate.h

– isMute required method

Tests if the call is in muted state

- (BOOL)isMute

Return Value

YES if call is muted otherwise NO

Availability

2.0.0

Declared In

SMCallDelegate.h

– canReceiveVideo required method

Indicates remote side can send video or not. Local side can receive video if he wishes. It is determined by Remote Session Description direction as follows

sendrecv sendonly recvonly inactive
Values true true false false
- (BOOL)canReceiveVideo

Return Value

BOOL

Availability

2.0.0

Declared In

SMCallDelegate.h

– canSendVideo required method

Indicates remote side can receive video or not. Local side can send video if he wishes. It is determined by Remote Session Description direction as follows

sendrecv sendonly recvonly inactive
Values true false true false
- (BOOL)canSendVideo

Return Value

BOOL

Availability

2.0.0

Declared In

SMCallDelegate.h

– getActiveCamera required method

Gets last camera position set. If camera is not active last active camera position will be returned.

- (AVCaptureDevicePosition)getActiveCamera

Return Value

AVCaptureDevicePosition position of the current active camera

Availability

2.0.0

Declared In

SMCallDelegate.h

– getCameraResolution required method

Gets last camera resolution set. Value can return nil if method is called before camera allocation.

- (nullable NSString *)getCameraResolution

Return Value

NSString camera resolution of the current active camera

Availability

4.0.2

Declared In

SMCallDelegate.h

– getRTPStatistics: required method

Gets RTP/RTP Statistics for related call

- (void)getRTPStatistics:(void ( ^ _Nonnull ) ( NSString *_Nullable statistics ))completion

Parameters

completion

Completion Block

Return Value

array which contains RTP/RTCP Statistics as JSON formatted String

Availability

3.1.4

Declared In

SMCallDelegate.h

– Id required method

Gets id value of call

- (nonnull NSString *)Id

Return Value

Id which is not related with Spidr Session Id

Availability

4.2.1.1

Declared In

SMCallDelegate.h

– getAvailableCodecs: required method

Returns the list of available and supported codecs

- (NSArray<NSDictionary*> *)getAvailableCodecs:(SMCodecType)codecType

Parameters

codecType

the codec type

Return Value

the list of available codecs

Availability

5.17.0

Declared In

SMCallDelegate.h

– setVideoSourceType: required method

Allows applications to set VideoSourceTypes.

MobileSDK supports multiple video source types. CAMERA is the default video source type. Alternatively, applications can select EXTERNAL_VIDEO and insert video frames as their desire. If EXTERNAL_VIDEO is chosen as the video source type, application must provide frames by using setExternalVideoSource API.

- (void)setVideoSourceType:(SMVideoSourceTypes)videoSourceType

Parameters

videoSourceType

videoSourceType enum

Availability

6.4.0

Declared In

SMCallDelegate.h