.TH "libpipewire-module-client-device" 7 "1.6.8" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-client-device \- Client Device 
.SH DESCRIPTION
.PP
Allow clients to export devices to the PipeWire daemon\&.

.PP
This module creates an export type for the \fBSPA_TYPE_INTERFACE_Device\fP interface\&.

.PP
With \fBpw_core_export()\fP, objects of this type can be exported to the PipeWire server\&. All actions performed on the device locally will be visible to connecteced clients\&.

.PP
In some cases, it is possible to use this factory directly\&. With \fBpw_core_create_object()\fP on the \fRclient-device\fP factory will result in a \fBSPA_TYPE_INTERFACE_Device\fP proxy that can be used to control the server side created \fBDevice Impl\fP\&.

.PP
Schematically, the client side \fBDevice\fP is wrapped in the ClientDevice proxy and unwrapped by the server side resource so that all actions on the client side device are reflected on the server side device and server side actions are reflected in the client\&.

.PP
.PP
.nf
  client side proxy                            server side resource
\&.\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\&.            \&.\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\&.
| SPA_TYPE_INTERFACE_Device    |            |  PW_TYPE_INTERFACE_Device        |
|                              |  IPC       |\&.\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\&.|
|                              | \-\-\-\-\->     || SPA_TYPE_INTERFACE_Device      ||
|                              |            |'\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-'|
'\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-'            '\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-'
.fi
.PP

.PP
.SH "MODULE NAME"
.PP

.PP
\fRlibpipewire-module-client-device\fP

.PP
.SH "MODULE OPTIONS"
.PP

.PP
This module has no options\&.

.PP
.SH "PROPERTIES FOR THE CREATE_OBJECT CALL"
.PP

.PP
All properties are passed directly to the \fBpw_context_create_device()\fP call\&.

.PP
.SH "EXAMPLE CONFIGURATION"
.PP

.PP
The module is usually added to the config file of the main PipeWire daemon and the clients\&.

.PP
.PP
.nf
context\&.modules = [
{ name = libpipewire\-module\-client\-device }
]
.fi
.PP

.PP
.SH "SEE ALSO"
.PP

.PP
.IP "\(bu" 2
\fRmodule-spa-device-factory\fP: make nodes from a factory 
.PP