sessiond_dbus

Contents

• Functions

Modules

• sessiond-dbus

Module sessiond-dbus

A library for interfacing with the sessiond DBus service.

Usage:

session = require("sessiond_dbus")

-- Increase the 'default' backlight's brightness by 10.
session.backlights.default.inc_brightness(10)

-- Set the 'default' backlight's brightness to 50.
session.backlights.default.set_brightness(50)

-- Decrease 'intel_backlight' brightness by 100.
session.backlights.intel_backlight.dec_brightness(100)

-- Increase the 'default' audio sink's volume by 0.1.
session.audiosinks.default.inc_volume(0.1)

-- Toggle the 'default' audio sink's mute state.
session.audiosinks.default.toggle_mute()

-- Lock the session.
session.lock()

-- Inhibit.
id = session.inhibit('chromium', 'media')

-- Stop inhibitor.
session.uninhibit(id)

-- Connect callback to sessiond DBus signal.
session.connect_signal("PrepareForSleep", function (state)
    if state then
        print("Preparing for sleep...")
    end
end)

-- Add function to be called when the DBus service appears.
session.add_hook(function (appear)
    if appear then
        print("Service appeared")
    end
end)

Info:

• Copyright: 2020 James Reed
• License: MIT
• Author: James Reed

Functions

backlights.default.inc_brightness (i)	Increase backlight brightness.
backlights.default.dec_brightness (i)	Decrease backlight brightness.
backlights.default.set_brightness (i)	Set backlight brightness.
audiosinks.default.inc_volume (i)	Increase audio sink volume.
audiosinks.default.dec_volume (i)	Decrease audio sink volume.
audiosinks.default.set_volume (i)	Set audio sink volume.
audiosinks.default.set_mute (m)	Set audio sink mute state.
audiosinks.default.toggle_mute ()	Toggle audio sink mute state.
audiosinks.default.update ()	Call on_default_audiosink_change function if sink is default.
lock ()	Lock the current session.
inhibit (who, why)	Inhibit inactivity.
uninhibit (id)	Stop an inhibitor.
connect_signal (name, cb)	Connect callback to sessiond DBus signal.
add_hook (func)	Add a function to be called when the DBus service appears or disappears.
connect ()	Connect to sessiond DBus service.

Functions

backlights.default.inc_brightness (i)

Increase backlight brightness.

Parameters:

• i Increase by given value

backlights.default.dec_brightness (i)

Decrease backlight brightness.

Parameters:

• i Decrease by given value

backlights.default.set_brightness (i)

Set backlight brightness.

Parameters:

• i Brightness value

audiosinks.default.inc_volume (i)

Increase audio sink volume.

Parameters:

• i Increase by given value

audiosinks.default.dec_volume (i)

Decrease audio sink volume.

Parameters:

• i Decrease by given value

audiosinks.default.set_volume (i)

Set audio sink volume.

Parameters:

• i Volume value

audiosinks.default.set_mute (m)

Set audio sink mute state.

Parameters:

• m Mute state

audiosinks.default.toggle_mute ()

Toggle audio sink mute state.

audiosinks.default.update ()

Call on_default_audiosink_change function if sink is default.

lock ()

Lock the current session.

inhibit (who, why)

Inhibit inactivity.

Parameters:

• who A string describing who is inhibiting.
• why A string describing why the inhibitor is running.

Returns:

An ID used to stop the inhibitor.

uninhibit (id)

Stop an inhibitor.

Parameters:

• id The ID of the inhibitor to stop.

connect_signal (name, cb)

Connect callback to sessiond DBus signal.

Parameters:

• name Name of signal.
• cb Callback function.

add_hook (func)

Add a function to be called when the DBus service appears or disappears.

Parameters:

• func Hook function, with appear state as its only argument.

connect ()

Connect to sessiond DBus service.