PipeWire
0.1.4
|
PipeWire stream object class. More...
Public Member Functions | |
const char * | pw_stream_state_as_string (enum pw_stream_state state) |
Convert a stream state to a readable string. More... | |
struct pw_stream * | pw_stream_new (struct pw_remote *remote, const char *name, struct pw_properties *props) |
Create a new unconneced pw_stream. More... | |
void | pw_stream_destroy (struct pw_stream *stream) |
Destroy a stream. More... | |
bool | pw_stream_connect (struct pw_stream *stream, enum pw_direction direction, enum pw_stream_mode mode, const char *port_path, enum pw_stream_flags flags, uint32_t n_possible_formats, const struct spa_format **possible_formats) |
Connect a stream for input or output on port_path. More... | |
uint32_t | pw_stream_get_node_id (struct pw_stream *stream) |
Get the node ID of the stream. More... | |
void | pw_stream_disconnect (struct pw_stream *stream) |
Disconnect stream. More... | |
void | pw_stream_finish_format (struct pw_stream *stream, int res, struct spa_param **params, uint32_t n_params) |
Complete the negotiation process with result code res. More... | |
bool | pw_stream_get_time (struct pw_stream *stream, struct pw_time *time) |
Query the time on the stream. More... | |
uint32_t | pw_stream_get_empty_buffer (struct pw_stream *stream) |
Get the id of an empty buffer that can be filled. More... | |
bool | pw_stream_recycle_buffer (struct pw_stream *stream, uint32_t id) |
Recycle the buffer with id. More... | |
struct spa_buffer * | pw_stream_peek_buffer (struct pw_stream *stream, uint32_t id) |
Get the buffer with id from stream. More... | |
bool | pw_stream_send_buffer (struct pw_stream *stream, uint32_t id) |
Send a buffer with id to stream. More... | |
Data Fields | |
struct pw_remote * | remote |
the owner remote More... | |
struct spa_list | link |
link in the remote More... | |
char * | name |
the name of the stream More... | |
uint32_t | node_id |
node id for remote node, available from CONFIGURE state and higher More... | |
struct pw_properties * | properties |
properties of the stream More... | |
enum pw_stream_state | state |
stream state More... | |
char * | error |
error reason when state is in error More... | |
struct spa_hook_list | listener_list |
PipeWire stream object class.
The stream object provides a convenient way to send and receive data streams from/to PipeWire.
See also Media Streams and page_client_api
bool pw_stream_connect | ( | struct pw_stream * | stream, |
enum pw_direction | direction, | ||
enum pw_stream_mode | mode, | ||
const char * | port_path, | ||
enum pw_stream_flags | flags, | ||
uint32_t | n_possible_formats, | ||
const struct spa_format ** | possible_formats | ||
) |
Connect a stream for input or output on port_path.
When mode is PW_STREAM_MODE_BUFFER, you should connect to the new-buffer signal and use pw_stream_peek_buffer() to get the latest metadata and data.
stream | a pw_stream |
direction | the stream direction |
mode | a pw_stream_mode |
port_path | the port path to connect to or NULL to let the server choose a port |
flags | stream flags |
n_possible_formats | number of items in possible_formats |
possible_formats | an array with possible accepted formats |
void pw_stream_destroy | ( | struct pw_stream * | stream | ) |
Destroy a stream.
void pw_stream_disconnect | ( | struct pw_stream * | stream | ) |
Disconnect stream.
void pw_stream_finish_format | ( | struct pw_stream * | stream, |
int | res, | ||
struct spa_param ** | params, | ||
uint32_t | n_params | ||
) |
Complete the negotiation process with result code res.
This function should be called after notification of the format.
When res indicates success, params contain the parameters for the allocation state.
stream | a pw_stream |
res | a result code |
params | an array of pointers to spa_param |
n_params | number of elements in params |
uint32_t pw_stream_get_empty_buffer | ( | struct pw_stream * | stream | ) |
Get the id of an empty buffer that can be filled.
uint32_t pw_stream_get_node_id | ( | struct pw_stream * | stream | ) |
Get the node ID of the stream.
Query the time on the stream.
struct pw_stream * pw_stream_new | ( | struct pw_remote * | remote, |
const char * | name, | ||
struct pw_properties * | props | ||
) |
struct spa_buffer * pw_stream_peek_buffer | ( | struct pw_stream * | stream, |
uint32_t | id | ||
) |
Get the buffer with id from stream.
This function should be called from the new-buffer event.
bool pw_stream_recycle_buffer | ( | struct pw_stream * | stream, |
uint32_t | id | ||
) |
Recycle the buffer with id.
bool pw_stream_send_buffer | ( | struct pw_stream * | stream, |
uint32_t | id | ||
) |
Send a buffer with id to stream.
For provider or playback streams, this function should be called whenever there is a new buffer available.
const char * pw_stream_state_as_string | ( | enum pw_stream_state | state | ) |
Convert a stream state to a readable string.
char* pw_stream::error |
error reason when state is in error
Referenced by pw_stream_get_state().
struct spa_list pw_stream::link |
link in the remote
Referenced by pw_remote_destroy(), pw_remote_disconnect(), and pw_stream_destroy().
struct spa_hook_list pw_stream::listener_list |
Referenced by pw_stream_add_listener(), pw_stream_destroy(), and pw_stream_new().
char* pw_stream::name |
the name of the stream
Referenced by pw_stream_get_name().
uint32_t pw_stream::node_id |
node id for remote node, available from CONFIGURE state and higher
Referenced by pw_stream_get_node_id().
struct pw_properties* pw_stream::properties |
properties of the stream
Referenced by pw_stream_get_properties(), and pw_stream_new().
struct pw_remote* pw_stream::remote |
the owner remote
Referenced by pw_stream_new().
enum pw_stream_state pw_stream::state |
stream state
Referenced by pw_stream_get_state().