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

#import <PolicyDelegates.h>

Inheritance diagram for <GSDevicePolicyDelegate>:
GSDefaultDevicePolicy

List of all members.

Public Member Functions

(id< GSAudioDevice >) - chooseActiveAudioInputDeviceFromList:
(id< GSAudioDevice >) - chooseActiveAudioOutputDeviceFromList:
(id< GSAudioDevice >) - chooseActiveHeadsetInputDeviceFromList:
(id< GSAudioDevice >) - chooseActiveHeadsetOutputDeviceFromList:
(id< GSCaptureDevice >) - chooseActiveCaptureDeviceFromList:
(GSFlagState) - headsetAvailable
(GSPolicyData *) - devicePolicyByQuery:

Detailed Description

This delegate is used to define aspects of the device manager's behavior.

Definition at line 60 of file PolicyDelegates.h.


Member Function Documentation

- (id<GSAudioDevice>) chooseActiveAudioInputDeviceFromList: (NSArray *)  deviceList
required

Implement to define the audio device that should be used for input. This method will be called on startup as well as when a device has been connected or disconnected.

Parameters:
deviceListthe list of current system input devices
Returns:
the device to use for input
- (id<GSAudioDevice>) chooseActiveAudioOutputDeviceFromList: (NSArray *)  deviceList
required

Implement to define the audio device that should be used for output. This method will be called on startup as well as when a device has been connected or disconnected.

Parameters:
deviceListthe list of current system input devices
Returns:
the device to use for input
- (id<GSCaptureDevice>) chooseActiveCaptureDeviceFromList: (NSArray *)  deviceList
required

Implement to define the device that should be used for capture. This method will be called on startup as well as when a device has been connected or disconnected.

Parameters:
deviceListthe list of current system output devices
Returns:
the device to use for capture
- (id<GSAudioDevice>) chooseActiveHeadsetInputDeviceFromList: (NSArray *)  deviceList
required

Implement to define the headset audio device that should be used for input. This method will be called on startup as well as when a device has been connected or disconnected.

Parameters:
deviceListthe list of current system input devices
Returns:
the device to use for input
- (id<GSAudioDevice>) chooseActiveHeadsetOutputDeviceFromList: (NSArray *)  deviceList
required

Implement to define the headset audio device that should be used for output. This method will be called on startup as well as when a device has been connected or disconnected.

Parameters:
deviceListthe list of current system input devices
Returns:
the device to use for input
- (GSPolicyData*) devicePolicyByQuery: (DevicePolicyQuery)  query
required

Implement to query the endpoint device policy by device policy query

Parameters:
devicepolicy query
Returns:
policy data with possible int and string values depends on query.
See also:
DevicePolicyQuery
GSPolicyData
- (GSFlagState) headsetAvailable
required

Implement to define if the headset audio device is available for session.

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

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