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

#import <GSAudioDevice.h>

Inheritance diagram for <GSAudioDevice>:
GSSipAudioDevice

List of all members.

Public Member Functions

(GSResult) - changeSpeakerVolumeTo:
(int) - getSpeakerVolume
(GSResult) - changeMicVolumeTo:
(int) - getMicVolume

Properties

NSString * name
int deviceId
BOOL canInput
BOOL canOutput
BOOL hasVolumeControl
int speakerVolume
int micVolume

Detailed Description

Defines functionality specific to an audio device. Note this device will implement GSAudioDevice protocol.

Definition at line 16 of file GSAudioDevice.h.


Member Function Documentation

- (GSResult) changeMicVolumeTo: (int)  value

Changes the current mic volume to the specified value.

Parameters:
valuea number between 0 and 255 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 255 representing the current speaker volume.
Returns:
the result of the operation
- (int) getMicVolume

Get the current mic volume.

Returns:
the value a number between 0 and 255 representing the current mic volume.
- (int) getSpeakerVolume

Get the currently used speaker volume.

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

Property Documentation

- (BOOL) canInput
readnonatomicassign

Specifies whether the device can be used for input operations

Reimplemented in GSSipAudioDevice.

Definition at line 31 of file GSAudioDevice.h.

- (BOOL) canOutput
readnonatomicassign

Specifies whether the device can be used for output operations

Reimplemented in GSSipAudioDevice.

Definition at line 36 of file GSAudioDevice.h.

- (int) deviceId
readwritenonatomicassign

The ID of the device.

Reimplemented in GSSipAudioDevice.

Definition at line 26 of file GSAudioDevice.h.

- (BOOL) hasVolumeControl
readwritenonatomicassign

Specifies whether the device has volume control operations

Reimplemented in GSSipAudioDevice.

Definition at line 41 of file GSAudioDevice.h.

- (int) micVolume
readwritenonatomicassign

Used to get speaker volume.

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

Reimplemented in GSSipAudioDevice.

Definition at line 55 of file GSAudioDevice.h.

- (NSString*) name
readwritenonatomicretain

The name of the device.

Reimplemented in GSSipAudioDevice.

Definition at line 21 of file GSAudioDevice.h.

- (int) speakerVolume
readwritenonatomicassign

Used to get speaker volume.

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

Reimplemented in GSSipAudioDevice.

Definition at line 48 of file GSAudioDevice.h.


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