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

#import <GSSessionManager.h>

List of all members.

Public Member Functions

(NSArray *) - allSessions
(NSArray *) - sessionsForConnection:
(id< GSStatisticsService >) - statisticsService
(GSResult) - setAgcMode:
(GSResult) - setDtxMode:vadLevel:

Properties

int endpointId
id< GSSessionNotificationDelegatenotificationDelegate
id< GSSessionPolicyDelegatepolicyDelegate
id
< GSStatisticsNotificationDelegate
statisticsNotificationDelegate

Detailed Description

This protocol defines the functionality of a session manager which is responsible for handling all sessions. This object provides lists of current active sessions, some search functionality, as well as the ability to configure policy and receive notifications regarding session state.

Definition at line 24 of file GSSessionManager.h.


Member Function Documentation

- (NSArray*) allSessions

Returns a list of active sessions currently monitored by the session manager.

Returns:
an array of id<GSSession> objects
- (NSArray*) sessionsForConnection: (id< GSConnection >)  connection

Returns a list of active sessions established over the specified connection.

Parameters:
connectionthe connection for which to retrieve the sessions
Returns:
an array of id<GSSession> objects
- (GSResult) setAgcMode: (int)  agcMode

Get/set the policy which defines AGC mode for session.

- (GSResult) setDtxMode: (int)  dtxMode
vadLevel: (int)  vadLevel 

Get/set the policy which defines AGC mode for session.

- (id<GSStatisticsService>) statisticsService
Returns:
an instance of the Statistics Service to be used for get statistics functionality

Property Documentation

- (id<GSSessionNotificationDelegate>) notificationDelegate
readwritenonatomicassign

Get/set the delegate to be notified about sessions state.

Definition at line 47 of file GSSessionManager.h.

- (id<GSSessionPolicyDelegate>) policyDelegate
readwritenonatomicassign

Get/set the policy which defines aspects of session behavior.

Definition at line 52 of file GSSessionManager.h.

- (id<GSStatisticsNotificationDelegate>) statisticsNotificationDelegate
readwritenonatomicassign

Get/set the delegate to be notified about sessions statistics.

Definition at line 57 of file GSSessionManager.h.


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