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

#import <GSAudioDevice.h>

Inheritance diagram for <GSAudioDevice>:
<GSDevice>

List of all members.

Public Member Functions

(GSResult) - routeMicSignalFrom:
(GSResult) - routeSpeakerSignalTo:
(BOOL) - supportsCapabilityForInput:
(BOOL) - supportsCapabilityForOutput:
(GSResult) - changeSpeakerVolumeTo:
(GSResult) - changeMicVolumeTo:
- Public Member Functions inherited from
(BOOL) - supportsMedia:

Properties

GSDeviceRoute micRoute
GSDeviceRoute speakerRoute
int speakerVolume
int micVolume
- Properties inherited from
NSString * name
NSString * driverName
BOOL canInput
BOOL canOutput

Detailed Description

Defines functionality specific to an audio device. Note that if a given device supports media of type "audio," this device will implement GSAudioDevice protocol.

Definition at line 16 of file GSAudioDevice.h.


Member Function Documentation

- (GSResult) changeMicVolumeTo: (int)  value

Changes the mic volume to the specified value.

Parameters:
valuea number between 0 and 100 representing the current mic volume.
Returns:
the result of the operation
- (GSResult) changeSpeakerVolumeTo: (int)  value

Changes the speaker volume to the specified value.

Parameters:
valuea number between 0 and 100 representing the current speaker volume.
Returns:
the result of the operation
- (GSResult) routeMicSignalFrom: (GSDeviceRoute)  route

Specifies where the mic signal is coming from.

Parameters:
routethe route the signal should take
Returns:
the result of the operation
- (GSResult) routeSpeakerSignalTo: (GSDeviceRoute)  route

Specifies where the audio signal should be played.

Parameters:
routethe route the signal should take
Returns:
the result of the operation
- (BOOL) supportsCapabilityForInput: (GSAudioDeviceCapability)  capability

Used to determine if the device supports the specified audio capability for the microphone

Parameters:
capabilitythe requested capability
Returns:
YES if the capability is supported, NO otherwise.
- (BOOL) supportsCapabilityForOutput: (GSAudioDeviceCapability)  capability

Used to determine if the device supports the specified audio capability for the speaker

Parameters:
capabilitythe requested capability
Returns:
YES if the capability is supported, NO otherwise.

Property Documentation

- (GSDeviceRoute) micRoute
readnonatomicassign

Get the current route for the microphone

Definition at line 21 of file GSAudioDevice.h.

- (int) micVolume
readnonatomicassign

Used to get speaker volume.

Returns:
a number between 0 and 100 representing the current mic volume.

Definition at line 76 of file GSAudioDevice.h.

- (GSDeviceRoute) speakerRoute
readnonatomicassign

Get the current route for the speaker

Definition at line 26 of file GSAudioDevice.h.

- (int) speakerVolume
readnonatomicassign

Used to get speaker volume.

Returns:
a number between 0 and 100 representing the current speaker volume.

Definition at line 69 of file GSAudioDevice.h.


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