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

#import <GSEndpoint.h>

Inheritance diagram for <GSEndpoint>:
GSSipEndpoint

List of all members.

Public Member Functions

(void) - activate
(BOOL) - configure
(void) - printConfigSettings
(void) - printConfigFile:
(GSResult) - setConfigSettingValue:forKey:
(NSString *) - getConfigSettingForKey:
(GSResult) - reloadConfigFile
(GSResult) - restart
(void) - stop
(void) - shutdown
(id< GSSessionService >) - sessionControlService
(id< GSStatisticsService >) - statisticsService
(GSStatus) - enableAudioMonitor:
(GSAudioFrame *) - lastAudioMicFrame
(GSAudioFrame *) - lastAudioSpeakerFrame

Properties

NSString * endpointSdkVersion
NSMutableDictionary * configuration
id< GSLoggerlogger
GSEndpointState state
id< GSConnectionManagerconnectionManager
int connectionCount
id< GSSessionManagersessionManager
id< GSDeviceManagerdeviceManager
id
< GSEndpointNotificationDelegate
notificationDelegate
id< GSEndpointPolicyDelegatepolicyDelegate
NSMutableArray * gsTestControl
NSString * configFileName
BOOL isStopped

Detailed Description

This protocol defines sip endpoint functionality. It should be used to configure the sip endpoint and work with all active connections, sessions, and devices.

Definition at line 22 of file GSEndpoint.h.


Member Function Documentation

- (void) activate

Enables all configured connections.

- (BOOL) configure

Configure endpoint.

Returns:
YES if endpoint was successfully configured.
- (GSStatus) enableAudioMonitor: (int)  streamType

Enable audio processing support for requested stream type

Parameters:
streamTypevalues: 0 - disable support; 1 - mic stream; 2 - speaker stream;
Returns:
result of the operation
- (NSString*) getConfigSettingForKey: (NSString *)  key

Get endpoint configuration setting

Parameters:
key
Returns:
string value of the requested key string
empty string if key-value pair does not exists
empty string if key nill or empty
- (GSAudioFrame*) lastAudioMicFrame
Returns:
the most recent of mic audio stream frame.
- (GSAudioFrame*) lastAudioSpeakerFrame
Returns:
the most recent of speaker audio stream frame.
- (void) printConfigFile: (NSString *)  fileName

Logs out configuration file.

Parameters:
fullyqualified file name.
- (void) printConfigSettings

Logs out all configuration settings.

- (GSResult) reloadConfigFile

Get endpoint core configuration file reloaded

Returns:
result of the operation
- (GSResult) restart

Get endpoint core restarted

Returns:
result of the operation
- (id<GSSessionService>) sessionControlService
Returns:
an instance of the session control service to be used for first party call control
- (GSResult) setConfigSettingValue: (NSString *)  value
forKey: (NSString *)  key 

Set endpoint configuration setting

Parameters:
value
key
Returns:
result of the operation
- (void) shutdown

Destroy endpoint and core.

- (id<GSStatisticsService>) statisticsService
Returns:
an instance of the media statistics service to be used for first party call control
- (void) stop

Destroy endpoint.


Property Documentation

- (NSString*) configFileName
readwritenonatomicretain

Get/set the configuration file name.

Reimplemented in GSSipEndpoint.

Definition at line 101 of file GSEndpoint.h.

- (NSMutableDictionary*) configuration
readwritenonatomicretain

Used to provide SIP Endpoint SDK configuration settings.

Definition at line 34 of file GSEndpoint.h.

- (id<GSConnectionManager>) connectionManager
readwritenonatomicretain

Get/set instance of the connection manager object which handles all connection information, stores all related policies and provides notifications about connection state. Returns a Genesys GSConnectionManager implemenation as the default.

See also:
GSConnectionManager

Reimplemented in GSSipEndpoint.

Definition at line 57 of file GSEndpoint.h.

- (id<GSDeviceManager>) deviceManager
readwritenonatomicretain

Get/set instance of the device manager object which handles all connected input/output devices, stores all related policies and provides notifications about device state. Returns a Genesys GSDeviceManager implemenation as the default

See also:
GSDeviceManager

Reimplemented in GSSipEndpoint.

Definition at line 77 of file GSEndpoint.h.

- (NSString*) endpointSdkVersion
readwritenonatomicretain

Used to provide SIP Endpoint SDK version description.

Returns:
a string that is represent the endpoint ID.

Reimplemented in GSSipEndpoint.

Definition at line 29 of file GSEndpoint.h.

- (NSMutableArray*) gsTestControl
readwritenonatomicretain

Get/set array of GSTestControl elements if any connectivity has ctrl setting configured that means the connectivity can request a test phone to delegate control on particualar dn/user and then after getting delegated event will link this connection for test phone

See also:
GSTestControl

Reimplemented in GSSipEndpoint.

Definition at line 96 of file GSEndpoint.h.

- (BOOL) isStopped
readwritenonatomicassign

Get/set the endpoint stop state.

Returns:
TRUE if endpoint was stopped

Reimplemented in GSSipEndpoint.

Definition at line 107 of file GSEndpoint.h.

- (id<GSLogger>) logger
readwritenonatomicretain

Get/set instance of the logger.

See also:
GSLogger

Definition at line 41 of file GSEndpoint.h.

- (id<GSEndpointNotificationDelegate>) notificationDelegate
readwritenonatomicretain

Get/set the delegate responsible for notifications about endpoint state.

Reimplemented in GSSipEndpoint.

Definition at line 82 of file GSEndpoint.h.

- (id<GSEndpointPolicyDelegate>) policyDelegate
readwritenonatomicretain

Get/set the delegate responsible for dictating endpoint policy.

Reimplemented in GSSipEndpoint.

Definition at line 87 of file GSEndpoint.h.

- (id<GSSessionManager>) sessionManager
readwritenonatomicretain

Get/set instance of the session manager object which handles all session data, stores all related policies and provides notifications about session state. Returns a Genesys GSSessionManager implemenation as the default.

See also:
GSSessionManager

Reimplemented in GSSipEndpoint.

Definition at line 67 of file GSEndpoint.h.

- (GSEndpointState) state
readwritenonatomicassign

Returns the current endpoint status. The endpoint is considered "Active" if at least one connection is registered.

Reimplemented in GSSipEndpoint.

Definition at line 47 of file GSEndpoint.h.


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