PipeWire  0.1.4
port.h File Reference
Include dependency graph for port.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  pw_port_implementation
 
struct  pw_port_events
 

Macros

#define PW_TYPE__Port   "PipeWire:Object:Port"
 
#define PW_TYPE_PORT_BASE   PW_TYPE__Port ":"
 
#define PW_VERSION_PORT_IMPLEMENTATION   0
 
#define PW_VERSION_PORT_EVENTS   0
 

Enumerations

enum  pw_port_state {
  PW_PORT_STATE_ERROR = -1,
  PW_PORT_STATE_INIT = 0,
  PW_PORT_STATE_CONFIGURE = 1,
  PW_PORT_STATE_READY = 2,
  PW_PORT_STATE_PAUSED = 3,
  PW_PORT_STATE_STREAMING = 4
}
 

Functions

enum pw_direction pw_port_get_direction (struct pw_port *port)
 Get the port direction. More...
 
const struct pw_propertiespw_port_get_properties (struct pw_port *port)
 
void pw_port_update_properties (struct pw_port *port, const struct spa_dict *dict)
 
uint32_t pw_port_get_id (struct pw_port *port)
 Get the port id. More...
 
struct pw_nodepw_port_get_node (struct pw_port *port)
 Get the port parent node or NULL when not yet set. More...
 
void pw_port_set_implementation (struct pw_port *port, const struct pw_port_implementation *implementation, void *data)
 
void pw_port_add_listener (struct pw_port *port, struct spa_hook *listener, const struct pw_port_events *events, void *data)
 
void * pw_port_get_user_data (struct pw_port *port)
 

Macro Definition Documentation

◆ PW_TYPE__Port

#define PW_TYPE__Port   "PipeWire:Object:Port"

◆ PW_TYPE_PORT_BASE

#define PW_TYPE_PORT_BASE   PW_TYPE__Port ":"

◆ PW_VERSION_PORT_EVENTS

#define PW_VERSION_PORT_EVENTS   0

◆ PW_VERSION_PORT_IMPLEMENTATION

#define PW_VERSION_PORT_IMPLEMENTATION   0

Enumeration Type Documentation

◆ pw_port_state

Enumerator
PW_PORT_STATE_ERROR 
PW_PORT_STATE_INIT 
PW_PORT_STATE_CONFIGURE 
PW_PORT_STATE_READY 
PW_PORT_STATE_PAUSED 
PW_PORT_STATE_STREAMING 

Function Documentation

◆ pw_port_add_listener()

void pw_port_add_listener ( struct pw_port port,
struct spa_hook *  listener,
const struct pw_port_events events,
void *  data 
)

References pw_port::listener_list.

Referenced by pw_link_new().

◆ pw_port_get_direction()

enum pw_direction pw_port_get_direction ( struct pw_port port)

Get the port direction.

References pw_port::direction.

◆ pw_port_get_id()

uint32_t pw_port_get_id ( struct pw_port port)

Get the port id.

References pw_port::port_id.

◆ pw_port_get_node()

struct pw_node* pw_port_get_node ( struct pw_port port)

Get the port parent node or NULL when not yet set.

References pw_port::node.

◆ pw_port_get_properties()

const struct pw_properties* pw_port_get_properties ( struct pw_port port)

References pw_port::properties.

◆ pw_port_get_user_data()

void* pw_port_get_user_data ( struct pw_port port)

References pw_port::user_data.

◆ pw_port_set_implementation()

void pw_port_set_implementation ( struct pw_port port,
const struct pw_port_implementation implementation,
void *  data 
)

◆ pw_port_update_properties()

void pw_port_update_properties ( struct pw_port port,
const struct spa_dict *  dict 
)