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< GSCaptureDevice >) - activeCaptureDevice
(GSResult) - useAudioInputDevice:
(GSResult) - useAudioOutputDevice:
(GSResult) - useCaptureDevice:
(void) - setActiveAudioInputDevice:
(void) - setActiveAudioOutputDevice:
(void) - setActiveCaptureDevice:
(NSArray *) - systemAudioDevices
(NSArray *) - systemCaptureDevices
(GSFlagState) - headsetAvailable
(id< GSAudioDevice >) - currentAudioDeviceForInput
(id< GSAudioDevice >) - currentAudioDeviceForOutput
(id< GSCaptureDevice >) - currentCaptureDevice
(GSDeviceArray *) - getAudioInDevices:outDevices:
(GSDeviceArray *) - getCaptureDevices
(id< GSAudioDevice >) - getAudioDeviceById:
(id< GSCaptureDevice >) - getCaptureDeviceById:
(int) - videoCapabilitiesCount:
(GSCaptureCapability *) - videoCapability:capabilityIndex:
(GSStatus *) - setCaptureDevice:withCapability:
(GSResult) - releaseCaptureDevice
(BOOL) - hasCaptureDevice
(void) - refreshDevices
(void) - configure
(void) - configureHeadset
(void) - configureAudioDevices
(void) - configureDefaultAudioInputDevice
(void) - configureDefaultAudioOutputDevice
(void) - configureCaptureDevice
(void) - deviceChange

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
- (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
- (GSResult) releaseCaptureDevice

Release local video capture device

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

This method should be called to set the audio input device.

Parameters:
devicethe device to be used as the audio input device (e.g. microphone)
- (void) setActiveAudioOutputDevice: (id< GSAudioDevice >)  device

This method should be called to set the audio output device.

Parameters:
devicethe device to be used as the audio output device (e.g. speaker)
- (void) setActiveCaptureDevice: (id< GSCaptureDevice >)  device

This method should be called to set the capture device.

Parameters:
devicethe device to be used as the capture device (e.g. camera)
- (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 the audio input device.

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

This method should be called to set the audio output device.

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

This method should be called to set the capture device.

Parameters:
devicethe device to be used as the capture device (e.g. camera)
Returns:
the opertaion result
See also:
GSResult

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 149 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 154 of file GSDeviceManager.h.


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