PipeWire  0.3.47
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 
41 #include <spa/utils/defs.h>
42 
44 enum spa_param_type {
62 };
63 
66  uint32_t id;
67 #define SPA_PARAM_INFO_SERIAL (1<<0)
69 #define SPA_PARAM_INFO_READ (1<<1)
70 #define SPA_PARAM_INFO_WRITE (1<<2)
71 #define SPA_PARAM_INFO_READWRITE (SPA_PARAM_INFO_WRITE|SPA_PARAM_INFO_READ)
72  uint32_t flags;
73  uint32_t user;
75  uint32_t padding[5];
76 };
77 
78 #define SPA_PARAM_INFO(id,flags) (struct spa_param_info){ (id), (flags) }
79 
89 };
90 
96 };
97 
103 };
109 };
134 };
143 };
153 };
154 
156 enum spa_param_route {
175 };
176 
179 enum spa_param_latency {
188 };
189 
196 };
202 };
208 #ifdef __cplusplus
209 } /* extern "C" */
210 #endif
212 #endif /* SPA_PARAM_H */
number of buffers (Int)
Definition: param.h:94
the expected maximum size the meta (Int)
Definition: param.h:106
direction, input/output (Id enum spa_direction)
Definition: param.h:192
profile name (String)
Definition: param.h:126
invalid
Definition: param.h:50
size of the io area (Int)
Definition: param.h:113
spa_param_process_latency
properties for SPA_TYPE_OBJECT_ParamProcessLatency
Definition: param.h:202
spa_param_buffers
properties for SPA_TYPE_OBJECT_ParamBuffers
Definition: param.h:92
profile configuration as SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:59
availability of the profile (Id enum spa_param_availability)
Definition: param.h:129
type ID, uniquely identifies the io area (Id enum spa_io_type)
Definition: param.h:112
direction, input/output (Id enum spa_direction)
Definition: param.h:159
unknown bitorder
Definition: param.h:210
latency relative to quantum (Float)
Definition: param.h:204
possible memory types (Int, mask of enum spa_data_type)
Definition: param.h:99
(Object) format filter
Definition: param.h:163
max latency (Long) in nanoseconds
Definition: param.h:198
uint32_t flags
Definition: param.h:82
Definition: param.h:124
processing latency, a SPA_TYPE_OBJECT_ParamProcessLatency
Definition: param.h:66
min latency relative to quantum (Float)
Definition: param.h:193
Definition: param.h:104
Definition: param.h:191
priority of the destination (Int)
Definition: param.h:174
associated device indexes (Array of Int)
Definition: param.h:183
Definition: param.h:203
min latency (Long) in nanoseconds
Definition: param.h:197
latency (Int) relative to rate
Definition: param.h:205
info (Struct( Int : n_items, (String : key, String : value)*))
Definition: param.h:131
size of a data block memory (Int)
Definition: param.h:96
spa/utils/defs.h
properties as SPA_TYPE_OBJECT_Props
Definition: param.h:52
index of the routing destination (Int)
Definition: param.h:169
spa_param_type
different parameter types that can be queried
Definition: param.h:49
max latency (Int) relative to rate
Definition: param.h:196
port configuration enumeration as SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:60
configured format as SPA_TYPE_OBJECT_Format
Definition: param.h:54
convert configuration
Definition: param.h:150
latency reporting, a SPA_TYPE_OBJECT_ParamLatency
Definition: param.h:65
availability of the destination (Id enum spa_param_availability)
Definition: param.h:175
port configuration as SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:61
dsp configuration, depending on the external format.
Definition: param.h:151
If route should be saved (Bool)
Definition: param.h:185
routing enumeration as SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:62
properties SPA_TYPE_OBJECT_Props
Definition: param.h:182
available
Definition: param.h:119
If profile should be saved (Bool)
Definition: param.h:144
(Bool) enable monitor output ports on input ports
Definition: param.h:161
information about a parameter
Definition: param.h:70
Definition: param.h:158
spa_param_availability
Definition: param.h:116
spa_param_meta
properties for SPA_TYPE_OBJECT_ParamMeta
Definition: param.h:103
spa_param_port_config_mode
Definition: param.h:147
spa_param_port_config
properties for SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:157
profile enumeration as SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:58
info (Struct( Int : n_items, (String : key, String : value)*))
Definition: param.h:177
profile description (String)
Definition: param.h:127
uint32_t id
enum spa_param_type
Definition: param.h:71
spa_param_route
properties for SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:167
direction, input/output (Id enum spa_direction)
Definition: param.h:170
the metadata, one of enum spa_meta_type (Id enum spa_meta_type)
Definition: param.h:105
associated profile indexes (Array of Int)
Definition: param.h:181
configurable IO areas as SPA_TYPE_OBJECT_ParamIO
Definition: param.h:57
least significant bit
Definition: param.h:212
(Id enum spa_param_port_config_mode) mode
Definition: param.h:160
uint32_t user
private user field.
Definition: param.h:83
min latency (Int) relative to rate
Definition: param.h:195
available formats as SPA_TYPE_OBJECT_Format
Definition: param.h:53
spa_param_bitorder
Definition: param.h:209
Definition: param.h:93
unknown availability
Definition: param.h:117
property information as SPA_TYPE_OBJECT_PropInfo
Definition: param.h:51
allowed metadata for buffers as SPA_TYPE_OBJECT_ParamMeta
Definition: param.h:56
spa_param_profile
properties for SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:123
description of the destination (String)
Definition: param.h:173
spa_param_io
properties for SPA_TYPE_OBJECT_ParamIO
Definition: param.h:110
profile index (Int)
Definition: param.h:125
most significant bit
Definition: param.h:211
name of the routing destination (String)
Definition: param.h:172
routing configuration as SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:63
max latency relative to quantum (Float)
Definition: param.h:194
Definition: param.h:111
uint32_t padding[5]
Definition: param.h:85
profile priority (Int)
Definition: param.h:128
Control parameter, a SPA_TYPE_Sequence.
Definition: param.h:64
(Bool) enable control ports
Definition: param.h:162
node classes provided by this profile (Struct( Int : number of items following Struct( String : class...
Definition: param.h:135
spa_param_latency
properties for SPA_TYPE_OBJECT_ParamLatency
Definition: param.h:190
device id (Int)
Definition: param.h:171
not available
Definition: param.h:118
alignment of data block memory (Int)
Definition: param.h:98
no configuration
Definition: param.h:148
number of data blocks per buffer (Int)
Definition: param.h:95
passthrough configuration
Definition: param.h:149
stride of data block memory (Int)
Definition: param.h:97
Definition: param.h:168
latency (Long) in nanoseconds
Definition: param.h:206
profile id (Int)
Definition: param.h:184
buffer configurations as SPA_TYPE_OBJECT_ParamBuffers
Definition: param.h:55