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

List of all members.

Public Member Functions

(id< GSDevice >) - activeInputDeviceForMedia:
(id< GSDevice >) - activeOutputDeviceForMedia:
(GSResult) - useInputDevice:forMedia:
(GSResult) - useOutputDevice:forMedia:
(NSArray *) - systemDevices
(NSArray *) - systemDevicesForMedia:
(NSArray *) - systemDevicesForMedia:forInput:forOutput:

Properties

id< GSDeviceNotificationDelegatenotificationDelegate
id< GSDevicePolicyDelegatepolicyDelegate
GSFlagState headsetAvailable
BOOL headsetInAvailable
BOOL headsetOutAvailable

Detailed Description

Definition at line 15 of file GSDeviceManager.h.


Member Function Documentation

- (id<GSDevice>) activeInputDeviceForMedia: (GSMedia *)  media

Retrieve the input device (e.g. microphone) that is currently used for the specified media type.

Parameters:
mediathe media type for which to retrieve the input device
Returns:
the currently active input device
- (id<GSDevice>) activeOutputDeviceForMedia: (GSMedia *)  media

Retrieve the output device (e.g. speaker) that is currently used for the specified media type.

Parameters:
mediathe media type for which to retrieve the output device
Returns:
the currently active output device
- (NSArray*) systemDevices

Returns the list of all input/output devices configured in the system.

Returns:
an array of devices.
- (NSArray*) systemDevicesForMedia: (GSMedia *)  media

Returns the list of all input/output devices that support the specified media type.

Parameters:
mediaspecifies the media type that the returned devices should support
Returns:
an array of devices.
- (NSArray*) systemDevicesForMedia: (GSMedia *)  media
forInput: (BOOL)  forInput
forOutput: (BOOL)  forOutput 

Returns a list of devices which match the specified filters.

Parameters:
mediaif specified, allows the user to retrieve devices that support the specified media type
forInputif YES, input devices will be included, if NO, input devices will not be included
forOutputif YES, output devices will be included, if NO, output devices will not be included
Returns:
an array of devices.
- (GSResult) useInputDevice: (id< GSDevice >)  device
forMedia: (GSMedia *)  media 

This method should be called to set the input device for the specified media.

Parameters:
devicethe device to be used as the input device (e.g. microphone)
mediathe media type for which this input device will be used (e.g. audio)
- (GSResult) useOutputDevice: (id< GSDevice >)  device
forMedia: (GSMedia *)  media 

This method should be called to set the output device for the specified media.

Parameters:
devicethe device to be used as the output device (e.g. speaker)
mediathe media type for which this output device will be used (e.g. audio)

Property Documentation

- (GSFlagState) headsetAvailable
readwritenonatomicassign

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

Definition at line 94 of file GSDeviceManager.h.

- (BOOL) headsetInAvailable
readwritenonatomicassign

Get the headset In device available to support auto answer behavior.

Returns:
True if headset IN device is available to use
False if headset IN device is Not available to use

Definition at line 102 of file GSDeviceManager.h.

- (BOOL) headsetOutAvailable
readwritenonatomicassign

Get the headset Out device available to support auto answer behavior.

Returns:
True if headset OUT device is available to use
False if headset OUT device is Not available to use

Definition at line 110 of file GSDeviceManager.h.

- (id<GSDeviceNotificationDelegate>) notificationDelegate
readwritenonatomicassign

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

Definition at line 80 of file GSDeviceManager.h.

- (id<GSDevicePolicyDelegate>) policyDelegate
readwritenonatomicassign

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

Definition at line 85 of file GSDeviceManager.h.


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