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

#import <GSSession.h>

Inheritance diagram for <GSSession>:
GSSipSession

List of all members.

Public Member Functions

(GSResult) - changeOutputVolumeBy:
(GSResult) - changeSpeakerVolumeTo:
(int) - getOutputVolume

Properties

int callId
GSSessionState state
NSString * sessionId
id< GSConnectionconnection
NSString * remoteParty
GSFlagState hasVideo
GSFlagState localHold
GSFlagState playRingtone
BOOL vqAlarm
BOOL vqAlarmChanged
int speakerVolume
BOOL sipInfo
NSString * contentType
NSString * content

Detailed Description

This protocol represents a SIP session (i.e. call)

Definition at line 14 of file GSSession.h.


Member Function Documentation

- (GSResult) changeOutputVolumeBy: (int)  increment

Changes the output level of the current audio stream by increment value

- (GSResult) changeSpeakerVolumeTo: (int)  value

Changes the output level of the current audio stream to the value

- (int) getOutputVolume

Get the output level of the current audio stream

The Session Mic Volume Control not supported @ return 0 if the method is called


Property Documentation

- (int) callId
readwritenonatomicassign

The connection ID

Reimplemented in GSSipSession.

Definition at line 19 of file GSSession.h.

- (id<GSConnection>) connection
readwritenonatomicretain

Retrieves the connection via which this session was established.

Reimplemented in GSSipSession.

Definition at line 34 of file GSSession.h.

- (GSFlagState) hasVideo
readwritenonatomicassign

Stands for indicate that the session offers video

Returns:
GSFlagStateTrue when video is presented in a given session
GSFlagStateFalse when video is NOT presented in a given session
GSFlagStateUnknown if has video indication is not applicable for this state

Reimplemented in GSSipSession.

Definition at line 50 of file GSSession.h.

- (NSString*) remoteParty
readwritenonatomicretain

Represents Remote Party address

Returns:
a string with remote party address

Reimplemented in GSSipSession.

Definition at line 41 of file GSSession.h.

- (NSString*) sessionId
readwritenonatomicretain

d Retrieves the current session id.

Reimplemented in GSSipSession.

Definition at line 29 of file GSSession.h.

- (BOOL) sipInfo
readwritenonatomicassign

Represents the current mic volume

Returns:
a number from 0 to 100 that represents the currently used mic volume

Reimplemented in GSSipSession.

Definition at line 74 of file GSSession.h.

- (int) speakerVolume
readwritenonatomicassign

Represents the current speaker volume

Returns:
a number from 0 to 100 that represents the currently used speaker volume

Reimplemented in GSSipSession.

Definition at line 65 of file GSSession.h.

- (GSSessionState) state
readwritenonatomicassign

Retrieves the current session state

Reimplemented in GSSipSession.

Definition at line 24 of file GSSession.h.


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