Documentation made easier

libpipewire-module-example-source

NAME
MODULE NAME
MODULE OPTIONS
GENERAL OPTIONS
EXAMPLE CONFIGURATION

NAME

libpipewire-module-example-source − Example Source The example source is a good starting point for writing a custom source.

We refer to the source code for more information.

MODULE NAME

libpipewire-module-example-source

MODULE OPTIONS

	•		`node.name`: a unique name for the stream
	•		`node.description`: a human readable name for the stream
	•		`stream.props = {}`: properties to be passed to the stream

GENERAL OPTIONS

Options with well-known behavior.

	•		remote.name
	•		audio.format
	•		audio.rate
	•		audio.channels
	•		audio.position
	•		media.name
	•		node.latency
	•		node.name
	•		node.description
	•		node.group
	•		node.virtual
	•		media.class

EXAMPLE CONFIGURATION

context.modules = [
{ name = libpipewire-module-example-source
args = {
node.name = "example_source"
node.description = "My Example Source"
stream.props = {
audio.position = [ FL FR ]
}
}
}
]

Back to Index