PipeWire: pipewire/extensions/session-manager/introspect.h Source File

PipeWire 0.3.51

introspect.h
Go to the documentation of this file.
1/* PipeWire
2 *
3 * Copyright © 2019 Collabora Ltd.
4 * @author George Kiagiadakis <george.kiagiadakis@collabora.com>
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice (including the next
14 * paragraph) shall be included in all copies or substantial portions of the
15 * Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23 * DEALINGS IN THE SOFTWARE.
24 */
25
26#ifndef PIPEWIRE_EXT_SESSION_MANAGER_INTROSPECT_H
27#define PIPEWIRE_EXT_SESSION_MANAGER_INTROSPECT_H
28
29#include <spa/utils/defs.h>
30#include <spa/utils/dict.h>
31#include <spa/param/param.h>
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
42enum pw_endpoint_link_state {
43 PW_ENDPOINT_LINK_STATE_ERROR = -1,
44 PW_ENDPOINT_LINK_STATE_PREPARING,
45 PW_ENDPOINT_LINK_STATE_INACTIVE,
46 PW_ENDPOINT_LINK_STATE_ACTIVE,
47};
48
49 struct pw_session_info {
50#define PW_VERSION_SESSION_INFO 0
51 uint32_t version;
52 uint32_t id;
53#define PW_SESSION_CHANGE_MASK_PROPS (1 << 0)
54#define PW_SESSION_CHANGE_MASK_PARAMS (1 << 1)
55#define PW_SESSION_CHANGE_MASK_ALL ((1 << 2)-1)
56 uint64_t change_mask;
57 struct spa_dict *props;
58 struct spa_param_info *params;
59 uint32_t n_params;
60};
61
62struct pw_endpoint_info {
63#define PW_VERSION_ENDPOINT_INFO 0
64 uint32_t version;
65 uint32_t id;
66 char *name;
67 char *media_class;
68 enum pw_direction direction;
69#define PW_ENDPOINT_FLAG_PROVIDES_SESSION (1 << 0)
70 uint32_t flags;
71#define PW_ENDPOINT_CHANGE_MASK_STREAMS (1 << 0)
72#define PW_ENDPOINT_CHANGE_MASK_SESSION (1 << 1)
73#define PW_ENDPOINT_CHANGE_MASK_PROPS (1 << 2)
74#define PW_ENDPOINT_CHANGE_MASK_PARAMS (1 << 3)
75#define PW_ENDPOINT_CHANGE_MASK_ALL ((1 << 4)-1)
76 uint64_t change_mask;
77 uint32_t n_streams;
78 uint32_t session_id;
79 struct spa_dict *props;
80 struct spa_param_info *params;
81 uint32_t n_params;
82};
83
84 struct pw_endpoint_stream_info {
85#define PW_VERSION_ENDPOINT_STREAM_INFO 0
86 uint32_t version;
87 uint32_t id;
88 uint32_t endpoint_id;
89 char *name;
90#define PW_ENDPOINT_STREAM_CHANGE_MASK_LINK_PARAMS (1 << 0)
91#define PW_ENDPOINT_STREAM_CHANGE_MASK_PROPS (1 << 1)
92#define PW_ENDPOINT_STREAM_CHANGE_MASK_PARAMS (1 << 2)
93#define PW_ENDPOINT_STREAM_CHANGE_MASK_ALL ((1 << 3)-1)
94 uint64_t change_mask;
95 struct spa_pod *link_params;
96 struct spa_dict *props;
97 struct spa_param_info *params;
98 uint32_t n_params;
99};
100
101 struct pw_endpoint_link_info {
102#define PW_VERSION_ENDPOINT_LINK_INFO 0
103 uint32_t version;
104 uint32_t id;
105 uint32_t session_id;
106 uint32_t output_endpoint_id;
107 uint32_t output_stream_id;
108 uint32_t input_endpoint_id;
109 uint32_t input_stream_id;
110#define PW_ENDPOINT_LINK_CHANGE_MASK_STATE (1 << 0)
111#define PW_ENDPOINT_LINK_CHANGE_MASK_PROPS (1 << 1)
112#define PW_ENDPOINT_LINK_CHANGE_MASK_PARAMS (1 << 2)
113#define PW_ENDPOINT_LINK_CHANGE_MASK_ALL ((1 << 3)-1)
114 uint64_t change_mask;
115 enum pw_endpoint_link_state state;
116 char *error;
117 struct spa_dict *props;
118 struct spa_param_info *params;
119 uint32_t n_params;
120};
121
126#ifdef __cplusplus
127} /* extern "C" */
128#endif
129
130#endif /* PIPEWIRE_EXT_SESSION_MANAGER_INTROSPECT_H */
defs.h
spa/utils/defs.h
pw_direction
#define pw_direction
The direction of a port.
Definition: port.h:63
pw_endpoint_link_state
pw_endpoint_link_state
Definition: introspect.h:46
PW_ENDPOINT_LINK_STATE_PREPARING
@ PW_ENDPOINT_LINK_STATE_PREPARING
Definition: introspect.h:48
PW_ENDPOINT_LINK_STATE_ACTIVE
@ PW_ENDPOINT_LINK_STATE_ACTIVE
Definition: introspect.h:50
PW_ENDPOINT_LINK_STATE_INACTIVE
@ PW_ENDPOINT_LINK_STATE_INACTIVE
Definition: introspect.h:49
PW_ENDPOINT_LINK_STATE_ERROR
@ PW_ENDPOINT_LINK_STATE_ERROR
Definition: introspect.h:47
param.h
spa/param/param.h
pw_endpoint_info
Definition: introspect.h:70
pw_endpoint_info::params
struct spa_param_info * params
parameters
Definition: introspect.h:95
pw_endpoint_info::id
uint32_t id
the endpoint id (global)
Definition: introspect.h:74
pw_endpoint_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition: introspect.h:91
pw_endpoint_info::direction
enum pw_direction direction
direction of the endpoint
Definition: introspect.h:77
pw_endpoint_info::n_params
uint32_t n_params
number of items in params
Definition: introspect.h:96
pw_endpoint_info::flags
uint32_t flags
additional flags
Definition: introspect.h:80
pw_endpoint_info::version
uint32_t version
version of this structure
Definition: introspect.h:73
pw_endpoint_info::media_class
char * media_class
media class of the endpoint
Definition: introspect.h:76
pw_endpoint_info::session_id
uint32_t session_id
the id of the controlling session
Definition: introspect.h:93
pw_endpoint_info::n_streams
uint32_t n_streams
number of streams available
Definition: introspect.h:92
pw_endpoint_link_info
Definition: introspect.h:121
pw_endpoint_link_info::id
uint32_t id
the link id (global)
Definition: introspect.h:125
pw_endpoint_link_info::output_endpoint_id
uint32_t output_endpoint_id
the output endpoint id (global)
Definition: introspect.h:127
pw_endpoint_link_info::input_endpoint_id
uint32_t input_endpoint_id
the input endpoint id (global)
Definition: introspect.h:129
pw_endpoint_link_info::error
char * error
error string if state == ERROR
Definition: introspect.h:141
pw_endpoint_link_info::version
uint32_t version
version of this structure
Definition: introspect.h:124
pw_endpoint_link_info::params
struct spa_param_info * params
parameters
Definition: introspect.h:143
pw_endpoint_link_info::state
enum pw_endpoint_link_state state
the state of the link
Definition: introspect.h:140
pw_endpoint_link_info::n_params
uint32_t n_params
number of items in params
Definition: introspect.h:144
pw_endpoint_link_info::output_stream_id
uint32_t output_stream_id
the output stream id (local or global)
Definition: introspect.h:128
pw_endpoint_link_info::input_stream_id
uint32_t input_stream_id
the input stream id (local or global)
Definition: introspect.h:130
pw_endpoint_link_info::session_id
uint32_t session_id
the session id (global)
Definition: introspect.h:126
pw_endpoint_stream_info
Definition: introspect.h:99
pw_endpoint_stream_info::n_params
uint32_t n_params
number of items in params
Definition: introspect.h:118
pw_endpoint_stream_info::params
struct spa_param_info * params
parameters
Definition: introspect.h:117
pw_endpoint_stream_info::endpoint_id
uint32_t endpoint_id
the endpoint id (global)
Definition: introspect.h:104
pw_endpoint_stream_info::link_params
struct spa_pod * link_params
information for linking this stream
Definition: introspect.h:115
pw_endpoint_stream_info::id
uint32_t id
the stream id (local or global)
Definition: introspect.h:103
pw_endpoint_stream_info::version
uint32_t version
version of this structure
Definition: introspect.h:102
pw_endpoint_stream_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition: introspect.h:114
pw_session_info
Definition: introspect.h:53
pw_session_info::params
struct spa_param_info * params
parameters
Definition: introspect.h:66
pw_session_info::change_mask
uint64_t change_mask
bitfield of changed fields since last call
Definition: introspect.h:64
pw_session_info::id
uint32_t id
the session id (global)
Definition: introspect.h:57
pw_session_info::version
uint32_t version
version of this structure
Definition: introspect.h:56
pw_session_info::n_params
uint32_t n_params
number of items in params
Definition: introspect.h:67
spa_dict
Definition: dict.h:59
spa_param_info
information about a parameter
Definition: param.h:70
spa_pod
Definition: pod.h:63
dict.h
spa/utils/dict.h