PipeWire 1.6.8

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