SINCallClient

Objective-C

@protocol SINCallClient <NSObject>

Swift

protocol SINCallClient : NSObjectProtocol

SINCallClient provides the entry point to the calling functionality of the Sinch SDK. A SINCallClient can be acquired via SINClient.

Important

Thread safety notes: All interaction should be done on main thread/main GCD queue.

Example:


id<SINClient> sinchClient;
[sinchClient start];
...

// Place outgoing call.
id<SINCallClient> callClient = [sinchClient callClient];
id<SINCall> call = [callClient callUserWithId:@"<REMOTE USERID>"];

// Set the call delegate that handles all the call state changes
call.delegate= ... ;

// ...

// Hang up the call
[call hangup];

delegate
The object that acts as the delegate of the call client.

The delegate object handles call state change events and must adopt the SINCallClientDelegate protocol.

See
SINCallClientDelegate
Declaration
Objective-C

@property (nonatomic, weak, readwrite) id<SINCallClientDelegate> delegate;
Swift

weak var delegate: SINCallClientDelegate! { get set }


                    
                    
                    -callUserWithId:

Make a call to the user with the given id.

See

-[SINClientDelegate clientDidStart:]

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (id<SINCall>)callUserWithId:(NSString *)userId;

Parameters


                                userId

The application specific id of the user to call.

Return Value

SINCall Outgoing call


                    
                    
                    -callUserWithId:headers:

Calls the user with the given id and the given headers.

See

-[SINClientDelegate clientDidStart:]

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (id<SINCall>)callUserWithId:(NSString *)userId
                      headers:(NSDictionary *)headers;

Parameters

`userId`	The application specific id of the user to call.
`headers`	NSString key-value pairs to pass with the call. The total size of header keys + values (when encoded with NSUTF8StringEncoding) must not exceed 1024 bytes. The call will fail immediately in case of invalid headers.

Return Value

SINCall Outgoing call


                    
                    
                    -callUserVideoWithId:

Make a video call to the user with the given id

See

-[SINClientDelegate clientDidStart:]

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (id<SINCall>)callUserVideoWithId:(NSString *)userId;

Parameters


                                userId

The application specific id of the user to call.

Return Value

SINCall Outgoing call


                    
                    
                    -callUserVideoWithId:headers:

Make a video call to the user with the given id and the give headers

See

-[SINClientDelegate clientDidStart:]

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (id<SINCall>)callUserVideoWithId:(NSString *)userId
                           headers:(NSDictionary *)headers;

Parameters

`userId`	The application specific id of the user to call.
`headers`	NSString key-value pairs to pass with the call. The total size of header keys + values (when encoded with NSUTF8StringEncoding) must not exceed 1024 bytes. The call will fail immediately in case of invalid headers.

Return Value

SINCall Outgoing call


                    
                    
                    -callPhoneNumber:

Calls a phone number and terminates the call to the PSTN-network (Publicly Switched Telephone Network).

See

-[SINClientDelegate clientDidStart:]

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (id<SINCall>)callPhoneNumber:(NSString *)phoneNumber;

Parameters


                                phoneNumber

The phone number to call. The phone number should be given according to E.164 number formatting (http://en.wikipedia.org/wiki/E.164) and should be prefixed with a ‘+’. E.g. to call the US phone number 415 555 0101, it should be specified as “+14155550101”, where the ‘+’ is the required prefix and the US country code ‘1’ added before the local subscriber number.

Return Value

SINCall Outgoing call


                    
                    
                    -callPhoneNumber:headers:

Calls a phone number and terminate the call to the PSTN-network (Publicly Switched Telephone Network).

See

-[SINClientDelegate clientDidStart:]

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (id<SINCall>)callPhoneNumber:(NSString *)phoneNumber
                       headers:(NSDictionary *)headers;

Parameters

`phoneNumber`	The phone number to call. The phone number should be given according to E.164 number formatting (http://en.wikipedia.org/wiki/E.164) and should be prefixed with a ‘+’. E.g. to call the US phone number 415 555 0101, it should be specified as “+14155550101”, where the ‘+’ is the required prefix and the US country code ‘1’ added before the local subscriber number.
`headers`	NSString key-value pairs to pass with the call. The total size of header keys + values (when encoded with NSUTF8StringEncoding) must not exceed 1024 bytes. The call will fail immediately in case of invalid headers.

Return Value

SINCall Outgoing call


                    
                    
                    -callSIP:

Make a SIP call to user with the given SIP Identity.

See

-[SINClientDelegate clientDidStart:]

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (id<SINCall>)callSIP:(NSString *)sipIdentity;

Parameters


                                sipIdentity

The SIP identity string of the user to call, should be in the form of “user@domain”.

Return Value

SINCall Outgoing call


                    
                    
                    -callSIP:headers:

Make a SIP call to user with the given SIP Identity and adding the given headers.

See

-[SINClientDelegate clientDidStart:]

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (id<SINCall>)callSIP:(NSString *)sipIdentity headers:(NSDictionary *)headers;

Parameters

`sipIdentity`	The SIP identity string of the user to call, should be in the form of “user@domain”.
`headers`	NSString key-value pairs to pass with the call. The total size of header keys + values (when encoded with NSUTF8StringEncoding) must not exceed 1024 bytes. The call will fail immediately in case of invalid headers.

Return Value

SINCall Outgoing call


                    
                    
                    -callConferenceWithId:

Calls the conference with the given id.

See

-[SINClientDelegate clientDidStart:]

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (id<SINCall>)callConferenceWithId:(NSString *)conferenceId;

Parameters


                                conferenceId

The application specific id of the conference to call. It must not exceed 64 characters, or the call will fail immediately.

Return Value

SINCall Outgoing call


                    
                    
                    -callConferenceWithId:headers:

Calls the conference with the given id and the given headers.

See

-[SINClientDelegate clientDidStart:]

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (id<SINCall>)callConferenceWithId:(NSString *)conferenceId
                            headers:(NSDictionary *)headers;

Parameters

`conferenceId`	The application specific id of the conference to call. It must not exceed 64 characters, or the call will fail immediately.
`headers`	NSString key-value pairs to pass with the call. The total size of header keys + values (when encoded with NSUTF8StringEncoding) must not exceed 1024 bytes. The call will fail immediately in case of invalid headers.

Return Value

SINCall Outgoing call


                    
                    
                    -provider:didActivateAudioSession:

This API is introduced to support CallKit integration. Invoke this method to notify the Sinch SDK that the App has received the didActivateAudioSession callback from CXProviderDelegate. When CallKit is integrated in the App and an incoming call is received in the background, this method has to be invoked for the Sinch SDK to start the media for the call.

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (void)provider:(CXProvider *)provider
    didActivateAudioSession:(AVAudioSession *)audioSession;

Swift

func provider(_ provider: CXProvider!, didActivate audioSession: AVAudioSession!)

Parameters


                                audioSession

The audioSession from the didActivateAudioSession callback of CXProviderDelegate.


                    
                    
                    -provider:didDeactivateAudioSession:

This API is introduced to support CallKit integration. Invoke this method to notify the Sinch SDK that the App has received the didDeactivateAudioSession callback from CXProviderDelegate. When CallKit is integrated in the App, this method has to be invoked to pass the didDeactivateAudioSession event from CallKit to the Sinch SDK for correct audio session management.

Important

Thread safety notes: Should be called on main thread/main GCD queue.

Declaration

Objective-C

- (void)provider:(CXProvider *)provider
    didDeactivateAudioSession:(AVAudioSession *)audioSession;

Swift

func provider(_ provider: CXProvider!, didDeactivate audioSession: AVAudioSession!)

Parameters


                                audioSession

The audioSession from the didActivateAudioSession callback of CXProviderDelegate.