remote.h
Go to the documentation of this file.
/* PipeWire
* Copyright (C) 2015 Wim Taymans <wim.taymans@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __PIPEWIRE_REMOTE_H__
#define __PIPEWIRE_REMOTE_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <spa/utils/hook.h>
struct pw_remote;
#include <pipewire/core.h>
#include <pipewire/properties.h>
#include <pipewire/protocol.h>
#include <pipewire/proxy.h>
enum pw_remote_state {
PW_REMOTE_STATE_ERROR = -1,
PW_REMOTE_STATE_UNCONNECTED = 0,
PW_REMOTE_STATE_CONNECTING = 1,
PW_REMOTE_STATE_CONNECTED = 2,
};
const char *pw_remote_state_as_string(enum pw_remote_state state);
struct pw_remote_events {
#define PW_VERSION_REMOTE_EVENTS 0
uint32_t version;
void (*destroy) (void *data);
void (*info_changed) (void *data, const struct pw_core_info *info);
void (*sync_reply) (void *data, uint32_t seq);
void (*state_changed) (void *data, enum pw_remote_state old,
enum pw_remote_state state, const char *error);
};
#define PW_REMOTE_PROP_PROTOCOL "pipewire.protocol"
#define PW_REMOTE_PROP_REMOTE_NAME "pipewire.remote.name"
struct pw_remote *
pw_remote_new(struct pw_core *core,
struct pw_properties *properties,
size_t user_data_size );
void pw_remote_destroy(struct pw_remote *remote);
struct pw_core *pw_remote_get_core(struct pw_remote *remote);
const struct pw_properties *pw_remote_get_properties(struct pw_remote *remote);
void *pw_remote_get_user_data(struct pw_remote *remote);
enum pw_remote_state pw_remote_get_state(struct pw_remote *remote, const char **error);
void pw_remote_add_listener(struct pw_remote *remote,
struct spa_hook *listener,
const struct pw_remote_events *events,
void *data);
int pw_remote_connect(struct pw_remote *remote);
int pw_remote_connect_fd(struct pw_remote *remote, int fd);
int pw_remote_steal_fd(struct pw_remote *remote);
struct pw_core_proxy * pw_remote_get_core_proxy(struct pw_remote *remote);
const struct pw_core_info *pw_remote_get_core_info(struct pw_remote *remote);
struct pw_proxy *pw_remote_find_proxy(struct pw_remote *remote, uint32_t id);
int pw_remote_disconnect(struct pw_remote *remote);
struct pw_proxy *pw_remote_export(struct pw_remote *remote, struct pw_node *node);
#ifdef __cplusplus
}
#endif
#endif /* __PIPEWIRE_REMOTE_H__ */
pw_properties
A collection of key/value pairs.
Definition: properties.h:38
pw_remote_add_listener
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:346
PW_REMOTE_STATE_UNCONNECTED
not connected
Definition: remote.h:117
pw_remote_new
SPA_EXPORT struct pw_remote * pw_remote_new(struct pw_core *core, struct pw_properties *properties, size_t user_data_size)
Definition: remote.c:215
pw_remote_find_proxy
struct pw_proxy * pw_remote_find_proxy(struct pw_remote *remote, uint32_t id)
Get the proxy with the given id.
Definition: remote.c:392
pw_remote::pw_remote_state_as_string
const char * pw_remote_state_as_string(enum pw_remote_state state)
Convert a pw_remote_state to a readable string.
Definition: remote.c:107
pw_remote_get_core
struct pw_core * pw_remote_get_core(struct pw_remote *remote)
Get the core used to construct this remote.
Definition: remote.c:320
core.h
pw_core
the core PipeWire object
pw_remote_events::version
uint32_t version
Definition: remote.h:128
PW_REMOTE_STATE_CONNECTING
connecting to remote PipeWire
Definition: remote.h:118
pw_core_info
The core information.
Definition: introspect.h:76
pw_remote_export
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:1339
pw_remote_events::destroy
void(* destroy)(void *data)
The remote is destroyed.
Definition: remote.h:131
protocol.h
pw_remote_events::sync_reply
void(* sync_reply)(void *data, uint32_t seq)
emited when a reply to a sync was received
Definition: remote.h:135
pw_proxy
Represents an object on the client side.
pw_remote_disconnect
SPA_EXPORT int pw_remote_disconnect(struct pw_remote *remote)
Definition: remote.c:452
PW_REMOTE_STATE_CONNECTED
remote is connected and ready
Definition: remote.h:119
pw_remote_get_properties
const struct pw_properties * pw_remote_get_properties(struct pw_remote *remote)
Get the remote properties.
Definition: remote.c:326
pw_remote
Represents a connection with a remote PipeWire instance.
pw_remote_steal_fd
int pw_remote_steal_fd(struct pw_remote *remote)
Steal the fd of the remote connection or < 0 on error.
Definition: remote.c:441
pw_remote_get_state
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:338
pw_remote_events::state_changed
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
pw_remote_get_core_proxy
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:380
properties.h
proxy.h
pw_remote_get_user_data
void * pw_remote_get_user_data(struct pw_remote *remote)
Get the user_data.
Definition: remote.c:332
pw_node
PipeWire node class.
pw_remote_connect_fd
SPA_EXPORT int pw_remote_connect_fd(struct pw_remote *remote, int fd)
Definition: remote.c:425
pw_remote_events::info_changed
void(* info_changed)(void *data, const struct pw_core_info *info)
emited when the remote core info changed
Definition: remote.h:133
pw_remote_events
Events for the remote.
Definition: remote.h:126
pw_remote_state
pw_remote_state
The state of a pw_remote.
Definition: remote.h:115
PW_REMOTE_STATE_ERROR
remote is in error
Definition: remote.h:116
pw_remote_connect
SPA_EXPORT int pw_remote_connect(struct pw_remote *remote)
Definition: remote.c:410
pw_remote_destroy
SPA_EXPORT void pw_remote_destroy(struct pw_remote *remote)
Definition: remote.c:294
pw_remote_get_core_info
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:386