control.h
Go to the documentation of this file.
/* PipeWire
*
* Copyright © 2018 Wim Taymans
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#ifndef PIPEWIRE_CONTROL_H
#define PIPEWIRE_CONTROL_H
#ifdef __cplusplus
extern "C" {
#endif
#include <spa/utils/hook.h>
struct pw_control;
#include <pipewire/impl.h>
struct pw_control_events {
#define PW_VERSION_CONTROL_EVENTS 0
uint32_t version;
void (*destroy) (void *data);
void (*free) (void *data);
void (*linked) (void *data, struct pw_control *other);
void (*unlinked) (void *data, struct pw_control *other);
};
struct pw_impl_port *pw_control_get_port(struct pw_control *control);
void pw_control_add_listener(struct pw_control *control,
struct spa_hook *listener,
const struct pw_control_events *events,
void *data);
#ifdef __cplusplus
}
#endif
#endif /* PIPEWIRE_CONTROL_H */
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
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
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:342