PipeWire: props-types.h Source File

PipeWire 0.3.66

Loading...
Searching...
No Matches
props-types.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_PROPS_TYPES_H
26#define SPA_PARAM_PROPS_TYPES_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
37#include <spa/param/param-types.h>
38
39#include <spa/param/bluetooth/type-info.h>
40
42#define SPA_TYPE_INFO_Props SPA_TYPE_INFO_PARAM_BASE "Props"
43#define SPA_TYPE_INFO_PROPS_BASE SPA_TYPE_INFO_Props ":"
44
45static const struct spa_type_info spa_type_props[] = {
46 { SPA_PROP_START, SPA_TYPE_Id, SPA_TYPE_INFO_PROPS_BASE, spa_type_param, },
47 { SPA_PROP_unknown, SPA_TYPE_None, SPA_TYPE_INFO_PROPS_BASE "unknown", NULL },
48 { SPA_PROP_device, SPA_TYPE_String, SPA_TYPE_INFO_PROPS_BASE "device", NULL },
49 { SPA_PROP_deviceName, SPA_TYPE_String, SPA_TYPE_INFO_PROPS_BASE "deviceName", NULL },
50 { SPA_PROP_deviceFd, SPA_TYPE_Fd, SPA_TYPE_INFO_PROPS_BASE "deviceFd", NULL },
51 { SPA_PROP_card, SPA_TYPE_String, SPA_TYPE_INFO_PROPS_BASE "card", NULL },
52 { SPA_PROP_cardName, SPA_TYPE_String, SPA_TYPE_INFO_PROPS_BASE "cardName", NULL },
53 { SPA_PROP_minLatency, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "minLatency", NULL },
54 { SPA_PROP_maxLatency, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "maxLatency", NULL },
55 { SPA_PROP_periods, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "periods", NULL },
56 { SPA_PROP_periodSize, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "periodSize", NULL },
57 { SPA_PROP_periodEvent, SPA_TYPE_Bool, SPA_TYPE_INFO_PROPS_BASE "periodEvent", NULL },
58 { SPA_PROP_live, SPA_TYPE_Bool, SPA_TYPE_INFO_PROPS_BASE "live", NULL },
59 { SPA_PROP_rate, SPA_TYPE_Double, SPA_TYPE_INFO_PROPS_BASE "rate", NULL },
60 { SPA_PROP_quality, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "quality", NULL },
61 { SPA_PROP_bluetoothAudioCodec, SPA_TYPE_Id, SPA_TYPE_INFO_PROPS_BASE "bluetoothAudioCodec", spa_type_bluetooth_audio_codec },
62 { SPA_PROP_bluetoothOffloadActive, SPA_TYPE_Bool, SPA_TYPE_INFO_PROPS_BASE "bluetoothOffloadActive", NULL },
63
64 { SPA_PROP_waveType, SPA_TYPE_Id, SPA_TYPE_INFO_PROPS_BASE "waveType", NULL },
65 { SPA_PROP_frequency, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "frequency", NULL },
66 { SPA_PROP_volume, SPA_TYPE_Float, SPA_TYPE_INFO_PROPS_BASE "volume", NULL },
67 { SPA_PROP_mute, SPA_TYPE_Bool, SPA_TYPE_INFO_PROPS_BASE "mute", NULL },
68 { SPA_PROP_patternType, SPA_TYPE_Id, SPA_TYPE_INFO_PROPS_BASE "patternType", NULL },
69 { SPA_PROP_ditherType, SPA_TYPE_Id, SPA_TYPE_INFO_PROPS_BASE "ditherType", NULL },
70 { SPA_PROP_truncate, SPA_TYPE_Bool, SPA_TYPE_INFO_PROPS_BASE "truncate", NULL },
71 { SPA_PROP_channelVolumes, SPA_TYPE_Array, SPA_TYPE_INFO_PROPS_BASE "channelVolumes", spa_type_prop_float_array },
72 { SPA_PROP_volumeBase, SPA_TYPE_Float, SPA_TYPE_INFO_PROPS_BASE "volumeBase", NULL },
73 { SPA_PROP_volumeStep, SPA_TYPE_Float, SPA_TYPE_INFO_PROPS_BASE "volumeStep", NULL },
74 { SPA_PROP_channelMap, SPA_TYPE_Array, SPA_TYPE_INFO_PROPS_BASE "channelMap", spa_type_prop_channel_map },
75 { SPA_PROP_monitorMute, SPA_TYPE_Bool, SPA_TYPE_INFO_PROPS_BASE "monitorMute", NULL },
76 { SPA_PROP_monitorVolumes, SPA_TYPE_Array, SPA_TYPE_INFO_PROPS_BASE "monitorVolumes", spa_type_prop_float_array },
77 { SPA_PROP_latencyOffsetNsec, SPA_TYPE_Long, SPA_TYPE_INFO_PROPS_BASE "latencyOffsetNsec", NULL },
78 { SPA_PROP_softMute, SPA_TYPE_Bool, SPA_TYPE_INFO_PROPS_BASE "softMute", NULL },
79 { SPA_PROP_softVolumes, SPA_TYPE_Array, SPA_TYPE_INFO_PROPS_BASE "softVolumes", spa_type_prop_float_array },
80 { SPA_PROP_iec958Codecs, SPA_TYPE_Array, SPA_TYPE_INFO_PROPS_BASE "iec958Codecs", spa_type_prop_iec958_codec },
81
82 { SPA_PROP_brightness, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "brightness", NULL },
83 { SPA_PROP_contrast, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "contrast", NULL },
84 { SPA_PROP_saturation, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "saturation", NULL },
85 { SPA_PROP_hue, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "hue", NULL },
86 { SPA_PROP_gamma, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "gamma", NULL },
87 { SPA_PROP_exposure, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "exposure", NULL },
88 { SPA_PROP_gain, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "gain", NULL },
89 { SPA_PROP_sharpness, SPA_TYPE_Int, SPA_TYPE_INFO_PROPS_BASE "sharpness", NULL },
90
91 { SPA_PROP_params, SPA_TYPE_Struct, SPA_TYPE_INFO_PROPS_BASE "params", NULL },
92 { 0, 0, NULL, NULL },
93};
94
96#define SPA_TYPE_INFO_PropInfo SPA_TYPE_INFO_PARAM_BASE "PropInfo"
97#define SPA_TYPE_INFO_PROP_INFO_BASE SPA_TYPE_INFO_PropInfo ":"
98
99static const struct spa_type_info spa_type_prop_info[] = {
100 { SPA_PROP_INFO_START, SPA_TYPE_Id, SPA_TYPE_INFO_PROP_INFO_BASE, spa_type_param, },
101 { SPA_PROP_INFO_id, SPA_TYPE_Id, SPA_TYPE_INFO_PROP_INFO_BASE "id", spa_type_props },
102 { SPA_PROP_INFO_name, SPA_TYPE_String, SPA_TYPE_INFO_PROP_INFO_BASE "name", NULL },
103 { SPA_PROP_INFO_type, SPA_TYPE_Pod, SPA_TYPE_INFO_PROP_INFO_BASE "type", NULL },
104 { SPA_PROP_INFO_labels, SPA_TYPE_Struct, SPA_TYPE_INFO_PROP_INFO_BASE "labels", NULL },
105 { SPA_PROP_INFO_container, SPA_TYPE_Id, SPA_TYPE_INFO_PROP_INFO_BASE "container", NULL },
106 { SPA_PROP_INFO_params, SPA_TYPE_Bool, SPA_TYPE_INFO_PROP_INFO_BASE "params", NULL },
107 { SPA_PROP_INFO_description, SPA_TYPE_String, SPA_TYPE_INFO_PROP_INFO_BASE "description", NULL },
108 { 0, 0, NULL, NULL },
109};
110
115#ifdef __cplusplus
116} /* extern "C" */
117#endif
118
119#endif /* SPA_PARAM_PROPS_TYPES_H */
spa_type_prop_channel_map
static const struct spa_type_info spa_type_prop_channel_map[]
Definition: param-types.h:86
spa_type_prop_info
static const struct spa_type_info spa_type_prop_info[]
Definition: props-types.h:108
SPA_TYPE_INFO_PROP_INFO_BASE
#define SPA_TYPE_INFO_PROP_INFO_BASE
Definition: props-types.h:106
spa_type_prop_float_array
static const struct spa_type_info spa_type_prop_float_array[]
Definition: param-types.h:81
spa_type_props
static const struct spa_type_info spa_type_props[]
Definition: props-types.h:52
spa_type_bluetooth_audio_codec
static const struct spa_type_info spa_type_bluetooth_audio_codec[]
Definition: param/bluetooth/type-info.h:49
spa_type_param
static const struct spa_type_info spa_type_param[]
Definition: param-types.h:52
SPA_TYPE_INFO_PROPS_BASE
#define SPA_TYPE_INFO_PROPS_BASE
Definition: props-types.h:50
spa_type_prop_iec958_codec
static const struct spa_type_info spa_type_prop_iec958_codec[]
Definition: param-types.h:91
SPA_PROP_START
@ SPA_PROP_START
Definition: props.h:62
SPA_PROP_periods
@ SPA_PROP_periods
Definition: props.h:75
SPA_PROP_softMute
@ SPA_PROP_softMute
mute (Bool)
Definition: props.h:102
SPA_PROP_sharpness
@ SPA_PROP_sharpness
Definition: props.h:117
SPA_PROP_softVolumes
@ SPA_PROP_softVolumes
a volume array, one volume per channel (Array of Float)
Definition: props.h:103
SPA_PROP_exposure
@ SPA_PROP_exposure
Definition: props.h:115
SPA_PROP_bluetoothAudioCodec
@ SPA_PROP_bluetoothAudioCodec
Definition: props.h:81
SPA_PROP_rate
@ SPA_PROP_rate
Definition: props.h:79
SPA_PROP_minLatency
@ SPA_PROP_minLatency
Definition: props.h:73
SPA_PROP_monitorVolumes
@ SPA_PROP_monitorVolumes
a volume array, one volume per channel (Array of Float)
Definition: props.h:99
SPA_PROP_volumeStep
@ SPA_PROP_volumeStep
a volume step (Float)
Definition: props.h:95
SPA_PROP_periodEvent
@ SPA_PROP_periodEvent
Definition: props.h:77
SPA_PROP_device
@ SPA_PROP_device
Definition: props.h:67
SPA_PROP_contrast
@ SPA_PROP_contrast
Definition: props.h:111
SPA_PROP_gamma
@ SPA_PROP_gamma
Definition: props.h:114
SPA_PROP_live
@ SPA_PROP_live
Definition: props.h:78
SPA_PROP_hue
@ SPA_PROP_hue
Definition: props.h:113
SPA_PROP_volume
@ SPA_PROP_volume
a volume (Float), 0.0 silence, 1.0 normal
Definition: props.h:87
SPA_PROP_iec958Codecs
@ SPA_PROP_iec958Codecs
enabled IEC958 (S/PDIF) codecs, (Array (Id enum spa_audio_iec958_codec)
Definition: props.h:106
SPA_PROP_gain
@ SPA_PROP_gain
Definition: props.h:116
SPA_PROP_waveType
@ SPA_PROP_waveType
Definition: props.h:85
SPA_PROP_cardName
@ SPA_PROP_cardName
Definition: props.h:71
SPA_PROP_saturation
@ SPA_PROP_saturation
Definition: props.h:112
SPA_PROP_ditherType
@ SPA_PROP_ditherType
Definition: props.h:90
SPA_PROP_params
@ SPA_PROP_params
simple control params (Struct( (String : key, Po...
Definition: props.h:120
SPA_PROP_periodSize
@ SPA_PROP_periodSize
Definition: props.h:76
SPA_PROP_brightness
@ SPA_PROP_brightness
Definition: props.h:110
SPA_PROP_channelVolumes
@ SPA_PROP_channelVolumes
a volume array, one volume per channel (Array of Float)
Definition: props.h:92
SPA_PROP_maxLatency
@ SPA_PROP_maxLatency
Definition: props.h:74
SPA_PROP_card
@ SPA_PROP_card
Definition: props.h:70
SPA_PROP_channelMap
@ SPA_PROP_channelMap
a channelmap array (Array (Id enum spa_audio_channel))
Definition: props.h:96
SPA_PROP_monitorMute
@ SPA_PROP_monitorMute
mute (Bool)
Definition: props.h:98
SPA_PROP_volumeBase
@ SPA_PROP_volumeBase
a volume base (Float)
Definition: props.h:94
SPA_PROP_deviceName
@ SPA_PROP_deviceName
Definition: props.h:68
SPA_PROP_truncate
@ SPA_PROP_truncate
Definition: props.h:91
SPA_PROP_patternType
@ SPA_PROP_patternType
Definition: props.h:89
SPA_PROP_latencyOffsetNsec
@ SPA_PROP_latencyOffsetNsec
delay adjustment
Definition: props.h:101
SPA_PROP_unknown
@ SPA_PROP_unknown
an unknown property
Definition: props.h:64
SPA_PROP_quality
@ SPA_PROP_quality
Definition: props.h:80
SPA_PROP_deviceFd
@ SPA_PROP_deviceFd
Definition: props.h:69
SPA_PROP_frequency
@ SPA_PROP_frequency
Definition: props.h:86
SPA_PROP_bluetoothOffloadActive
@ SPA_PROP_bluetoothOffloadActive
Definition: props.h:82
SPA_PROP_mute
@ SPA_PROP_mute
mute (Bool)
Definition: props.h:88
SPA_PROP_INFO_container
@ SPA_PROP_INFO_container
type of container if any (Id)
Definition: props.h:55
SPA_PROP_INFO_id
@ SPA_PROP_INFO_id
associated id of the property
Definition: props.h:47
SPA_PROP_INFO_START
@ SPA_PROP_INFO_START
Definition: props.h:46
SPA_PROP_INFO_description
@ SPA_PROP_INFO_description
User readable description.
Definition: props.h:57
SPA_PROP_INFO_params
@ SPA_PROP_INFO_params
is part of params property (Bool)
Definition: props.h:56
SPA_PROP_INFO_labels
@ SPA_PROP_INFO_labels
labels of property if any, this is a struct with pairs of values, the first one is of the type of the...
Definition: props.h:50
SPA_PROP_INFO_name
@ SPA_PROP_INFO_name
name of the property
Definition: props.h:48
SPA_PROP_INFO_type
@ SPA_PROP_INFO_type
type and range/enums of property
Definition: props.h:49
SPA_TYPE_Int
@ SPA_TYPE_Int
Definition: spa/include/spa/utils/type.h:54
SPA_TYPE_Long
@ SPA_TYPE_Long
Definition: spa/include/spa/utils/type.h:55
SPA_TYPE_Bool
@ SPA_TYPE_Bool
Definition: spa/include/spa/utils/type.h:52
SPA_TYPE_Pod
@ SPA_TYPE_Pod
Definition: spa/include/spa/utils/type.h:70
SPA_TYPE_Float
@ SPA_TYPE_Float
Definition: spa/include/spa/utils/type.h:56
SPA_TYPE_None
@ SPA_TYPE_None
Definition: spa/include/spa/utils/type.h:51
SPA_TYPE_Double
@ SPA_TYPE_Double
Definition: spa/include/spa/utils/type.h:57
SPA_TYPE_Id
@ SPA_TYPE_Id
Definition: spa/include/spa/utils/type.h:53
SPA_TYPE_Array
@ SPA_TYPE_Array
Definition: spa/include/spa/utils/type.h:63
SPA_TYPE_String
@ SPA_TYPE_String
Definition: spa/include/spa/utils/type.h:58
SPA_TYPE_Fd
@ SPA_TYPE_Fd
Definition: spa/include/spa/utils/type.h:68
SPA_TYPE_Struct
@ SPA_TYPE_Struct
Definition: spa/include/spa/utils/type.h:64
param-types.h
spa/param/param-types.h
type-info.h
spa/param/bluetooth/type-info.h
spa_type_info
Definition: spa/include/spa/utils/type.h:162