SINCall Protocol Reference
Conforms to | NSObject |
---|---|
Declared in | SINCall.h |
delegate
required method
The object that acts as the delegate of the call.
@property (nonatomic, weak) id<SINCallDelegate> delegate
Discussion
The delegate object handles call state change events and must adopt the SINCallDelegate protocol.
See Also
Declared In
SINCall.h
callId
required method
String that is used as an identifier for this particular call.
@property (nonatomic, readonly, copy) NSString *callId
Declared In
SINCall.h
remoteUserId
required method
The id of the remote participant in the call.
@property (nonatomic, readonly, copy) NSString *remoteUserId
Declared In
SINCall.h
details
required method
Metadata about a call, such as start time.
@property (nonatomic, readonly, strong) id<SINCallDetails> details
Discussion
When a call has ended, the details object contains information about the reason the call ended and error information if the call ended unexpectedly.
See Also
Declared In
SINCall.h
state
required method
The state the call is currently in. It may be one of the following:
@property (nonatomic, readonly, assign) SINCallState state
Discussion
SINCallStateInitiating
SINCallStateProgressing
SINCallStateEstablished
SINCallStateEnded
Initially, the call will be in the SINCallStateInitiating
state.
Declared In
SINCall.h
direction
required method
The direction of the call. It may be one of the following:
@property (nonatomic, readonly, assign) SINCallDirection direction
Discussion
SINCallDirectionIncoming
SINCallDirectionOutgoing
Declared In
SINCall.h
headers
required method
Call headers.
@property (nonatomic, readonly) NSDictionary *headers
Discussion
Any application-defined call meta-data can be passed via headers.
E.g. a human-readable “display name / username” can be convenient to send as an application-defined header.
IMPORTANT: If a call is initially received via remote push notifications, headers may not be immediately available due to push payload size limitations (especially pre- iOS 8). If it’s not immediately available, it will be available after the event callbacks [SINCallDelegate callDidProgress:] or [SINCallDelegate callDidEstablish:] .
Declared In
SINCall.h
userInfo
required method
The user data property may be used to associate an arbitrary contextual object with a particular instance of a call.
@property (nonatomic, strong) id userInfo
Declared In
SINCall.h
– hangup
required method
Ends the call, regardless of what state it is in. If the call is an incoming call that has not yet been answered, the call will be reported as denied to the caller.
- (void)hangup
Declared In
SINCall.h
– sendDTMF:
required method
Sends a DTMF tone for tone dialing. (Only applicable for calls terminated to PSTN (Publicly Switched Telephone Network)).
- (void)sendDTMF:(NSString *)key
Parameters
key |
DTMF key must be in [0-9, #, *, A-D]. |
---|
Exceptions
NSInvalidArgumentException |
Throws exception if key does not have a valid mapping to a DTMF tone. |
---|
Declared In
SINCall.h
– pauseVideo
required method
Pause video track for this call
- (void)pauseVideo
Declared In
SINCall.h
– resumeVideo
required method
Start video track for this call
- (void)resumeVideo
Declared In
SINCall.h