PipeWire: spa/param/param.h Source File

PipeWire 1.6.5

Loading...
Searching...
No Matches
param.h
Go to the documentation of this file.
1/* Simple Plugin API */
2/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef SPA_PARAM_H
6#define SPA_PARAM_H
7
8#include <spa/utils/defs.h>
9
10#ifdef __cplusplus
11extern "C" {
12#endif
13
17
22
24enum spa_param_type {
25 SPA_PARAM_Invalid,
26 SPA_PARAM_PropInfo,
27 SPA_PARAM_Props,
28 SPA_PARAM_EnumFormat,
29 SPA_PARAM_Format,
30 SPA_PARAM_Buffers,
31 SPA_PARAM_Meta,
32 SPA_PARAM_IO,
33 SPA_PARAM_EnumProfile,
34 SPA_PARAM_Profile,
35 SPA_PARAM_EnumPortConfig,
36 SPA_PARAM_PortConfig,
37 SPA_PARAM_EnumRoute,
38 SPA_PARAM_Route,
39 SPA_PARAM_Control,
40 SPA_PARAM_Latency,
41 SPA_PARAM_ProcessLatency,
42 SPA_PARAM_Tag,
43 SPA_PARAM_PeerEnumFormat,
45 SPA_PARAM_Capability,
46 SPA_PARAM_PeerCapability,
48};
49
51 struct spa_param_info {
52 uint32_t id;
53#define SPA_PARAM_INFO_SERIAL (1<<0)
54
55#define SPA_PARAM_INFO_READ (1<<1)
56#define SPA_PARAM_INFO_WRITE (1<<2)
57#define SPA_PARAM_INFO_READWRITE (SPA_PARAM_INFO_WRITE|SPA_PARAM_INFO_READ)
58 uint32_t flags;
59 uint32_t user;
61 int32_t seq;
63 uint32_t padding[4];
64};
65
66#define SPA_PARAM_INFO(id,flags) ((struct spa_param_info){ (id), (flags) })
67
68 enum spa_param_bitorder {
69 SPA_PARAM_BITORDER_unknown,
70 SPA_PARAM_BITORDER_msb,
71 SPA_PARAM_BITORDER_lsb,
72};
73
74enum spa_param_availability {
75 SPA_PARAM_AVAILABILITY_unknown,
76 SPA_PARAM_AVAILABILITY_no,
77 SPA_PARAM_AVAILABILITY_yes,
78};
79
80#include <spa/param/buffers.h>
81#include <spa/param/profile.h>
82#include <spa/param/port-config.h>
83#include <spa/param/route.h>
84
88
89#ifdef __cplusplus
90} /* extern "C" */
91#endif
92
93#endif /* SPA_PARAM_H */
defs.h
spa/utils/defs.h
seq
uint32_t int seq
Definition core.h:432
id
uint32_t id
Definition core.h:432
spa_param_bitorder
spa_param_bitorder
Definition param.h:78
spa_param_type
spa_param_type
different parameter types that can be queried
Definition param.h:29
spa_param_availability
spa_param_availability
Definition param.h:84
SPA_PARAM_BITORDER_unknown
@ SPA_PARAM_BITORDER_unknown
unknown bitorder
Definition param.h:79
SPA_PARAM_BITORDER_msb
@ SPA_PARAM_BITORDER_msb
most significant bit
Definition param.h:80
SPA_PARAM_BITORDER_lsb
@ SPA_PARAM_BITORDER_lsb
least significant bit
Definition param.h:81
SPA_PARAM_Route
@ SPA_PARAM_Route
routing configuration as SPA_TYPE_OBJECT_ParamRoute
Definition param.h:43
SPA_PARAM_Capability
@ SPA_PARAM_Capability
capability info, a SPA_TYPE_OBJECT_ParamDict, Since 1.5.84
Definition param.h:50
SPA_PARAM_PeerCapability
@ SPA_PARAM_PeerCapability
peer capabilities, a SPA_TYPE_OBJECT_PeerParam with SPA_TYPE_OBJECT_ParamDict, since 1....
Definition param.h:51
SPA_PARAM_Tag
@ SPA_PARAM_Tag
tag reporting, a SPA_TYPE_OBJECT_ParamTag.
Definition param.h:47
SPA_PARAM_Format
@ SPA_PARAM_Format
configured format as SPA_TYPE_OBJECT_Format
Definition param.h:34
SPA_PARAM_EnumRoute
@ SPA_PARAM_EnumRoute
routing enumeration as SPA_TYPE_OBJECT_ParamRoute
Definition param.h:42
SPA_PARAM_Meta
@ SPA_PARAM_Meta
allowed metadata for buffers as SPA_TYPE_OBJECT_ParamMeta
Definition param.h:36
SPA_PARAM_IO
@ SPA_PARAM_IO
configurable IO areas as SPA_TYPE_OBJECT_ParamIO
Definition param.h:37
SPA_PARAM_EnumProfile
@ SPA_PARAM_EnumProfile
profile enumeration as SPA_TYPE_OBJECT_ParamProfile
Definition param.h:38
SPA_PARAM_EnumPortConfig
@ SPA_PARAM_EnumPortConfig
port configuration enumeration as SPA_TYPE_OBJECT_ParamPortConfig
Definition param.h:40
SPA_PARAM_EnumFormat
@ SPA_PARAM_EnumFormat
available formats as SPA_TYPE_OBJECT_Format
Definition param.h:33
SPA_PARAM_Profile
@ SPA_PARAM_Profile
profile configuration as SPA_TYPE_OBJECT_ParamProfile
Definition param.h:39
SPA_PARAM_Latency
@ SPA_PARAM_Latency
latency reporting, a SPA_TYPE_OBJECT_ParamLatency
Definition param.h:45
SPA_PARAM_PeerEnumFormat
@ SPA_PARAM_PeerEnumFormat
peer formats, a SPA_TYPE_OBJECT_PeerParam with SPA_TYPE_OBJECT_Format.
Definition param.h:48
SPA_PARAM_PortConfig
@ SPA_PARAM_PortConfig
port configuration as SPA_TYPE_OBJECT_ParamPortConfig
Definition param.h:41
SPA_PARAM_Control
@ SPA_PARAM_Control
Control parameter, a SPA_TYPE_Sequence.
Definition param.h:44
SPA_PARAM_Props
@ SPA_PARAM_Props
properties as SPA_TYPE_OBJECT_Props
Definition param.h:32
SPA_PARAM_PropInfo
@ SPA_PARAM_PropInfo
property information as SPA_TYPE_OBJECT_PropInfo
Definition param.h:31
SPA_PARAM_Buffers
@ SPA_PARAM_Buffers
buffer configurations as SPA_TYPE_OBJECT_ParamBuffers
Definition param.h:35
SPA_PARAM_ProcessLatency
@ SPA_PARAM_ProcessLatency
processing latency, a SPA_TYPE_OBJECT_ParamProcessLatency
Definition param.h:46
SPA_PARAM_Invalid
@ SPA_PARAM_Invalid
invalid
Definition param.h:30
SPA_PARAM_AVAILABILITY_unknown
@ SPA_PARAM_AVAILABILITY_unknown
unknown availability
Definition param.h:85
SPA_PARAM_AVAILABILITY_yes
@ SPA_PARAM_AVAILABILITY_yes
available
Definition param.h:87
SPA_PARAM_AVAILABILITY_no
@ SPA_PARAM_AVAILABILITY_no
not available
Definition param.h:86
port-config.h
spa/param/port-config.h
profile.h
spa/param/profile.h
route.h
spa/param/route.h
buffers.h
spa/param/buffers.h
spa_param_info
information about a parameter
Definition param.h:56
spa_param_info::flags
uint32_t flags
Definition param.h:67
spa_param_info::padding
uint32_t padding[4]
Definition param.h:72
spa_param_info::user
uint32_t user
private user field.
Definition param.h:68