mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-10-29 05:40:23 -04:00
5c0ab52145
This patch adds a small message handler to the core which enables
clients to list available handlers via the list-handlers message.
Command: pacmd send-message /core list-handlers
pactl can be used with the same parameters.
The patch also introduces a convention for the return string.
It consists of a list of elements where curly braces are used
to separate elements. Each element can itself contain further
elements. For example consider a message that returns multiple
elements which each contain an integer and an array of float.
A response string would look like that:
{{Integer} {{1st float} {2nd float} ...}}{...}
Part-of: <https://gitlab.freedesktop.org/pulseaudio/pulseaudio/-/merge_requests/51>
24 lines
1.3 KiB
Text
24 lines
1.3 KiB
Text
Message API reference
|
|
|
|
The message API allows any object within pulseaudio to register a message
|
|
handler. A message handler is a function that can be called by clients using
|
|
PA_COMMAND_SEND_OBJECT_MESSAGE. A message consists at least of an object path
|
|
and a message command, both specified as strings. Additional parameters can
|
|
be specified using a single string, but are not mandatory. The message handler
|
|
returns an error number as defined in def.h and also returns a string in
|
|
the "response" variable. If the string is not empty it consists of elements.
|
|
Curly braces are used to separate elements. Each element can itself contain
|
|
further elements. For example consider a message that returns multiple elements
|
|
which each contain an integer and an array of float. A response string would
|
|
look like that:
|
|
{{Integer} {{1st float} {2nd float} ...}}{...}
|
|
Any characters that are not enclosed in curly braces are ignored (all characters
|
|
between { and {, between } and } and between } and {). The same syntax is used
|
|
to specify message parameters. The following reference lists available messages,
|
|
their parameters and return values. If a return value is enclosed in {}, this
|
|
means that multiple elements of the same type may be returned.
|
|
|
|
Object path: /core
|
|
Message: list-handlers
|
|
Parameters: None
|
|
Return value: {{{Handler name} {Description}} ...}
|