PipeWire  0.1.4.1
remote.h
Go to the documentation of this file.
1 /* PipeWire
2  * Copyright (C) 2015 Wim Taymans <wim.taymans@gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19 
20 #ifndef __PIPEWIRE_REMOTE_H__
21 #define __PIPEWIRE_REMOTE_H__
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 #include <spa/hook.h>
28 
107 struct pw_remote;
108 
109 #include <pipewire/core.h>
110 #include <pipewire/properties.h>
111 #include <pipewire/protocol.h>
112 #include <pipewire/proxy.h>
113 
120 };
121 
123 const char *pw_remote_state_as_string(enum pw_remote_state state);
124 
127 #define PW_VERSION_REMOTE_EVENTS 0
128  uint32_t version;
129 
131  void (*destroy) (void *data);
133  void (*info_changed) (void *data, const struct pw_core_info *info);
135  void (*sync_reply) (void *data, uint32_t seq);
137  void (*state_changed) (void *data, enum pw_remote_state old,
138  enum pw_remote_state state, const char *error);
139 };
140 
143 struct pw_remote *
144 pw_remote_new(struct pw_core *core,
145  struct pw_properties *properties );
147 
149 void pw_remote_destroy(struct pw_remote *remote);
150 
152 struct pw_core *pw_remote_get_core(struct pw_remote *remote);
153 
155 enum pw_remote_state pw_remote_get_state(struct pw_remote *remote, const char **error);
156 
158 void pw_remote_add_listener(struct pw_remote *remote,
159  struct spa_hook *listener,
160  const struct pw_remote_events *events,
161  void *data);
162 
165 int pw_remote_connect(struct pw_remote *remote);
166 
170 int pw_remote_connect_fd(struct pw_remote *remote, int fd);
171 
173 struct pw_core_proxy * pw_remote_get_core_proxy(struct pw_remote *remote);
174 
176 const struct pw_core_info *pw_remote_get_core_info(struct pw_remote *remote);
177 
179 struct pw_proxy *pw_remote_get_proxy(struct pw_remote *remote, uint32_t id);
180 
182 void pw_remote_disconnect(struct pw_remote *remote);
183 
185 void pw_remote_update_state(struct pw_remote *remote, enum pw_remote_state state, const char *fmt, ...);
186 
188 struct pw_proxy *pw_remote_export(struct pw_remote *remote, struct pw_node *node);
189 
190 #ifdef __cplusplus
191 }
192 #endif
193 
194 #endif /* __PIPEWIRE_REMOTE_H__ */
A collection of key/value pairs.
Definition: properties.h:38
void pw_remote_add_listener(struct pw_remote *remote, struct spa_hook *listener, const struct pw_remote_events *events, void *data)
Add listener for events.
Definition: remote.c:298
not connected
Definition: remote.h:117
const char * pw_remote_state_as_string(enum pw_remote_state state)
Convert a pw_remote_state to a readable string.
Definition: remote.c:91
struct pw_core * pw_remote_get_core(struct pw_remote *remote)
Get the core used to construct this remote.
Definition: remote.c:286
the core PipeWire object
uint32_t version
Definition: remote.h:128
connecting to remote PipeWire
Definition: remote.h:118
The core information.
Definition: introspect.h:76
struct pw_proxy * pw_remote_export(struct pw_remote *remote, struct pw_node *node)
run a local node in a remote graph
Definition: remote.c:1026
void(* destroy)(void *data)
The remote is destroyed.
Definition: remote.h:131
void pw_remote_update_state(struct pw_remote *remote, enum pw_remote_state state, const char *fmt,...)
Update the state of the remote, mostly used by protocols.
Definition: remote.c:107
void(* sync_reply)(void *data, uint32_t seq)
emited when a reply to a sync was received
Definition: remote.h:135
Represents an object on the client side.
int pw_remote_connect(struct pw_remote *remote)
Definition: remote.c:345
void pw_remote_destroy(struct pw_remote *remote)
Definition: remote.c:262
int pw_remote_connect_fd(struct pw_remote *remote, int fd)
Definition: remote.c:359
struct pw_proxy * pw_remote_get_proxy(struct pw_remote *remote, uint32_t id)
Get the proxy with the given id.
Definition: remote.c:340
remote is connected and ready
Definition: remote.h:119
Represents a connection with a remote PipeWire instance.
enum pw_remote_state pw_remote_get_state(struct pw_remote *remote, const char **error)
Get the current state, error is set when state is PW_REMOTE_STATE_ERROR.
Definition: remote.c:291
void(* state_changed)(void *data, enum pw_remote_state old, enum pw_remote_state state, const char *error)
emited when the state changes
Definition: remote.h:137
struct pw_remote * pw_remote_new(struct pw_core *core, struct pw_properties *properties)
Definition: remote.c:197
struct pw_core_proxy * pw_remote_get_core_proxy(struct pw_remote *remote)
Get the core proxy, can only be called when connected.
Definition: remote.c:330
void pw_remote_disconnect(struct pw_remote *remote)
Definition: remote.c:373
PipeWire node class.
void(* info_changed)(void *data, const struct pw_core_info *info)
emited when the remote core info changed
Definition: remote.h:133
Events for the remote.
Definition: remote.h:126
pw_remote_state
The state of a pw_remote.
Definition: remote.h:115
remote is in error
Definition: remote.h:116
const struct pw_core_info * pw_remote_get_core_info(struct pw_remote *remote)
Get the remote core info, can only be called when connected.
Definition: remote.c:335