Namespace

Lfb – 0.0

A library to trigger feedback (such as haptic feedback) via events sent by your application.

Version0.0.2
AuthorsPurism SPC
LicenseLGPL-2.1-or-later
Websitehttps://source.puri.sm/Librem5/feedbackd/
Sourcehttps://source.puri.sm/Librem5/feedbackd/

Build

C headerslibfeedback.h
pkg-config fileslibfeedback-0.0

Dependencies

Classes

Event

An event triggering feedback to the user.

GdbusFeedbackProxy

The LfbGdbusFeedbackProxy structure contains only private data and should only be accessed using the provided API.

GdbusFeedbackSkeleton

The LfbGdbusFeedbackSkeleton structure contains only private data and should only be accessed using the provided API.

Interfaces

GdbusFeedback

Abstract interface type for the D-Bus interface org.sigxcpu.Feedback.

Enumerations

EventEndReason

Enum values used to indicate why the feedbacks for an event ended.

EventState

Enum values to indicate the current state of the feedbacks triggered by an event.

Functions

get_app_id

Get the application id set via lfb_set_app_id()().

get_feedback_profile

Gets the currently set feedback profile.

get_proxy

This can be used to access the lower level API e.g. to listen to property changes. The object is not owned by the caller. Don’t unref it after use.

init

Initialize libfeedback. This must be called before any other of libfeedback’s functions.

is_initted

Gets whether or not libfeedback is initialized.

set_app_id

Sets the application id.

set_feedback_profile

Sets the active feedback profile to #profile. It is up to the feedback daemon to ignore this request. The new profile might not become active immediately. You can listen to changes LfbGdbusFeedbacks ::profile property to get notified when it takes effect.

uninit

Uninitialize the library when no longer used. Usually called on program shutdown.