SIP Endpoint SDK for OS X
 All Classes Functions Properties
GSSipAudioDevice Class Reference
Inheritance diagram for GSSipAudioDevice:
GSSipAbstractionObject <GSAudioDevice>

List of all members.

Public Member Functions

(id) - initWithLogger:core:
- Public Member Functions inherited from GSSipAbstractionObject
(id) - initWithLogger:
(id) - initWithLogger:configData:
- Public Member Functions inherited from
(GSResult) - changeSpeakerVolumeTo:
(int) - getSpeakerVolume
(GSResult) - changeMicVolumeTo:
(int) - getMicVolume

Properties

NSString * name
int deviceId
BOOL canInput
BOOL canOutput
BOOL hasVolumeControl
int speakerVolume
int micVolume
- Properties inherited from GSSipAbstractionObject
id< GSLoggerlogger
NSMutableDictionary * configuration
GSepCoreepCore
- Properties inherited from

Detailed Description

Definition at line 12 of file GSSipAudioDevice.h.


Member Function Documentation

- (id) initWithLogger: (id< GSLogger >)  theLogger
core: (GSepCore *)  theCore 

Initialize an audio device object with logger.

Parameters:
currentlyused GSLogger.
GSepCore.
Returns:
audio device object

Implements GSSipAbstractionObject.


Property Documentation

- (BOOL) canInput
readwritenonatomicassign

Specifies whether the device can be used for input operations

Reimplemented from <GSAudioDevice>.

Definition at line 17 of file GSSipAudioDevice.h.

- (BOOL) canOutput
readwritenonatomicassign

Specifies whether the device can be used for output operations

Reimplemented from <GSAudioDevice>.

Definition at line 18 of file GSSipAudioDevice.h.

- (int) deviceId
readwritenonatomicassign

The ID of the device.

Reimplemented from <GSAudioDevice>.

Definition at line 15 of file GSSipAudioDevice.h.

- (BOOL) hasVolumeControl
readwritenonatomicassign

Specifies whether the device has volume control operations

Reimplemented from <GSAudioDevice>.

Definition at line 20 of file GSSipAudioDevice.h.

- (int) micVolume
readwritenonatomicassign

Used to get speaker volume.

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

Reimplemented from <GSAudioDevice>.

Definition at line 22 of file GSSipAudioDevice.h.

- (NSString *) name
readwritenonatomicretain

The name of the device.

Reimplemented from <GSAudioDevice>.

Definition at line 14 of file GSSipAudioDevice.h.

- (int) speakerVolume
readwritenonatomicassign

Used to get speaker volume.

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

Reimplemented from <GSAudioDevice>.

Definition at line 21 of file GSSipAudioDevice.h.


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