Python API

An interface to a sessiond AudioSink object.

• Parameters

  id – The audio sink’s ID

Audio sink’s ID.

• Returns

  Audio sink’s ID

Increment the audio sink’s volume.

• Parameters

  v – Volume value by which to increment

• Returns

  The new volume value

• Raises

  dbus.exception.DBusException – Raised if unable to increment volume

Audio sink’s mute state.

• Returns

  True if muted, False otherwise

Audio sink’s name.

• Returns

  Audio sink’s name

Set the audio sink’s mute state.

• Parameters

  m – Mute state

• Raises

  dbus.exception.DBusException – Raised if unable to set mute state

Set the audio sink’s volume.

• Parameters

  v – Volume value

• Raises

  dbus.exception.DBusException – Raised if unable to set volume

Toggle the audio sink’s mute state.

• Returns

  The new mute state

• Raises

  dbus.exception.DBusException – Raised if unable to toggle mute state

Audio sink’s volume.

• Returns

  Audio sink’s volume

An interface to a sessiond Backlight object.

• Parameters

  name – The backlight’s name

Backlight’s brightness.

• Returns

  Brightness value

Backlight device’s path.

• Returns

  Path to the backlight device without the sys mount point

Increment the backlight’s brightness.

• Parameters

  v – Brightness value by which to increment

• Returns

  The new brightness value

• Raises

  dbus.exception.DBusException – Raised if unable to set brightness

Backlight’s maximum brightness.

• Returns

  Maximum brightness value

Backlight’s online status.

• Returns

  True if online, False otherwise

Set the backlight’s brightness.

• Parameters

  v – Brightness value

• Raises

  dbus.exception.DBusException – Raised if unable to set brightness

Backlight’s subsystem.

• Returns

  Name of backlight’s subsystem

Backlight device’s /sys path.

• Returns

  Path to the device via sys mount point

Base interface to the sessiond DBus service.

• Parameters

  • path – DBus object path

  • iface – DBus interface name

Convert a DBus-typed value to its python-type.

• Parameters

  val – Value to convert

• Returns

  The python-typed value

Get all DBus properties and values.

• Returns

  A dictionary mapping property names to values

Get a DBus property’s value.

• Parameters

  name – The property’s name

• Returns

  The property’s value

An interface to sessiond’s Session.

List of audio sinks.

• Returns

  A list of AudioSink DBus object paths

List of backlights.

• Returns

  A list of Backlight DBus object paths

Get the default audio sink.

• Returns

  The default audio sink’s DBus object path

Session idle hint.

• Returns

  True if session is idle, False otherwise

The timestamp of the last change to IdleHint.

• Returns

  The timestamp

The timestamp of the last change to IdleHint in monotonic time.

• Returns

  The timestamp

Add an inhibitor.

• Parameters

  • who – A string describing who is inhibiting

  • why – A string describing why this inhibitor is running

• Returns

  The inhibitor’s ID

Session inhibited hint.

• Returns

  True if session is inhibited, False otherwise

List running inhibitors.

• Returns

  A dictionary mapping IDs to tuples of the creation timestamp and ‘who’ and ‘why’ strings

Lock the session.

• Raises

  dbus.exception.DBusException – Raised if the session is already locked

Session locked hint.

• Returns

  True if session is locked, False otherwise

Stop running inhibitors.

• Returns

  The number of inhibitors stopped

Remove an inhibitor.

• Parameters

  id – The inhibitor’s ID

• Raises

  dbus.exception.DBusException – Raised if the ID is not valid or does not exist

Unlock the session.

• Raises

  dbus.exception.DBusException – Raised if the session is not locked

sessiond version.

• Returns

  sessiond’s version string