Sip Endpoint SDK for Apple OS
 All Classes Functions Properties
<GSSession> Protocol Reference

#import <GSSession.h>

List of all members.

Public Member Functions

(BOOL) - supportsMedia:

Properties

int callId
GSSessionState state
NSString * sessionId
id< GSConnectionconnection
NSString * remoteParty
id< GSAudioStreamaudioStream
GSFlagState hasVideo
int speakerVolume
int micVolume

Detailed Description

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

Definition at line 17 of file GSSession.h.


Member Function Documentation

- (BOOL) supportsMedia: (GSMedia *)  media

Use this method to determine whether the specified media type is supported by the current session.

Parameters:
mediaThe media type.
Returns:
YES if the media type is supported by the session, NO otherwise.

Property Documentation

- (id<GSAudioStream>) audioStream
readnonatomicretain

Gives a control to change IN and OUT devices volume

Returns:
GSAudioStream object with ability to: changeOutputVolumeBy:(int)increment; changeInputVolumeBy:(int)increment;

Definition at line 62 of file GSSession.h.

- (int) callId
readnonatomicassign

The connection ID

Definition at line 22 of file GSSession.h.

- (id<GSConnection>) connection
readnonatomicretain

Retrieves the connection via which this session was established.

Definition at line 37 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

Definition at line 71 of file GSSession.h.

- (int) micVolume
readnonatomicassign

Represents the current mic volume

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

Definition at line 85 of file GSSession.h.

- (NSString*) remoteParty
readnonatomiccopy

Represents Remote Party address

Returns:
a string with remote party address

Definition at line 53 of file GSSession.h.

- (NSString*) sessionId
readnonatomiccopy

d Retrieves the current session id.

Definition at line 32 of file GSSession.h.

- (int) speakerVolume
readnonatomicassign

Represents the current speaker volume

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

Definition at line 78 of file GSSession.h.

- (GSSessionState) state
readnonatomicassign

Retrieves the current session state

Definition at line 27 of file GSSession.h.


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