SIP Endpoint SDK for OS X
 All Classes Functions Properties
<GSSessionService> Protocol Reference

#import <Services.h>

Inheritance diagram for <GSSessionService>:
GSDefaultSessionService

List of all members.

Public Member Functions

(GSResult) - dialFrom:to:
(GSResult) - dialVideoFrom:to:
(GSResult) - dialFrom:to:withData:
(GSResult) - dialVideoFrom:to:withData:
(GSResult) - dialFrom:to:video:withData:sessionId:
(GSResult) - answerSession:
(GSResult) - answerVideoSession:
(GSResult) - hangupSession:
(GSResult) - holdSession:
(GSResult) - retrieveSession:
(GSResult) - sendDtmf:forSession:
(GSResult) - sendInfoToSession:contentType:content:
(GSResult) - oneStepTransfer:destination:video:
(GSResult) - twoStepTransferInitiate:destination:video:data:newSessionId:
(GSResult) - twoStepTransferComplete:heldSessionId:
(NSString *) - sipInviteHeaderForSessionId:headerName:
(GSResult) - muteOutgoingAudioForSession:mute:
(BOOL) - outgoingAudioMutedForSession:
(GSResult) - speakerVolumeForSession:volume:
(GSResult) - sendVideoOfferForSession:
(GSResult) - answerVideoOfferForSession:accept:
(GSResult) - removeVideoStreamForSession:
(NSString *) - getCodecNameForSessionId:
(NSString *) - getRemoteSDPForSessionId:
(NSString *) - getSIPMessageForSessionId:byIndex:
(NSString *) - getSIPMessageForSessionId:byName:

Detailed Description

Session service protocol

Definition at line 17 of file Services.h.


Member Function Documentation

- (GSResult) answerSession: (id< GSSession >)  session

Sends SIP 200OK to the incoming session

Parameters:
sessionobject.
Returns:
the result of the operation.
- (GSResult) answerVideoOfferForSession: (id< GSSession >)  session
accept: (BOOL)  accept 

Accept or reject of the video offer for the particular session.

Parameters:
sessionthe session that video is offered.
acceptthe flag that indicate if the offer accepted (YES) or rejected (NO).
Returns:
the result of the operation.
- (GSResult) answerVideoSession: (id< GSSession >)  session

Sends SIP 200OK to the incoming video session

Parameters:
sessionobject.
Returns:
the result of the operation.
- (GSResult) dialFrom: (id< GSConnection >)  connection
to: (NSString *)  destination 

Sends SIP INVITE to the other party for the connection

Parameters:
connectionobject.
destinationaddress.
Returns:
the result of the operation.
- (GSResult) dialFrom: (id< GSConnection >)  connection
to: (NSString *)  destination
video: (BOOL)  video
withData: (NSString *)  data
sessionId: (int *)  outSessionId 

Sends SIP audio or video Call INVITE with or without user data header to the other party for the connection

Parameters:
connectionobject.
destinationaddress.
video,ifYES dialing video session if NO dialing audio session.
data,ifnil without user data if not nil string of user data.
outSessionId,outparameter that represent ID of the newly created session.
Returns:
the result of the operation.
- (GSResult) dialFrom: (id< GSConnection >)  connection
to: (NSString *)  destination
withData: (NSString *)  data 

Sends SIP Voice Call INVITE with user data header to the other party for the connection

Parameters:
connectionobject.
destinationaddress.
stringwith user data.
Returns:
the result of the operation.
- (GSResult) dialVideoFrom: (id< GSConnection >)  connection
to: (NSString *)  destination 

Sends SIP INVITE with video in SDP to the other party for the connection

Parameters:
connectionobject.
destinationaddress.
Returns:
the result of the operation.
- (GSResult) dialVideoFrom: (id< GSConnection >)  connection
to: (NSString *)  destination
withData: (NSString *)  data 

Sends SIP Video Call INVITE with user data header to the other party for the connection

Parameters:
connectionobject.
destinationaddress.
stringwith user data.
Returns:
the result of the operation.
- (NSString*) getCodecNameForSessionId: (int)  sessionId

Gets codec name for active or held session.

Parameters:
sessionIdactive or held session ID.
Returns:
the code name.
- (NSString*) getRemoteSDPForSessionId: (int)  sessionId

Gets last remote offer or answer SDP for active or held session.

Parameters:
sessionIdactive or held session ID.
Returns:
SDP content.
- (NSString*) getSIPMessageForSessionId: (int)  sessionId
byIndex: (int)  index 

Gets specific SIP message from history by its index position.

Parameters:
sessionIdactive or held session ID.
indexposition in SIP history.
Returns:
SIP message content.
- (NSString*) getSIPMessageForSessionId: (int)  sessionId
byName: (NSString *)  name 

Gets specific SIP message from history by its name.

Parameters:
sessionIdactive or held session ID.
nameSIP message name.
Returns:
SIP message content.
- (GSResult) hangupSession: (id< GSSession >)  session

Sends SIP BYE to the session

Parameters:
sessionobject.
Returns:
the result of the operation.
- (GSResult) holdSession: (id< GSSession >)  session

Put the session on Hold

Parameters:
sessionobject.
Returns:
the result of the operation.
- (GSResult) muteOutgoingAudioForSession: (id< GSSession >)  session
mute: (BOOL)  mute 

Mute outgoing audio for the session.

Parameters:
sessionthe session that outgoing audio to be muted.
mutethe flag YES if mute or NO if unmute.
Returns:
the result of the operation.
- (GSResult) oneStepTransfer: (int)  sessionId
destination: (NSString *)  destination
video: (BOOL)  video 

Make one step transfer the the session.

Parameters:
sessionID.
destinationthe other party address.
videoYES if the transfered session should be with video.
Returns:
the result of the operation.
- (BOOL) outgoingAudioMutedForSession: (id< GSSession >)  session

Gets the state of outgoing audio of the session.

Parameters:
sessionthe session that queried for mute state of the outgoing audio.
Returns:
YES if outgoing audio for this session is muted.
NO if outgoing audio for this session is unmuted.
- (GSResult) removeVideoStreamForSession: (id< GSSession >)  session

Removes of the video stream for the particular session.

Parameters:
sessionthe session that video is offered.
Returns:
the result of the operation.
- (GSResult) retrieveSession: (id< GSSession >)  session

Retrive the session from Hold

Parameters:
sessionobject.
Returns:
the result of the operation.
- (GSResult) sendDtmf: (NSString *)  digits
forSession: (id< GSSession >)  session 

Sends DTMF to the other parties in the session. The DTMF method is determined by the policy configured for this session's session manager.

Parameters:
digitsthe DTMF digits to be sent.
Returns:
the result of the operation.
- (GSResult) sendInfoToSession: (id< GSSession >)  session
contentType: (NSString *)  contentType
content: (NSString *)  content 

Sends SIP INFO message to the other parties in the session.

Parameters:
sessionthe SIP INFO to be sent.
contentTypethe name of the header to be sent.
contentthe content of the header to be sent.
Returns:
the result of the operation.
- (GSResult) sendVideoOfferForSession: (id< GSSession >)  session

Sends the video offer for the particular session.

Parameters:
sessionthe session that video is offered.
Returns:
the result of the operation.
- (NSString*) sipInviteHeaderForSessionId: (int)  sessionId
headerName: (NSString *)  headerName 

Gets SIP INVITE header by header name.

Parameters:
sessionIdthe session ID of the inbound session.
headerNamethe name of the requesting header to be gotten.
Returns:
the content of the requested header.
- (GSResult) speakerVolumeForSession: (id< GSSession >)  session
volume: (int)  volume 

Set the microphone volume for the particular session.

Parameters:
sessionthe session of the requested volume of outgoing audio.
volumethe microphone volume to be set.
Returns:
the result of the operation. Set the speaker volume for the particular session.
Parameters:
sessionthe session of the requested volume of incoming audio.
volumethe speaker volume to be set.
Returns:
the result of the operation.
- (GSResult) twoStepTransferComplete: (int)  activeSessionId
heldSessionId: (int)  heldSessionId 

Make complete of the two step transfer for the session.

Parameters:
activeSessionIdthe session ID of the initiated session.
heldSessionIdthe session ID of the originally created session.
Returns:
the result of the operation.
- (GSResult) twoStepTransferInitiate: (int)  sessionId
destination: (NSString *)  destination
video: (BOOL)  video
data: (NSString *)  data
newSessionId: (int *)  newSessionId 

Make initiate of the two step transfer for the session.

Parameters:
sessionID.
destinationthe other party address.
videoYES if the transfered session should be with video.
datathe data.
newSessionIdthe session ID if initiate successfully completed.
Returns:
the result of the operation.

The documentation for this protocol was generated from the following file: