pipewire/doc/source-api.txt

85 lines
2.0 KiB
Plaintext

Source
------
Service: org.pulsevideo
Interface: org.pulsevideo.Source1
Object Path: freely definable
The Source object defines a source of video. You can query the list of
supported formats and get a SourceOutput object that can be used to
control the video Source.
Methods a{a{sv}} GetCapabilities (dict args)
Get a list of supported formats
Possible Errors: org.pulsevideo.Error.NotAuthorized
org.pulsevideo.Error.Failed
object CreateSourceOutput (dict args)
Create a sourceoutput with given capabilities
Possible Errors: org.pulsevideo.Error.NotAuthorized
org.pulsevideo.Error.Failed
void RemoveSourceOutput (object sourceoutput)
Remove a sourceoutput.
Possible Errors: org.pulsevideo.Error.NotAuthorized
org.pulsevideo.Error.Failed
Properties string Name [readonly]
Name of the source
strinf Priority [readonly]
Priority of the source
SourceOutput
------------
Service org.pulsevideo
Interface org.pulsevideo.SourceOutput1
Object Path: freely definable
Methods fd Acquire()
Acquire transport file descriptor read and .
Possible Errors: org.pulsevideo.Error.NotAuthorized
org.pulsevideo.Error.Failed
void Release ()
Release transport file descriptor
Properties object Source [readonly]
Path of the Source object
dict transport [readonly]
Transport properties
Client
------
Service org.pulsevideo
Interface org.pulsevideo.Client1