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

#import <GSSessionPolicyDelegate.h>

Inheritance diagram for <GSSessionPolicyDelegate>:
<GSPolicyDelegate> GSDefaultSessionPolicy

List of all members.

Public Member Functions

(NSArray *) - prioritizedCodecList
(GSDtmfMethod) - dtmfMethodForSession:
(BOOL) - shouldAnswerIncomingSession:
(BOOL) - isVideoCodecAvailable
(BOOL) - shouldAcceptVideo:
(BOOL) - rejectWhenHeadsetNa:
(NSString *) - sipCodeWhenHeadsetNa:
(int) - agcMode
(int) - dtxMode
(int) - vadLevel
- Public Member Functions inherited from
(void) - configureWithDictionary:

Detailed Description

Defines aspects of session manager's behavior

See also:
GSSessionManager

Definition at line 18 of file GSSessionPolicyDelegate.h.


Member Function Documentation

- (int) agcMode
required

Implement to specify AGC mode for all sessions.

Returns:
0 when AGC functionality is disabled
1 when AGC functionality is enabled (default mode)
- (GSDtmfMethod) dtmfMethodForSession: (id< GSSession >)  session
required

Implement to specify the DTMF method to be used for a given session

Parameters:
sessionthe session for which the DTMF method is being considered
Returns:
the DTMF method as defined by the GSDtmfMethod enumeration
See also:
GSDtmfMethod
- (int) dtxMode
required

Implement to specify DTX mode for all sessions.

Returns:
0 when DTX functionality is disabled
1 when DTX functionality is enabled (default mode)
- (BOOL) isVideoCodecAvailable
required

Implement to specify whether the video codec is available or not.

Parameters:
sessionthe incoming session
Returns:
YES if video codec is available or NO if video codec is not available
- (NSArray*) prioritizedCodecList
required

Implement to specify the list of codecs to be used when establishing a session

Returns:
the prioritized codec list, sorted from highest to lowest priority or an empty collection to use the default priorities and all available codecs.
- (BOOL) rejectWhenHeadsetNa: (id< GSSession >)  session
required

Implement to specify whether the incoming session should be rejected when headset not available.

Parameters:
sessionthe incoming session
Returns:
YES to reject session or NO to do nothing
- (BOOL) shouldAcceptVideo: (id< GSSession >)  session
required

Implement to specify whether the incoming session should be automatically answered with video.

Parameters:
sessionthe incoming session
Returns:
YES to answer with video or NO to answer with audio
- (BOOL) shouldAnswerIncomingSession: (id< GSSession >)  session
required

Implement to specify whether the incoming session should be automatically answered.

Parameters:
sessionthe incoming session
Returns:
YES to answer or NO to send 180 Ringing
- (NSString*) sipCodeWhenHeadsetNa: (id< GSSession >)  session
required

Implement to specify respond SIP code when headset not available.

Parameters:
sessionthe incoming session
Returns:
SIP code string
- (int) vadLevel
required

Implement to specify VAD level for all sessions.

Returns:
value from 0 to 3 where: 0 is conventional VAD level 3 is aggressive high VAD level

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