PipeWire  0.1.4
pw_link Class Reference

PipeWire link interface. More...

Collaboration diagram for pw_link:

Public Member Functions

const char * pw_link_state_as_string (enum pw_link_state state)
 Convert a pw_link_state to a readable string. More...
 
struct pw_linkpw_link_new (struct pw_core *core, struct pw_global *parent, struct pw_port *output, struct pw_port *input, struct spa_format *format_filter, struct pw_properties *properties, char **error, size_t user_data_size)
 Make a new link between two ports. More...
 
void pw_link_destroy (struct pw_link *link)
 Destroy a link. More...
 
struct pw_linkpw_link_find (struct pw_port *output, struct pw_port *input)
 Find the link between 2 ports. More...
 
bool pw_link_activate (struct pw_link *link)
 Activate a link. More...
 
bool pw_link_deactivate (struct pw_link *link)
 Deactivate a link. More...
 

Data Fields

struct pw_corecore
 core object More...
 
struct spa_list link
 link in core link_list More...
 
struct pw_globalglobal
 global for this link More...
 
struct pw_link_info info
 introspectable link info More...
 
struct pw_propertiesproperties
 extra link properties More...
 
enum pw_link_state state
 link state More...
 
char * error
 error message when state error More...
 
struct spa_list resource_list
 list of bound resources More...
 
struct spa_port_io io
 link io area More...
 
struct pw_portoutput
 output port More...
 
struct spa_list output_link
 link in output port links More...
 
struct pw_portinput
 input port More...
 
struct spa_list input_link
 link in input port links More...
 
struct spa_hook_list listener_list
 
struct {
   struct spa_graph_port   out_port
 
   struct spa_graph_port   in_port
 
rt
 
void * user_data
 

Detailed Description

PipeWire link interface.

Member Function Documentation

◆ pw_link_activate()

bool pw_link_activate ( struct pw_link link)

Activate a link.

Starts the negotiation of formats and buffers on link and then starts data streaming

◆ pw_link_deactivate()

bool pw_link_deactivate ( struct pw_link link)

Deactivate a link.

◆ pw_link_destroy()

void pw_link_destroy ( struct pw_link link)

Destroy a link.

◆ pw_link_find()

struct pw_link * pw_link_find ( struct pw_port output,
struct pw_port input 
)

Find the link between 2 ports.

◆ pw_link_new()

struct pw_link * pw_link_new ( struct pw_core core,
struct pw_global parent,
struct pw_port output,
struct pw_port input,
struct spa_format *  format_filter,
struct pw_properties properties,
char **  error,
size_t  user_data_size 
)

Make a new link between two ports.

Returns
a newly allocated link
Parameters
corethe core object
parentparent global
outputan output port
inputan input port
format_filteran optional format filter
propertiesextra properties
errorerror string when result is NULL
user_data_sizeextra user data size

◆ pw_link_state_as_string()

const char * pw_link_state_as_string ( enum pw_link_state  state)

Convert a pw_link_state to a readable string.

Field Documentation

◆ core

struct pw_core* pw_link::core

core object

Referenced by pw_link_get_core().

◆ error

char* pw_link::error

error message when state error

◆ global

struct pw_global* pw_link::global

global for this link

Referenced by pw_link_destroy(), and pw_link_get_global().

◆ in_port

struct spa_graph_port pw_link::in_port

◆ info

struct pw_link_info pw_link::info

introspectable link info

Referenced by pw_link_get_info().

◆ input

struct pw_port* pw_link::input

input port

Referenced by pw_link_find(), pw_link_get_input(), and pw_link_inc_idle().

◆ input_link

struct spa_list pw_link::input_link

link in input port links

◆ io

struct spa_port_io pw_link::io

link io area

◆ link

struct spa_list pw_link::link

link in core link_list

Referenced by pw_link_destroy().

◆ listener_list

struct spa_hook_list pw_link::listener_list

◆ out_port

struct spa_graph_port pw_link::out_port

◆ output

struct pw_port* pw_link::output

output port

Referenced by pw_link_get_output(), and pw_link_inc_idle().

◆ output_link

struct spa_list pw_link::output_link

link in output port links

Referenced by pw_link_find().

◆ properties

struct pw_properties* pw_link::properties

extra link properties

◆ resource_list

struct spa_list pw_link::resource_list

list of bound resources

Referenced by pw_link_destroy().

◆ rt

struct { ... } pw_link::rt

◆ state

enum pw_link_state pw_link::state

link state

◆ user_data

void* pw_link::user_data

Referenced by pw_link_get_user_data().


The documentation for this class was generated from the following files: