freesmartphone.org Framework DBus Interface Specification

org.freesmartphone.Audio.Manager

Description

Unknown

Namespace

org.freesmartphone.Audio.Manager

Methods

Signals

Errors

Methods

SetMode ( s )

Description: Set the current audio mode. Currently there is only a difference between normal and call. Normal means all audio use when not in a phone call and call means all audio within a phone call.

Parameters

s: mode

GetMode ( ) → s

Description: Get the current audio mode which is used.

Returns

s: mode

SetDevice ( s )

Description: Set the current audio output device which is used only within the current mode. If you switch mode then the manager will switch even the output to the last used one in the new mode.

Parameters

s: name

GetDevice ( ) → s

Description: Get the current audio device.

Returns

s: device

PushDevice ( s )

Description: Push a new audio device onto the stack and active it.

Parameters

s: device

PullDevice ( ) → s

Description: Pull an audio device from the stack and activate the next one.

Returns

s: device

GetAvailableDevices ( s ) → as

Description: Get all available audio outputs for the specified audio mode.

Parameters

s: mode

Returns

as: outputs

GetVolume ( s ) → i

Parameters

s: control

Returns

i: volume

The volume in percent (0-100).

SetVolume ( si )

Parameters

s: control

i: volume

The volume in percent (0-100).

SetMute ( sb )

Description: Mute current output device.

Parameters

s: control

b: mute

GetMute ( s ) → b

Description: Mute current output device.

Parameters

s: control

Returns

b: mute

RegisterSession ( s ) → s

Description: Registering a audio session with the manager. Everytime a application wants to play audio it has to register a audio session for this so the audio daemon can control the played audio and maybe mutes the stream if another audio source is more important than the current played one.

Parameters

s: stream

Returns

s: token

ReleaseSession ( s )

Description: Release a audio session from the manager after audio playback is over.

Parameters

s: token

Signals

ModeChanged ( s )

Parameters

s: mode

DeviceChanged ( s )

Parameters

s: device

VolumeChanged ( si )

Parameters

s: control

i: volume

MuteChanged ( sb )

Parameters

s: control

b: mute

Errors

NotSupportedDevice

Description: Raised, if the device to process is unsupported by the used router.

DeviceStackUnderflow

Description: Raised, if there is no more device to pull from the stack.


| Specified 2008-2011 by the Freesmartphone.org team. | Join us and discuss further drafts smartphones-standards (at) linuxtogo (dot) org