PipeWire: spa/node/command.h Source File

PipeWire 0.3.46

command.h
Go to the documentation of this file.
1/* Simple Plugin API
2 *
3 * Copyright © 2018 Wim Taymans
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 */
24
25#ifndef SPA_COMMAND_NODE_H
26#define SPA_COMMAND_NODE_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
37#include <spa/pod/command.h>
38
39/* object id of SPA_TYPE_COMMAND_Node */
40enum spa_node_command {
41 SPA_NODE_COMMAND_Suspend,
43 SPA_NODE_COMMAND_Pause,
45 SPA_NODE_COMMAND_Start,
47 SPA_NODE_COMMAND_Enable,
48 SPA_NODE_COMMAND_Disable,
49 SPA_NODE_COMMAND_Flush,
50 SPA_NODE_COMMAND_Drain,
51 SPA_NODE_COMMAND_Marker,
52 SPA_NODE_COMMAND_ParamBegin,
56 SPA_NODE_COMMAND_ParamEnd,
57 SPA_NODE_COMMAND_RequestProcess,
59};
60
61#define SPA_NODE_COMMAND_ID(cmd) SPA_COMMAND_ID(cmd, SPA_TYPE_COMMAND_Node)
62#define SPA_NODE_COMMAND_INIT(id) SPA_COMMAND_INIT(SPA_TYPE_COMMAND_Node, id)
63
64
69#ifdef __cplusplus
70} /* extern "C" */
71#endif
72
73#endif /* SPA_COMMAND_NODE_H */
spa_node_command
spa_node_command
Definition: command.h:45
SPA_NODE_COMMAND_RequestProcess
@ SPA_NODE_COMMAND_RequestProcess
Sent to a driver when some other node emitted the RequestProcess event.
Definition: command.h:62
SPA_NODE_COMMAND_Disable
@ SPA_NODE_COMMAND_Disable
Definition: command.h:53
SPA_NODE_COMMAND_Flush
@ SPA_NODE_COMMAND_Flush
Definition: command.h:54
SPA_NODE_COMMAND_Enable
@ SPA_NODE_COMMAND_Enable
Definition: command.h:52
SPA_NODE_COMMAND_Suspend
@ SPA_NODE_COMMAND_Suspend
suspend a node, this removes all configured formats and closes any devices
Definition: command.h:46
SPA_NODE_COMMAND_Pause
@ SPA_NODE_COMMAND_Pause
pause a node.
Definition: command.h:48
SPA_NODE_COMMAND_Drain
@ SPA_NODE_COMMAND_Drain
Definition: command.h:55
SPA_NODE_COMMAND_Marker
@ SPA_NODE_COMMAND_Marker
Definition: command.h:56
SPA_NODE_COMMAND_ParamBegin
@ SPA_NODE_COMMAND_ParamBegin
begin a set of parameter enumerations or configuration that require the device to remain opened,...
Definition: command.h:57
SPA_NODE_COMMAND_Start
@ SPA_NODE_COMMAND_Start
start a node, this makes it start emitting scheduling events
Definition: command.h:50
SPA_NODE_COMMAND_ParamEnd
@ SPA_NODE_COMMAND_ParamEnd
end a transaction
Definition: command.h:61
command.h
spa/pod/command.h