Functions
(void)	- <PortSIPEventDelegate >::onInviteIncoming:callerDisplayName:caller:calleeDisplayName:callee:audioCodecs:videoCodecs:existsAudio:existsVideo:sipMessage:

(void)	- <PortSIPEventDelegate >::onInviteTrying:

(void)	- <PortSIPEventDelegate >::onInviteSessionProgress:audioCodecs:videoCodecs:existsEarlyMedia:existsAudio:existsVideo:sipMessage:

(void)	- <PortSIPEventDelegate >::onInviteRinging:statusText:statusCode:sipMessage:

(void)	- <PortSIPEventDelegate >::onInviteAnswered:callerDisplayName:caller:calleeDisplayName:callee:audioCodecs:videoCodecs:existsAudio:existsVideo:sipMessage:

(void)	- <PortSIPEventDelegate >::onInviteFailure:reason:code:sipMessage:

(void)	- <PortSIPEventDelegate >::onInviteUpdated:audioCodecs:videoCodecs:existsAudio:existsVideo:sipMessage:

(void)	- <PortSIPEventDelegate >::onInviteConnected:

(void)	- <PortSIPEventDelegate >::onInviteBeginingForward:

(void)	- <PortSIPEventDelegate >::onInviteClosed:

(void)	- <PortSIPEventDelegate >::onDialogStateUpdated:BLFDialogState:BLFDialogId:BLFDialogDirection:

(void)	- <PortSIPEventDelegate >::onRemoteHold:

(void)	- <PortSIPEventDelegate >::onRemoteUnHold:audioCodecs:videoCodecs:existsAudio:existsVideo:

Detailed Description

Function Documentation

◆ onInviteIncoming:callerDisplayName:caller:calleeDisplayName:callee:audioCodecs:videoCodecs:existsAudio:existsVideo:sipMessage:()

- (void PortSIPEventDelegate) onInviteIncoming:	(long)	sessionId
callerDisplayName:	(char *)	callerDisplayName
caller:	(char *)	caller
calleeDisplayName:	(char *)	calleeDisplayName
callee:	(char *)	callee
audioCodecs:	(char *)	audioCodecs
videoCodecs:	(char *)	videoCodecs
existsAudio:	(BOOL)	existsAudio
existsVideo:	(BOOL)	existsVideo
sipMessage:	(char *)	sipMessage

When the call is coming, this event will be triggered.

Parameters

sessionId	The session ID of the call.
callerDisplayName	The display name of caller
caller	The caller.
calleeDisplayName	The display name of callee.
callee	The callee.
audioCodecs	The matched audio codecs. It's separated by "#" if there are more than one codecs.
videoCodecs	The matched video codecs. It's separated by "#" if there are more than one codecs.
existsAudio	By setting to true, it indicates that this call includes the audio.
existsVideo	By setting to true, it indicates that this call includes the video.
sipMessage	The SIP message received.

◆ onInviteTrying:()

- (void PortSIPEventDelegate) onInviteTrying: (long) sessionId

If the outgoing call is being processed, this event will be triggered.

Parameters

sessionId The session ID of the call.

◆ onInviteSessionProgress:audioCodecs:videoCodecs:existsEarlyMedia:existsAudio:existsVideo:sipMessage:()

- (void PortSIPEventDelegate) onInviteSessionProgress:	(long)	sessionId
audioCodecs:	(char *)	audioCodecs
videoCodecs:	(char *)	videoCodecs
existsEarlyMedia:	(BOOL)	existsEarlyMedia
existsAudio:	(BOOL)	existsAudio
existsVideo:	(BOOL)	existsVideo
sipMessage:	(char *)	sipMessage

Once the caller received the "183 session in progress" message, this event will be triggered.

Parameters

sessionId	The session ID of the call.
audioCodecs	The matched audio codecs. It's separated by "#" if there are more than one codecs.
videoCodecs	The matched video codecs. It's separated by "#" if there are more than one codecs.
existsEarlyMedia	By setting to true, it indicates that the call has early media.
existsAudio	By setting to true, it indicates that this call includes the audio.
existsVideo	By setting to true, it indicates that this call includes the video.
sipMessage	The SIP message received.

◆ onInviteRinging:statusText:statusCode:sipMessage:()

- (void PortSIPEventDelegate) onInviteRinging:	(long)	sessionId
statusText:	(char *)	statusText
statusCode:	(int)	statusCode
sipMessage:	(char *)	sipMessage

If the outgoing call is ringing, this event will be triggered.

Parameters

sessionId	The session ID of the call.
statusText	The status text.
statusCode	The status code.
sipMessage	The SIP message received.

◆ onInviteAnswered:callerDisplayName:caller:calleeDisplayName:callee:audioCodecs:videoCodecs:existsAudio:existsVideo:sipMessage:()

- (void PortSIPEventDelegate) onInviteAnswered:	(long)	sessionId
callerDisplayName:	(char *)	callerDisplayName
caller:	(char *)	caller
calleeDisplayName:	(char *)	calleeDisplayName
callee:	(char *)	callee
audioCodecs:	(char *)	audioCodecs
videoCodecs:	(char *)	videoCodecs
existsAudio:	(BOOL)	existsAudio
existsVideo:	(BOOL)	existsVideo
sipMessage:	(char *)	sipMessage

If the remote party answered the call, this event would be triggered.

Parameters

sessionId	The session ID of the call.
callerDisplayName	The display name of caller
caller	The caller.
calleeDisplayName	The display name of callee.
callee	The callee.
audioCodecs	The matched audio codecs. It's separated by "#" if there are more than one codecs.
videoCodecs	The matched video codecs. It's separated by "#" if there are more than one codecs.
existsAudio	By setting to true, it indicates that this call includes the audio.
existsVideo	By setting to true, it indicates that this call includes the video.
sipMessage	The SIP message received.

◆ onInviteFailure:reason:code:sipMessage:()

- (void PortSIPEventDelegate) onInviteFailure:	(long)	sessionId
reason:	(char *)	reason
code:	(int)	code
sipMessage:	(char *)	sipMessage

If the outgoing call fails, this event will be triggered.

Parameters

sessionId	The session ID of the call.
reason	The failure reason.
code	The failure code.
sipMessage	The SIP message received.

◆ onInviteUpdated:audioCodecs:videoCodecs:existsAudio:existsVideo:sipMessage:()

- (void PortSIPEventDelegate) onInviteUpdated:	(long)	sessionId
audioCodecs:	(char *)	audioCodecs
videoCodecs:	(char *)	videoCodecs
existsAudio:	(BOOL)	existsAudio
existsVideo:	(BOOL)	existsVideo
sipMessage:	(char *)	sipMessage

This event will be triggered when remote party updates this call.

Parameters

sessionId	The session ID of the call.
audioCodecs	The matched audio codecs. It's separated by "#" if there are more than one codecs.
videoCodecs	The matched video codecs. It's separated by "#" if there are more than one codecs.
existsAudio	By setting to true, it indicates that this call includes the audio.
existsVideo	By setting to true, it indicates that this call includes the video.
sipMessage	The SIP message received.

◆ onInviteConnected:()

- (void PortSIPEventDelegate) onInviteConnected: (long) sessionId

This event will be triggered when UAC sent/UAS received ACK (the call is connected). Some functions (hold, updateCall etc...) can be called only after the call is connected, otherwise it will return error.

Parameters

sessionId The session ID of the call.

◆ onInviteBeginingForward:()

- (void PortSIPEventDelegate) onInviteBeginingForward: (char *) forwardTo

If the enableCallForward method is called and a call is incoming, the call will be forwarded automatically and this event will be triggered.

Parameters

forwardTo The target SIP URI for forwarding.

◆ onInviteClosed:()

- (void PortSIPEventDelegate) onInviteClosed: (long) sessionId

This event will be triggered once remote side closes the call.

Parameters

sessionId The session ID of the call.

◆ onDialogStateUpdated:BLFDialogState:BLFDialogId:BLFDialogDirection:()

- (void PortSIPEventDelegate) onDialogStateUpdated:	(char *)	BLFMonitoredUri
BLFDialogState:	(char *)	BLFDialogState
BLFDialogId:	(char *)	BLFDialogId
BLFDialogDirection:	(char *)	BLFDialogDirection

If a user subscribed and his dialog status monitored, when the monitored user is holding a call or being rang, this event will be triggered.

Parameters

BLFMonitoredUri	the monitored user's URI
BLFDialogState	- the status of the call
BLFDialogId	- the id of the call
BLFDialogDirection	- the direction of the call

◆ onRemoteHold:()

- (void PortSIPEventDelegate) onRemoteHold: (long) sessionId

If the remote side has placed the call on hold, this event will be triggered.

Parameters

sessionId The session ID of the call.

◆ onRemoteUnHold:audioCodecs:videoCodecs:existsAudio:existsVideo:()

- (void PortSIPEventDelegate) onRemoteUnHold:	(long)	sessionId
audioCodecs:	(char *)	audioCodecs
videoCodecs:	(char *)	videoCodecs
existsAudio:	(BOOL)	existsAudio
existsVideo:	(BOOL)	existsVideo

If the remote side un-holds the call, this event will be triggered.

Parameters

sessionId	The session ID of the call.
audioCodecs	The matched audio codecs. It's separated by "#" if there are more than one codecs.
videoCodecs	The matched video codecs. It's separated by "#" if there are more than one codecs.
existsAudio	By setting to true, it indicates that this call includes the audio.
existsVideo	By setting to true, it indicates that this call includes the video.

Functions

Detailed Description

Function Documentation

◆ onInviteIncoming:callerDisplayName:caller:calleeDisplayName:callee:audioCodecs:videoCodecs:existsAudio:existsVideo:sipMessage:()

◆ onInviteTrying:()

◆ onInviteSessionProgress:audioCodecs:videoCodecs:existsEarlyMedia:existsAudio:existsVideo:sipMessage:()

◆ onInviteRinging:statusText:statusCode:sipMessage:()

◆ onInviteAnswered:callerDisplayName:caller:calleeDisplayName:callee:audioCodecs:videoCodecs:existsAudio:existsVideo:sipMessage:()

◆ onInviteFailure:reason:code:sipMessage:()

◆ onInviteUpdated:audioCodecs:videoCodecs:existsAudio:existsVideo:sipMessage:()

◆ onInviteConnected:()

◆ onInviteBeginingForward:()

◆ onInviteClosed:()

◆ onDialogStateUpdated:BLFDialogState:BLFDialogId:BLFDialogDirection:()

◆ onRemoteHold:()

◆ onRemoteUnHold:audioCodecs:videoCodecs:existsAudio:existsVideo:()