Nemo/Audio/MainVolume

MainVolume D-Bus interface

For PulseAudio's D-Bus interface see http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/Developer/Clients/DBus/

Overview

MainVolume is module for controlling system volume from single point with easy interface, without need to know about the volume internals of PulseAudio. When module-meego-mainvolume module is loaded, following interface is exposed through PulseAudio's peer-to-peer D-Bus interface (see notes about connecting from PulseAudio documentation, http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/Developer/Clients/DBus/ConnectingToServer/).

MainVolume functionality

• Object /com/meego/mainvolume2 implements interface com.Meego.MainVolume2.

Interface major version 2, minor version 1

com.Meego.MainVolume2

Properties

• InterfaceRevision : Uint32 (r)
  • Return current interface minor revision number
• StepCount : Uint32 (r)
  • Return steps in currently active routing (step count may change whenever routing changes)
• CurrentStep : Uint32 (rw)
  • Set/get currently active step. Range is 0..StepCount-1
• HighVolumeStep : Uint32 (r)
  • If currently active routing has high volume step defined (for example with headphones, there might be some high steps that are deemed as harmful in long term listening, so these steps can be defined as "high volume steps"), this has value greater than 0. 0 means high volume steps aren't in use. High volume step is the first step above safe volume, so last safe volume step is HighVolumeStep - 1.

Signals

• StepsUpdated (StepCount: Uint32, CurrentStep: Uint32)
  • This signal is sent whenever either StepCount or CurrentStep or both changes. If StepCount changes that is usually also an indication of changed routing, but volume controller should not care about the routing.
• NotifyListeningTime (ListeningTime: Uint32)
  • Signal is sent when listening time warning should be issued to user. For example with headphones, one may define maximum safe continuous listening time before user should be notified. This signal is sent both when device with listening time connects for the first time and then continuously after listening time is full.
• NotifyHighVolume (SafeStep: Uint32)
  • If routing has high volume step defined and routing changes, this signal is sent with SafeStep > 0. If routing does not have high volume step defined, this signal is sent with SafeStep 0.
• CallStatus (Status: String)
  • Whenever voice call is state changes to active or inactive, this signal is sent with string "active" and "inactive", respectively.