sessiond-dbus.8

sessiond-dbus - sessiond DBus service information

DBus service information.

sessiond provides a DBus service on the session bus at the well-known name org.sessiond.session1.

The /org/sessiond/session1 object implements the org.sessiond.session1.Session interface, which exposes the following methods, properties, and signals:

• Lock

  Lock the session. Returns an error if the session is already locked.

• Unlock

  Unlock the session. Returns an error if the session is not locked.

• Inhibit

  Inhibit inactivity. The session will always be considered active if at least one inhibitor is running. Takes two arguments:

  • who

    A string describing who is inhibiting.

  • why

    A string describing why the inhibitor is running.

  Returns a unique ID used to stop the inhibitor.

• Uninhibit

  Stop an inhibitor. Takes one argument:

  • id

    The unique ID of the inhibitor to stop.

  Returns an error if the ID is not valid or does not exist.

• StopInhibitors

  Stop running inhibitors. Returns the number of inhibitors stopped.

• ListInhibitors

  List running inhibitors. Returns a dictionary mapping IDs to tuples of the creation timestamp and who and why strings.

• InhibitedHint

  The inhibited state of the session.

• LockedHint

  The locked state of the session.

• IdleHint

  The idle state of the session.

• IdleSinceHint

  The timestamp of the last change to IdleHint.

• IdleSinceHintMonotonic

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

• Backlights

  An array of object paths to exported Backlights.

• AudioSinks

  An array of object paths to exported AudioSinks.

• DefaultAudioSink

  Object path to the default AudioSink.

• Version

  The version of sessiond.

• Lock

  Emitted when the session is locked. LockedHint will be true.

• Unlock

  Emitted when the session is unlocked. LockedHint will be false.

• Idle

  Emitted when the session becomes idle. IdleHint will be true.

• Active

  Emitted when activity resumes in an inactive session. IdleHint will be false.

• Inactive seconds

  Emitted when the session becomes inactive, with the seconds argument being the number of seconds since activity. Its value will be equal to either the IdleSec or DimSec configuration option (see sessiond.conf(5)), or the InactiveSec option of a hook with an Inactive trigger (see sessiond-hooks(5)).

• PrepareForSleep state

  Emitted before and after system sleep, with the state argument being true and false respectively.

• PrepareForShutdown state

  Emitted before and after system shutdown, with the state argument being true and false respectively.

• AddBacklight path

  Emitted when a backlight is added, with path being the object path of the new backlight.

• RemoveBacklight path

  Emitted when a backlight is removed, with path being the old object path of the backlight.

• AddAudioSink path

  Emitted when an audio sink is added, with path being the object path of the new audio sink.

• RemoveAudioSink path

  Emitted when an audio sink is removed, with path being the old object path of the audio sink.

• ChangeDefaultAudioSink path

  Emitted when the default audio sink changes, with path being the object path of the default audio sink.

The /org/sessiond/session1/backlight/* objects implement the org.sessiond.session1.Backlight interface, which exposes the following methods and properties:

• SetBrightness

  Set the brightness of the backlight. Takes one argument:

  • brightness

    An unsigned integer value.

  Returns an error if unable to set brightness.

• IncBrightness

  Increment the brightness of the backlight. Takes one argument:

  • value

    An integer value added to the backlight’s current brightness.

  Returns the new brightness value or an error if unable to set brightness.

• Online

  True if the backlight is online, false otherwise.

• DevPath

  Path to the backlight device without the sys mount point.

• Name

  Name of the backlight.

• Subsystem

  Subsystem to which the backlight belongs. Possible values are: “backlight” or “leds”.

• SysPath

  Path to the device via sys mount point. Format is: “/sys/class/Subsystem/Name”.

• Brightness

  Current brightness of backlight.

• MaxBrightness

  Max brightness of backlight.

The /org/sessiond/session1/audiosink/* objects implement the org.sessiond.session1.AudioSink interface, which exposes the following methods, properties, and signals:

• SetVolume

  Set the volume of the audio sink. Takes one argument:

  • volume

    A double value.

  Returns an error if unable to set volume.

• IncVolume

  Increment the volume of the audio sink. Takes one argument:

  • value

    A double value added to the audio sink’s current volume.

  Returns the new volume value or an error if unable to set volume.

• SetMute

  Set the mute state of the audio sink. Takes one argument:

  • mute

    A boolean value indicating the mute state.

  Returns an error if unable to set mute state.

• ToggleMute

  Toggle the mute state of the audio sink. Returns the new mute state or an error if unable to set mute state.

• Id

  ID of the audio sink.

• Name

  Name of the audio sink.

• Mute

  Mute state of the audio sink.

• Volume

  Volume of the audio sink.

• ChangeMute mute

  Emitted when the mute state changes, with the mute argument being the new mute state.

• ChangeVolume volume

  Emitted when the volume changes, with the volume argument being the new volume value.

• For complete introspection data, use gdbus(1):

  gdbus introspect –session –dest org.sessiond.session1 –object-path /org/sessiond/session1

James Reed jcrd@sessiond.org

Bugs and issues can be reported here: https://github.com/jcrd/sessiond/issues

Copyright 2018-2020 James Reed. sessiond is licensed under the GNU General Public License v3.0 or later.

gdbus(1), systemd-logind.service(8)