PipeWire: spa/param/props.h Source File

PipeWire 0.3.51

props.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_H
26#define SPA_PARAM_PROPS_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
37#include <spa/param/param.h>
38
40enum spa_prop_info {
41 SPA_PROP_INFO_START,
42 SPA_PROP_INFO_id,
43 SPA_PROP_INFO_name,
44 SPA_PROP_INFO_type,
45 SPA_PROP_INFO_labels,
50 SPA_PROP_INFO_container,
51 SPA_PROP_INFO_params,
52 SPA_PROP_INFO_description,
53};
54
56 enum spa_prop {
57 SPA_PROP_START,
58
59 SPA_PROP_unknown,
61 SPA_PROP_START_Device = 0x100,
62 SPA_PROP_device,
63 SPA_PROP_deviceName,
64 SPA_PROP_deviceFd,
65 SPA_PROP_card,
66 SPA_PROP_cardName,
67
68 SPA_PROP_minLatency,
69 SPA_PROP_maxLatency,
70 SPA_PROP_periods,
71 SPA_PROP_periodSize,
72 SPA_PROP_periodEvent,
73 SPA_PROP_live,
74 SPA_PROP_rate,
75 SPA_PROP_quality,
76 SPA_PROP_bluetoothAudioCodec,
77
78 SPA_PROP_START_Audio = 0x10000,
79 SPA_PROP_waveType,
80 SPA_PROP_frequency,
81 SPA_PROP_volume,
82 SPA_PROP_mute,
83 SPA_PROP_patternType,
84 SPA_PROP_ditherType,
85 SPA_PROP_truncate,
86 SPA_PROP_channelVolumes,
88 SPA_PROP_volumeBase,
89 SPA_PROP_volumeStep,
90 SPA_PROP_channelMap,
92 SPA_PROP_monitorMute,
93 SPA_PROP_monitorVolumes,
95 SPA_PROP_latencyOffsetNsec,
96 SPA_PROP_softMute,
97 SPA_PROP_softVolumes,
100 SPA_PROP_iec958Codecs,
103 SPA_PROP_START_Video = 0x20000,
104 SPA_PROP_brightness,
105 SPA_PROP_contrast,
106 SPA_PROP_saturation,
107 SPA_PROP_hue,
108 SPA_PROP_gamma,
109 SPA_PROP_exposure,
110 SPA_PROP_gain,
111 SPA_PROP_sharpness,
112
113 SPA_PROP_START_Other = 0x80000,
114 SPA_PROP_params,
120 SPA_PROP_START_CUSTOM = 0x1000000,
121};
122
127#ifdef __cplusplus
128} /* extern "C" */
129#endif
130
131#endif /* SPA_PARAM_PROPS_H */
spa_prop
spa_prop
predefined properties for SPA_TYPE_OBJECT_Props
Definition: props.h:61
spa_prop_info
spa_prop_info
properties of SPA_TYPE_OBJECT_PropInfo
Definition: props.h:45
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:101
SPA_PROP_sharpness
@ SPA_PROP_sharpness
Definition: props.h:116
SPA_PROP_softVolumes
@ SPA_PROP_softVolumes
a volume array, one volume per channel (Array of Float)
Definition: props.h:102
SPA_PROP_exposure
@ SPA_PROP_exposure
Definition: props.h:114
SPA_PROP_START_CUSTOM
@ SPA_PROP_START_CUSTOM
Definition: props.h:125
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:98
SPA_PROP_volumeStep
@ SPA_PROP_volumeStep
a volume step (Float)
Definition: props.h:94
SPA_PROP_periodEvent
@ SPA_PROP_periodEvent
Definition: props.h:77
SPA_PROP_device
@ SPA_PROP_device
Definition: props.h:67
SPA_PROP_START_Other
@ SPA_PROP_START_Other
other properties
Definition: props.h:118
SPA_PROP_contrast
@ SPA_PROP_contrast
Definition: props.h:110
SPA_PROP_gamma
@ SPA_PROP_gamma
Definition: props.h:113
SPA_PROP_live
@ SPA_PROP_live
Definition: props.h:78
SPA_PROP_hue
@ SPA_PROP_hue
Definition: props.h:112
SPA_PROP_START_Video
@ SPA_PROP_START_Video
video related properties
Definition: props.h:108
SPA_PROP_volume
@ SPA_PROP_volume
a volume (Float), 0.0 silence, 1.0 normal
Definition: props.h:86
SPA_PROP_iec958Codecs
@ SPA_PROP_iec958Codecs
enabled IEC958 (S/PDIF) codecs, (Array (Id enum spa_audio_iec958_codec)
Definition: props.h:105
SPA_PROP_gain
@ SPA_PROP_gain
Definition: props.h:115
SPA_PROP_waveType
@ SPA_PROP_waveType
Definition: props.h:84
SPA_PROP_cardName
@ SPA_PROP_cardName
Definition: props.h:71
SPA_PROP_saturation
@ SPA_PROP_saturation
Definition: props.h:111
SPA_PROP_ditherType
@ SPA_PROP_ditherType
Definition: props.h:89
SPA_PROP_params
@ SPA_PROP_params
simple control params (Struct( (String : key, Po...
Definition: props.h:119
SPA_PROP_periodSize
@ SPA_PROP_periodSize
Definition: props.h:76
SPA_PROP_brightness
@ SPA_PROP_brightness
Definition: props.h:109
SPA_PROP_channelVolumes
@ SPA_PROP_channelVolumes
a volume array, one volume per channel (Array of Float)
Definition: props.h:91
SPA_PROP_maxLatency
@ SPA_PROP_maxLatency
Definition: props.h:74
SPA_PROP_card
@ SPA_PROP_card
Definition: props.h:70
SPA_PROP_START_Device
@ SPA_PROP_START_Device
device related properties
Definition: props.h:66
SPA_PROP_channelMap
@ SPA_PROP_channelMap
a channelmap array (Array (Id enum spa_audio_channel))
Definition: props.h:95
SPA_PROP_monitorMute
@ SPA_PROP_monitorMute
mute (Bool)
Definition: props.h:97
SPA_PROP_volumeBase
@ SPA_PROP_volumeBase
a volume base (Float)
Definition: props.h:93
SPA_PROP_deviceName
@ SPA_PROP_deviceName
Definition: props.h:68
SPA_PROP_truncate
@ SPA_PROP_truncate
Definition: props.h:90
SPA_PROP_patternType
@ SPA_PROP_patternType
Definition: props.h:88
SPA_PROP_latencyOffsetNsec
@ SPA_PROP_latencyOffsetNsec
delay adjustment
Definition: props.h:100
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:85
SPA_PROP_START_Audio
@ SPA_PROP_START_Audio
audio related properties
Definition: props.h:83
SPA_PROP_mute
@ SPA_PROP_mute
mute (Bool)
Definition: props.h:87
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
param.h
spa/param/param.h