SIP Endpoint SDK for OS X
|
#import <GSEndpoint.h>
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< GSLogger > | logger |
GSEndpointState | state |
id< GSConnectionManager > | connectionManager |
int | connectionCount |
id< GSSessionManager > | sessionManager |
id< GSDeviceManager > | deviceManager |
id < GSEndpointNotificationDelegate > | notificationDelegate |
id< GSEndpointPolicyDelegate > | policyDelegate |
NSMutableArray * | gsTestControl |
NSString * | configFileName |
BOOL | isStopped |
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.
- (void) activate |
Enables all configured connections.
- (BOOL) configure |
Configure endpoint.
- (GSStatus) enableAudioMonitor: | (int) | streamType |
Enable audio processing support for requested stream type
streamType | values: 0 - disable support; 1 - mic stream; 2 - speaker stream; |
- (NSString*) getConfigSettingForKey: | (NSString *) | key |
Get endpoint configuration setting
key |
- (GSAudioFrame*) lastAudioMicFrame |
- (GSAudioFrame*) lastAudioSpeakerFrame |
- (void) printConfigFile: | (NSString *) | fileName |
Logs out configuration file.
fully | qualified file name. |
- (void) printConfigSettings |
Logs out all configuration settings.
- (GSResult) reloadConfigFile |
Get endpoint core configuration file reloaded
- (GSResult) restart |
Get endpoint core restarted
- (id<GSSessionService>) sessionControlService |
- (GSResult) setConfigSettingValue: | (NSString *) | value | |
forKey: | (NSString *) | key | |
Set endpoint configuration setting
value | |
key |
- (void) shutdown |
Destroy endpoint and core.
- (id<GSStatisticsService>) statisticsService |
- (void) stop |
Destroy endpoint.
|
readwritenonatomicretain |
Get/set the configuration file name.
Reimplemented in GSSipEndpoint.
Definition at line 101 of file GSEndpoint.h.
|
readwritenonatomicretain |
Used to provide SIP Endpoint SDK configuration settings.
Definition at line 34 of file GSEndpoint.h.
|
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.
Reimplemented in GSSipEndpoint.
Definition at line 57 of file GSEndpoint.h.
|
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
Reimplemented in GSSipEndpoint.
Definition at line 77 of file GSEndpoint.h.
|
readwritenonatomicretain |
Used to provide SIP Endpoint SDK version description.
Reimplemented in GSSipEndpoint.
Definition at line 29 of file GSEndpoint.h.
|
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
Reimplemented in GSSipEndpoint.
Definition at line 96 of file GSEndpoint.h.
|
readwritenonatomicassign |
Get/set the endpoint stop state.
Reimplemented in GSSipEndpoint.
Definition at line 107 of file GSEndpoint.h.
|
readwritenonatomicretain |
|
readwritenonatomicretain |
Get/set the delegate responsible for notifications about endpoint state.
Reimplemented in GSSipEndpoint.
Definition at line 82 of file GSEndpoint.h.
|
readwritenonatomicretain |
Get/set the delegate responsible for dictating endpoint policy.
Reimplemented in GSSipEndpoint.
Definition at line 87 of file GSEndpoint.h.
|
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.
Reimplemented in GSSipEndpoint.
Definition at line 67 of file GSEndpoint.h.
|
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.