SIP Endpoint SDK for OS X
 All Classes Functions Properties
<GSDeviceManager> Protocol Reference
Inheritance diagram for <GSDeviceManager>:
GSSipDeviceManager

List of all members.

Public Member Functions

(id< GSAudioDevice >) - activeAudioInputDevice
(id< GSAudioDevice >) - activeAudioOutputDevice
(id< GSAudioDevice >) - activeRingerDevice
(id< GSCaptureDevice >) - activeCaptureDevice
(GSResult) - useAudioInputDevice:
(GSResult) - useAudioOutputDevice:
(GSResult) - useRingerDevice:
(GSResult) - useCaptureDevice:
(GSStatus *) - setCaptureDevice:withCapability:
(void) - setActiveAudioInputDevice:
(void) - setActiveAudioOutputDevice:
(void) - setActiveRingerDevice:
(void) - setActiveCaptureDevice:
(NSArray *) - systemAudioDevices
(NSArray *) - systemCaptureDevices
(GSFlagState) - headsetAvailable
(id< GSAudioDevice >) - currentAudioDeviceForInput
(id< GSAudioDevice >) - currentAudioDeviceForOutput
(id< GSAudioDevice >) - currentRingerDevice
(id< GSCaptureDevice >) - currentCaptureDevice
(GSDeviceArray *) - getAudioInDevices:outDevices:
(GSDeviceArray *) - getCaptureDevices
(id< GSAudioDevice >) - getAudioDeviceById:
(id< GSCaptureDevice >) - getCaptureDeviceById:
(int) - videoCapabilitiesCount:
(GSCaptureCapability *) - videoCapability:capabilityIndex:
(GSResult) - releaseCaptureDevice
(BOOL) - hasCaptureDevice
(void) - refreshDevices
(void) - configure
(void) - configureAudioDevices
(void) - configureCaptureDevice

Properties

id< GSDeviceNotificationDelegatenotificationDelegate
id< GSDevicePolicyDelegatepolicyDelegate

Detailed Description

Definition at line 15 of file GSDeviceManager.h.


Member Function Documentation

- (id<GSAudioDevice>) activeAudioInputDevice

Retrieve the input device (e.g. microphone) that is currently used.

Returns:
the currently active audio input device.
- (id<GSAudioDevice>) activeAudioOutputDevice

Retrieve the output device (e.g. speaker) that is currently used.

Returns:
the currently active audio output device
- (id<GSCaptureDevice>) activeCaptureDevice

Retrieve the capture device (e.g. camera) that is currently used.

Returns:
the currently active capture device
- (id<GSAudioDevice>) activeRingerDevice

Retrieve the ringer device (e.g. speaker) that is currently used.

Returns:
the currently active ringer device
- (void) configure

Configure and re-select of preferable audio and capture devices.

operation is to re-select devices according to configuration file settings.

- (void) configureAudioDevices

Configure and re-select of preferable audio devices.

operation is to re-select audio devices according to configuration file settings.

- (void) configureCaptureDevice

Configure and re-select of preferable capture devices.

operation is to re-select capture devices according to configuration file settings.

- (id<GSAudioDevice>) currentAudioDeviceForInput

Get currently active audio input device (mic).

Returns:
audio input device object
- (id<GSAudioDevice>) currentAudioDeviceForOutput

Get currently active audio out device (speaker).

Returns:
audio out device object
- (id<GSCaptureDevice>) currentCaptureDevice

Get currently active capture device (camera).

Returns:
capture device object
- (id<GSAudioDevice>) currentRingerDevice

Get currently active ringer device (speaker).

Returns:
audio out device object
- (id<GSAudioDevice>) getAudioDeviceById: (int)  deviceId

Get audio device by device ID.

Returns:
audio device object
- (GSDeviceArray*) getAudioInDevices: (BOOL)  includeIn
outDevices: (BOOL)  includeOut 

Get array of existing audio IN or OUT devices or both.

Returns:
array of audio device objects
- (id<GSCaptureDevice>) getCaptureDeviceById: (int)  deviceId

Get capture device by device ID.

Returns:
capture device object
- (GSDeviceArray*) getCaptureDevices

Get array of existing capture devices.

Returns:
array of capture device objects
- (BOOL) hasCaptureDevice
Returns:
TRUE if there is a capture device.
- (GSFlagState) headsetAvailable

Get the headset available to support auto answer behavior.

Returns:
GSFlagStateTrue if headset device is available to use
GSFlagStateFalse if headset device is Not available to use
GSFlagStateUnknown if headset device availability is not applicable in the configuration
- (void) refreshDevices

Refresh/Update collections of existing audio and capture devices.

operation is to update collections of currently available devices.

- (GSResult) releaseCaptureDevice

Release local video capture device

Returns:
the result of the operation.
See also:
GSStatus
- (void) setActiveAudioInputDevice: (id< GSAudioDevice >)  device

Set/Update property: activeAudioInputDevice Send notification: activeAudioInputDeviceDidChangeNotification

Parameters:
device- current audio input device (e.g. microphone) is not an alternative for useAudioInputDevice
See also:
useAudioInputDevice
- (void) setActiveAudioOutputDevice: (id< GSAudioDevice >)  device

Set/Update property: activeAudioOutputDevice Send notification: activeAudioOutputDeviceDidChangeNotification

Parameters:
device- current audio output device (e.g. speaker) is not an alternative for useAudioOutputDevice
See also:
useAudioOutputDevice
- (void) setActiveCaptureDevice: (id< GSCaptureDevice >)  device

Set/Update property: activeCaptureDevice Send notification: activeCaptureDeviceDidChangeNotification

Parameters:
device- current capture device (e.g. camera) is not an alternative for useCaptureDevice
See also:
useCaptureDevice
- (void) setActiveRingerDevice: (id< GSAudioDevice >)  device

Set/Update property: activeAudioOutputDevice Send notification: activeRingerDeviceDidChangeNotification

Parameters:
device- current ringer audio output device (e.g. speaker) is not an alternative for useRingerDevice
See also:
useRingerDevice
- (GSStatus*) setCaptureDevice: (int)  deviceId
withCapability: (GSCaptureCapability *)  capability 

Set active capture device selected by device ID with needed capability object. It calls setActiveCaptureDevice to update active device and issue notification

Returns:
the result of the operation
See also:
GSStatus, setActiveCaptureDevice
- (NSArray*) systemAudioDevices

Returns the list of all audio input/output devices.

Returns:
an array of all audio devices.
- (NSArray*) systemCaptureDevices

Returns the list of all capture devices.

Returns:
an array of all capture devices.
- (GSResult) useAudioInputDevice: (id< GSAudioDevice >)  device

This method should be called to set active audio input device. It calls setActiveAudioInputDevice to update active device and issue notification

Parameters:
devicethe device to be used as the audio input device (e.g. microphone)
Returns:
the operation result
See also:
GSResult, setActiveAudioInputDevice
- (GSResult) useAudioOutputDevice: (id< GSAudioDevice >)  device

This method should be called to set active audio output device. It calls setActiveAudioOutputDevice to update active device and issue notification

Parameters:
devicethe device to be used as the audio output device (e.g. speaker)
Returns:
the opertaion result
See also:
GSResult, setActiveAudioOutputDevice
- (GSResult) useCaptureDevice: (id< GSCaptureDevice >)  device

This method should be called to set active capture device. It calls setActiveCaptureDevice to update active device and issue notification

Parameters:
devicethe device to be used as the capture device (e.g. camera)
Returns:
the opertaion result
See also:
GSResult, setActiveCaptureDevice
- (GSResult) useRingerDevice: (id< GSAudioDevice >)  device

This method should be called to set active ringer device. It calls setActiveRingerDevice to update active device and issue notification

Parameters:
devicethe device to be used as the audio output device (e.g. speaker)
Returns:
the opertaion result
See also:
GSResult, setActiveRingerDevice
- (int) videoCapabilitiesCount: (int)  deviceId

Get number of capture device capabilities for the capture device selected by device ID.

Returns:
number of capabilities
- (GSCaptureCapability*) videoCapability: (int)  deviceId
capabilityIndex: (int)  capIndex 

Get capture capability selected by index for the capture device selected by device ID.

Returns:
capture capability object

Property Documentation

- (id<GSDeviceNotificationDelegate>) notificationDelegate
readwritenonatomicretain

Get/set the delegate that will be used to recieve notifications about device state

Reimplemented in GSSipDeviceManager.

Definition at line 271 of file GSDeviceManager.h.

- (id<GSDevicePolicyDelegate>) policyDelegate
readwritenonatomicretain

Get/set the delegate that will be used to specify the device manager's behavior.

Reimplemented in GSSipDeviceManager.

Definition at line 276 of file GSDeviceManager.h.


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