PipeWire  0.3.29
param.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_PARAM_H
26 #define SPA_PARAM_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
40 #include <spa/utils/defs.h>
41 
60 };
61 
64  uint32_t id;
65 #define SPA_PARAM_INFO_SERIAL (1<<0)
67 #define SPA_PARAM_INFO_READ (1<<1)
68 #define SPA_PARAM_INFO_WRITE (1<<2)
69 #define SPA_PARAM_INFO_READWRITE (SPA_PARAM_INFO_WRITE|SPA_PARAM_INFO_READ)
70  uint32_t flags;
71  uint32_t user;
73  uint32_t padding[5];
74 };
75 
76 #define SPA_PARAM_INFO(id,flags) (struct spa_param_info){ (id), (flags) }
77 
79 enum spa_param_buffers {
87 };
88 
90 enum spa_param_meta {
94 };
95 
97 enum spa_param_io {
101 };
102 
107 };
108 
110 enum spa_param_profile {
132 };
133 
141 };
142 
151 };
152 
154 enum spa_param_route {
173 };
174 
175 
177 enum spa_param_latency {
186 };
187 
192 #ifdef __cplusplus
193 } /* extern "C" */
194 #endif
195 
196 #endif /* SPA_PARAM_H */
number of buffers (Int)
Definition: param.h:82
the expected maximum size the meta (Int)
Definition: param.h:94
direction, input/output (Id enum spa_direction)
Definition: param.h:180
profile name (String)
Definition: param.h:114
invalid
Definition: param.h:44
size of the io area (Int)
Definition: param.h:101
spa_param_buffers
properties for SPA_TYPE_OBJECT_ParamBuffers
Definition: param.h:80
profile configuration as SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:53
availability of the profile (Id enum spa_param_availability)
Definition: param.h:117
type ID, uniquely identifies the io area (Id enum spa_io_type)
Definition: param.h:100
direction, input/output (Id enum spa_direction)
Definition: param.h:147
possible memory types (Int, mask of enum spa_data_type)
Definition: param.h:87
(Object) format filter
Definition: param.h:151
max latency (Long) in nanoseconds
Definition: param.h:186
uint32_t flags
Definition: param.h:71
Definition: param.h:112
min latency relative to quantum (Float)
Definition: param.h:181
Definition: param.h:92
Definition: param.h:179
priority of the destination (Int)
Definition: param.h:162
associated device indexes (Array of Int)
Definition: param.h:171
min latency (Long) in nanoseconds
Definition: param.h:185
info (Struct( Int : n_items, (String : key, String : value)*))
Definition: param.h:119
size of a data block memory (Int)
Definition: param.h:84
properties as SPA_TYPE_OBJECT_Props
Definition: param.h:46
index of the routing destination (Int)
Definition: param.h:157
spa_param_type
different parameter types that can be queried
Definition: param.h:43
max latency (Int) relative to rate
Definition: param.h:184
port configuration enumeration as SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:54
configured format as SPA_TYPE_OBJECT_Format
Definition: param.h:48
convert configuration
Definition: param.h:138
latency reporting, a SPA_TYPE_OBJECT_ParamLatency
Definition: param.h:59
availability of the destination (Id enum spa_param_availability)
Definition: param.h:163
port configuration as SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:55
dsp configuration, depending on the external format.
Definition: param.h:139
If route should be saved (Bool)
Definition: param.h:173
routing enumeration as SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:56
properties SPA_TYPE_OBJECT_Props
Definition: param.h:170
available
Definition: param.h:107
If profile should be saved (Bool)
Definition: param.h:132
(Bool) enable monitor output ports on input ports
Definition: param.h:149
information about a parameter
Definition: param.h:63
Definition: param.h:146
spa_param_availability
Definition: param.h:104
spa_param_meta
properties for SPA_TYPE_OBJECT_ParamMeta
Definition: param.h:91
spa_param_port_config_mode
Definition: param.h:135
spa_param_port_config
properties for SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:145
profile enumeration as SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:52
info (Struct( Int : n_items, (String : key, String : value)*))
Definition: param.h:165
profile description (String)
Definition: param.h:115
uint32_t id
enum spa_param_type
Definition: param.h:64
spa_param_route
properties for SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:155
direction, input/output (Id enum spa_direction)
Definition: param.h:158
the metadata, one of enum spa_meta_type (Id enum spa_meta_type)
Definition: param.h:93
associated profile indexes (Array of Int)
Definition: param.h:169
configurable IO areas as SPA_TYPE_OBJECT_ParamIO
Definition: param.h:51
(Id enum spa_param_port_config_mode) mode
Definition: param.h:148
uint32_t user
private user field.
Definition: param.h:72
min latency (Int) relative to rate
Definition: param.h:183
available formats as SPA_TYPE_OBJECT_Format
Definition: param.h:47
Definition: param.h:81
unknown availability
Definition: param.h:105
property information as SPA_TYPE_OBJECT_PropInfo
Definition: param.h:45
allowed metadata for buffers as SPA_TYPE_OBJECT_ParamMeta
Definition: param.h:50
spa_param_profile
properties for SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:111
description of the destination (String)
Definition: param.h:161
spa_param_io
properties for SPA_TYPE_OBJECT_ParamIO
Definition: param.h:98
profile index (Int)
Definition: param.h:113
name of the routing destination (String)
Definition: param.h:160
routing configuration as SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:57
max latency relative to quantum (Float)
Definition: param.h:182
Definition: param.h:99
uint32_t padding[5]
Definition: param.h:74
profile priority (Int)
Definition: param.h:116
Control parameter, a SPA_TYPE_Sequence.
Definition: param.h:58
(Bool) enable control ports
Definition: param.h:150
node classes provided by this profile (Struct( Int : number of items following Struct( String : class...
Definition: param.h:123
spa_param_latency
properties for SPA_TYPE_OBJECT_ParamLatency
Definition: param.h:178
device id (Int)
Definition: param.h:159
not available
Definition: param.h:106
alignment of data block memory (Int)
Definition: param.h:86
no configuration
Definition: param.h:136
number of data blocks per buffer (Int)
Definition: param.h:83
passthrough configuration
Definition: param.h:137
stride of data block memory (Int)
Definition: param.h:85
Definition: param.h:156
profile id (Int)
Definition: param.h:172
buffer configurations as SPA_TYPE_OBJECT_ParamBuffers
Definition: param.h:49