summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSeungha Yang <seungha@centricular.com>2021-07-27 18:33:18 +0900
committerSeungha Yang <seungha@centricular.com>2021-07-30 15:58:20 +0900
commit4a5197dc27a3300111df5ee44a613a58ccdabd47 (patch)
tree6d91de4092f08ecd7e97f06327c64c494e617af6 /docs
parent4ed342db5d3da7baabad258b5530a1724c268e04 (diff)
downloadgstreamer-plugins-good-4a5197dc27a3300111df5ee44a613a58ccdabd47.tar.gz
jack: Add port-names property to select ports explicitly
By this new property, user can select physical port to connect, and element will pick requested port instead of random ones. User should provide full port name including "client_name:" prefix. An example is jackaudiosrc port-names="system:capture_1,system:capture_3" ! ... jackaudiosink port-names="system:playback_2" In addition to "port-names" property, a new connect type "explicit" is added so that element can post error message if requested "port-names" contains invalid port(s). Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-good/-/merge_requests/1037>
Diffstat (limited to 'docs')
-rw-r--r--docs/gst_plugins_cache.json29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/gst_plugins_cache.json b/docs/gst_plugins_cache.json
index 44f006d85..c23a7b745 100644
--- a/docs/gst_plugins_cache.json
+++ b/docs/gst_plugins_cache.json
@@ -8356,6 +8356,18 @@
"type": "gboolean",
"writable": true
},
+ "port-names": {
+ "blurb": "Comma-separated list of port name including \"client_name:\" prefix",
+ "conditionally-available": false,
+ "construct": false,
+ "construct-only": false,
+ "controllable": false,
+ "default": "NULL",
+ "mutable": "ready",
+ "readable": true,
+ "type": "gchararray",
+ "writable": true
+ },
"port-pattern": {
"blurb": "A pattern to select which ports to connect to (NULL = first physical ports)",
"conditionally-available": false,
@@ -8465,6 +8477,18 @@
"type": "gboolean",
"writable": true
},
+ "port-names": {
+ "blurb": "Comma-separated list of port name including \"client_name:\" prefix",
+ "conditionally-available": false,
+ "construct": false,
+ "construct-only": false,
+ "controllable": false,
+ "default": "NULL",
+ "mutable": "ready",
+ "readable": true,
+ "type": "gchararray",
+ "writable": true
+ },
"port-pattern": {
"blurb": "A pattern to select which ports to connect to (NULL = first physical ports)",
"conditionally-available": false,
@@ -8525,6 +8549,11 @@
"desc": "Automatically connect ports to as many physical ports as possible",
"name": "auto-forced",
"value": "2"
+ },
+ {
+ "desc": "Connect ports to explicitly requested physical ports",
+ "name": "explicit",
+ "value": "3"
}
]
},