PipeWire: spa/param/props.h Source File

PipeWire 1.4.7

Loading...
Searching...
No Matches
props.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_H
6#define SPA_PARAM_PROPS_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
16
17#include <spa/param/param.h>
18
20enum spa_prop_info {
21 SPA_PROP_INFO_START,
22 SPA_PROP_INFO_id,
23 SPA_PROP_INFO_name,
24 SPA_PROP_INFO_type,
25 SPA_PROP_INFO_labels,
30 SPA_PROP_INFO_container,
31 SPA_PROP_INFO_params,
32 SPA_PROP_INFO_description,
33};
34
36 enum spa_prop {
37 SPA_PROP_START,
38
39 SPA_PROP_unknown,
40
41 SPA_PROP_START_Device = 0x100,
42 SPA_PROP_device,
43 SPA_PROP_deviceName,
44 SPA_PROP_deviceFd,
45 SPA_PROP_card,
46 SPA_PROP_cardName,
47
48 SPA_PROP_minLatency,
49 SPA_PROP_maxLatency,
50 SPA_PROP_periods,
51 SPA_PROP_periodSize,
52 SPA_PROP_periodEvent,
53 SPA_PROP_live,
54 SPA_PROP_rate,
55 SPA_PROP_quality,
56 SPA_PROP_bluetoothAudioCodec,
57 SPA_PROP_bluetoothOffloadActive,
58
59 SPA_PROP_START_Audio = 0x10000,
60 SPA_PROP_waveType,
61 SPA_PROP_frequency,
62 SPA_PROP_volume,
63 SPA_PROP_mute,
64 SPA_PROP_patternType,
65 SPA_PROP_ditherType,
66 SPA_PROP_truncate,
67 SPA_PROP_channelVolumes,
73 SPA_PROP_volumeBase,
74 SPA_PROP_volumeStep,
75 SPA_PROP_channelMap,
77 SPA_PROP_monitorMute,
78 SPA_PROP_monitorVolumes,
80 SPA_PROP_latencyOffsetNsec,
81 SPA_PROP_softMute,
82 SPA_PROP_softVolumes,
87
88 SPA_PROP_iec958Codecs,
90 SPA_PROP_volumeRampSamples,
91 SPA_PROP_volumeRampStepSamples,
93 SPA_PROP_volumeRampTime,
94 SPA_PROP_volumeRampStepTime,
96 SPA_PROP_volumeRampScale,
98
99 SPA_PROP_START_Video = 0x20000,
100 SPA_PROP_brightness,
101 SPA_PROP_contrast,
102 SPA_PROP_saturation,
103 SPA_PROP_hue,
104 SPA_PROP_gamma,
105 SPA_PROP_exposure,
106 SPA_PROP_gain,
107 SPA_PROP_sharpness,
108
109 SPA_PROP_START_Other = 0x80000,
110 SPA_PROP_params,
114
115
116 SPA_PROP_START_CUSTOM = 0x1000000,
117};
118
122
123#ifdef __cplusplus
124} /* extern "C" */
125#endif
126
127#endif /* SPA_PARAM_PROPS_H */
spa_prop
spa_prop
predefined properties for SPA_TYPE_OBJECT_Props
Definition props.h:41
spa_prop_info
spa_prop_info
properties of SPA_TYPE_OBJECT_PropInfo
Definition props.h:25
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:86
SPA_PROP_sharpness
@ SPA_PROP_sharpness
Definition props.h:112
SPA_PROP_softVolumes
@ SPA_PROP_softVolumes
a volume array, one (linear) volume per channel (Array of Float).
Definition props.h:87
SPA_PROP_exposure
@ SPA_PROP_exposure
Definition props.h:110
SPA_PROP_START_CUSTOM
@ SPA_PROP_START_CUSTOM
Definition props.h:121
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:96
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:83
SPA_PROP_volumeStep
@ SPA_PROP_volumeStep
a volume step (Float)
Definition props.h:79
SPA_PROP_periodEvent
@ SPA_PROP_periodEvent
Definition props.h:57
SPA_PROP_device
@ SPA_PROP_device
Definition props.h:47
SPA_PROP_START_Other
@ SPA_PROP_START_Other
other properties
Definition props.h:114
SPA_PROP_contrast
@ SPA_PROP_contrast
Definition props.h:106
SPA_PROP_gamma
@ SPA_PROP_gamma
Definition props.h:109
SPA_PROP_live
@ SPA_PROP_live
Definition props.h:58
SPA_PROP_hue
@ SPA_PROP_hue
Definition props.h:108
SPA_PROP_START_Video
@ SPA_PROP_START_Video
video related properties
Definition props.h:104
SPA_PROP_volume
@ SPA_PROP_volume
a volume (Float), 0.0 silence, 1.0 no attenutation
Definition props.h:67
SPA_PROP_iec958Codecs
@ SPA_PROP_iec958Codecs
enabled IEC958 (S/PDIF) codecs, (Array (Id enum spa_audio_iec958_codec)
Definition props.h:93
SPA_PROP_gain
@ SPA_PROP_gain
Definition props.h:111
SPA_PROP_waveType
@ SPA_PROP_waveType
Definition props.h:65
SPA_PROP_cardName
@ SPA_PROP_cardName
Definition props.h:51
SPA_PROP_saturation
@ SPA_PROP_saturation
Definition props.h:107
SPA_PROP_ditherType
@ SPA_PROP_ditherType
Definition props.h:70
SPA_PROP_params
@ SPA_PROP_params
simple control params (Struct( (String : key, Pod ...
Definition props.h:115
SPA_PROP_volumeRampTime
@ SPA_PROP_volumeRampTime
Time in millisec to ramp the volume over.
Definition props.h:98
SPA_PROP_periodSize
@ SPA_PROP_periodSize
Definition props.h:56
SPA_PROP_brightness
@ SPA_PROP_brightness
Definition props.h:105
SPA_PROP_channelVolumes
@ SPA_PROP_channelVolumes
a volume array, one (linear) volume per channel (Array of Float).
Definition props.h:72
SPA_PROP_maxLatency
@ SPA_PROP_maxLatency
Definition props.h:54
SPA_PROP_card
@ SPA_PROP_card
Definition props.h:50
SPA_PROP_START_Device
@ SPA_PROP_START_Device
device related properties
Definition props.h:46
SPA_PROP_channelMap
@ SPA_PROP_channelMap
a channelmap array (Array (Id enum spa_audio_channel))
Definition props.h:80
SPA_PROP_monitorMute
@ SPA_PROP_monitorMute
mute (Bool)
Definition props.h:82
SPA_PROP_volumeBase
@ SPA_PROP_volumeBase
a volume base (Float)
Definition props.h:78
SPA_PROP_volumeRampStepTime
@ SPA_PROP_volumeRampStepTime
Step or incremental Time in nano seconds to ramp the.
Definition props.h:99
SPA_PROP_deviceName
@ SPA_PROP_deviceName
Definition props.h:48
SPA_PROP_truncate
@ SPA_PROP_truncate
Definition props.h:71
SPA_PROP_patternType
@ SPA_PROP_patternType
Definition props.h:69
SPA_PROP_volumeRampSamples
@ SPA_PROP_volumeRampSamples
Samples to ramp the volume over.
Definition props.h:95
SPA_PROP_latencyOffsetNsec
@ SPA_PROP_latencyOffsetNsec
delay adjustment
Definition props.h:85
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:66
SPA_PROP_bluetoothOffloadActive
@ SPA_PROP_bluetoothOffloadActive
Definition props.h:62
SPA_PROP_START_Audio
@ SPA_PROP_START_Audio
audio related properties
Definition props.h:64
SPA_PROP_mute
@ SPA_PROP_mute
mute (Bool)
Definition props.h:68
SPA_PROP_volumeRampScale
@ SPA_PROP_volumeRampScale
the scale or graph to used to ramp the volume
Definition props.h:101
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
param.h
spa/param/param.h