Initialization

Initializing PipeWire and loading SPA modules. More...

Files
file	pipewire.h
	pipewire/pipewire.h

Functions
void	pw_init (int *argc, char **argv[])
	Initialize PipeWire. More...
void	pw_deinit (void)
bool	pw_debug_is_category_enabled (const char *name)
	Check if a debug category is enabled. More...
const char *	pw_get_application_name (void)
	Get the application name. More...
const char *	pw_get_prgname (void)
	Get the program name. More...
const char *	pw_get_user_name (void)
	Get the user name. More...
const char *	pw_get_host_name (void)
	Get the host name. More...
const char *	pw_get_client_name (void)
	Get the client name. More...
bool	pw_in_valgrind (void)
bool	pw_check_option (const char *option, const char *value)
enum pw_direction	pw_direction_reverse (enum pw_direction direction)
	Reverse the direction. More...
int	pw_set_domain (const char *domain)
const char *	pw_get_domain (void)
uint32_t	pw_get_support (struct spa_support *support, uint32_t max_support)
struct spa_handle *	pw_load_spa_handle (const char *lib, const char *factory_name, const struct spa_dict *info, uint32_t n_support, const struct spa_support support[])
int	pw_unload_spa_handle (struct spa_handle *handle)

Detailed Description

Initializing PipeWire and loading SPA modules.

Function Documentation

pw_init()

void pw_init	(	int *	argc,
		char **	argv[]
	)

Initialize PipeWire.

Parameters

argc	pointer to argc
argv	pointer to argv

Initialize the PipeWire system, parse and modify any parameters given by argc and argv and set up debugging.

The environment variable PIPEWIRE_DEBUG

Examples

audio-dsp-filter.c, audio-dsp-src.c, audio-src.c, bluez-session.c, export-sink.c, export-source.c, export-spa-device.c, export-spa.c, local-v4l2.c, tutorial1.c, tutorial2.c, tutorial3.c, tutorial4.c, tutorial5.c, tutorial6.c, video-dsp-play.c, video-play-fixate.c, video-play-pull.c, video-play-reneg.c, video-play.c, video-src-alloc.c, video-src-fixate.c, video-src-reneg.c, and video-src.c.

pw_deinit()

void pw_deinit

(

void

)

Examples

audio-dsp-filter.c, audio-dsp-src.c, audio-src.c, local-v4l2.c, video-play-fixate.c, video-play-pull.c, video-play-reneg.c, video-play.c, video-src-alloc.c, video-src-fixate.c, video-src-reneg.c, and video-src.c.

pw_debug_is_category_enabled()

bool pw_debug_is_category_enabled

(

const char *

name

)

Check if a debug category is enabled.

Parameters

name	the name of the category to check

Returns

true if enabled

Debugging categories can be enabled by using the PIPEWIRE_DEBUG environment variable

pw_get_application_name()

const char* pw_get_application_name

(

void

)

Get the application name.

pw_get_prgname()

const char* pw_get_prgname

(

void

)

Get the program name.

pw_get_user_name()

const char* pw_get_user_name

(

void

)

Get the user name.

pw_get_host_name()

const char* pw_get_host_name

(

void

)

Get the host name.

pw_get_client_name()

const char* pw_get_client_name

(

void

)

Get the client name.

Make a new PipeWire client name that can be used to construct a remote.

pw_in_valgrind()

bool pw_in_valgrind

(

void

)

pw_check_option()

bool pw_check_option	(	const char *	option,
		const char *	value
	)

pw_direction_reverse()

enum pw_direction pw_direction_reverse

(

enum pw_direction

direction

)

Reverse the direction.

pw_set_domain()

int pw_set_domain

(

const char *

domain

)

pw_get_domain()

const char* pw_get_domain

(

void

)

pw_get_support()

uint32_t pw_get_support	(	struct spa_support *	support,
		uint32_t	max_support
	)

pw_load_spa_handle()

struct spa_handle* pw_load_spa_handle	(	const char *	lib,
		const char *	factory_name,
		const struct spa_dict *	info,
		uint32_t	n_support,
		const struct spa_support	support[]
	)

pw_unload_spa_handle()

int pw_unload_spa_handle

(

struct spa_handle *

handle

)

Examples

bluez-session.c.