PipeWire: pipewire/control.h Source File

PipeWire 0.3.50

control.h
Go to the documentation of this file.
1/* PipeWire
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 PIPEWIRE_CONTROL_H
26#define PIPEWIRE_CONTROL_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#include <spa/utils/hook.h>
33
43struct pw_control;
44
45#include <pipewire/impl.h>
46
48struct pw_control_events {
49#define PW_VERSION_CONTROL_EVENTS 0
50 uint32_t version;
51
53 void (*destroy) (void *data);
54
56 void (*free) (void *data);
57
59 void (*linked) (void *data, struct pw_control *other);
61 void (*unlinked) (void *data, struct pw_control *other);
62
63};
64
66struct pw_impl_port *pw_control_get_port(struct pw_control *control);
67
69void pw_control_add_listener(struct pw_control *control,
70 struct spa_hook *listener,
71 const struct pw_control_events *events,
72 void *data);
73
78#ifdef __cplusplus
79}
80#endif
81
82#endif /* PIPEWIRE_CONTROL_H */
pw_control_add_listener
void pw_control_add_listener(struct pw_control *control, struct spa_hook *listener, const struct pw_control_events *events, void *data)
Add an event listener on the control.
Definition: control.c:138
pw_control_get_port
struct pw_impl_port * pw_control_get_port(struct pw_control *control)
Get the control parent port or NULL when not set.
Definition: control.c:132
hook.h
spa/utils/hook.h
impl.h
pipewire/impl.h
pw_control_events
Port events, use pw_control_add_listener.
Definition: control.h:53
pw_control_events::unlinked
void(* unlinked)(void *data, struct pw_control *other)
control is unlinked from another control
Definition: control.h:67
pw_control_events::version
uint32_t version
Definition: control.h:56
pw_control_events::free
void(* free)(void *data)
The control is freed.
Definition: control.h:62
pw_control_events::destroy
void(* destroy)(void *data)
The control is destroyed.
Definition: control.h:59
pw_control_events::linked
void(* linked)(void *data, struct pw_control *other)
control is linked to another control
Definition: control.h:65
pw_control
pw_impl_port
Definition: impl.h:47
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:351