Difference between revisions of "Documentation:Modules/jack"

From VideoLAN Wiki
Jump to navigation Jump to search
(Updated to reflect current options. Should be GPL now)
 
(34 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 +
This module allows {{VLC}} to connect to [[JACK Audio Connection Kit]].
  
''for VLC media player 1.0.6 Goldeneye''
+
== Access ==
== JACK audio input (access_jack) ==
+
{{Module|name=jack|type=Access|first_version=0.9.0|os=Unix, Linux, BSD|description=JACK input|sc=jack}}
;jack-input-caching <integer>
+
 
::Caching value in ms
+
The option <code>--jack-input-caching</code> no longer exists, removed with a commitdiff entitled {{Commitdiff|31ac20b22fc37bcf78991159bf8a0f138db05b44|l=Unify (ACCESS{{!}}DEMUX)_GET_PTS_DELAY}}.
:Make VLC buffer audio data captured from jack for the specified length in milliseconds.
+
<!--
;jack-input-use-vlc-pace, --no-jack-input-use-vlc-pace
+
{{Option
::Pace (default disabled)
+
|name=jack-input-caching
:Read the audio stream at VLC pace rather than Jack pace. (default disabled)
+
|value=integer
;jack-input-auto-connect, --no-jack-input-auto-connect
+
|description=Make VLC buffer audio data captured from JACK for the specified length in milliseconds
::Auto Connection (default disabled)
+
}}
:Automatically connect VLC input ports to available output ports. (default disabled)
+
-->
<pre>
+
{{Option
JACK audio output (jack)
+
|name=jack-input-use-vlc-pace
      --jack-auto-connect, --no-jack-auto-connect
+
|value=boolean
                                Automatically connect to writable clients
+
|default=disabled
                                (default disabled)
+
|description=Read the audio stream at VLC pace rather than Jack pace
          If enabled, this option will automatically connect sound output to
+
}}
          the first writable JACK clients found. (default disabled)
+
{{Option
      --jack-connect-regex <string>
+
|name=jack-input-auto-connect
                                Connect to clients matching
+
|value=boolean
          If automatic connection is enabled, only JACK clients whose names
+
|default=disabled
          match this regular expression will be considered for connection.
+
|description=Automatically connect VLC input [[port]]s to available output ports
</pre>
+
}}
<code>
+
{{Clear}}
vlc -p jack --advanced --help-verbose
+
 
</code>
+
== Audio output ==
 +
{{Module|name=jack|type=Audio output|first_version=0.8.5|os=Unix, Linux, BSD|description=JACK audio output|sc=none}}
 +
{{Option
 +
|name=jack-auto-connect
 +
|value=boolean
 +
|default=enabled
 +
|description=If enabled, this option will automatically connect sound output to the first writable JACK clients found
 +
}}
 +
{{Option
 +
|name=jack-connect-regex
 +
|value=string
 +
|default="system"
 +
|description=If automatic connection is enabled, only JACK clients whose names match this [[wikipedia:regular expression|regular expression]] will be considered for connection
 +
}}
 +
{{Option
 +
|name=jack-name
 +
|value=string
 +
|default=""
 +
|description=JACK client name
 +
}}
 +
{{Clear}}
 +
 
 +
== Source code ==
 +
* {{VLCSourceFile|modules/access/jack.c}}
 +
* {{VLCSourceFile|modules/audio_output/jack.c}}
 +
 
 +
{{Documentation}}

Latest revision as of 02:52, 18 May 2019

This module allows VLC media player to connect to JACK Audio Connection Kit.

Access

Module: jack
Type Access
First VLC version 0.9.0
Last VLC version -
Operating system(s) Unix, Linux, BSD
Description JACK input
Shortcut(s) jack

The option --jack-input-caching no longer exists, removed with a commitdiff entitled Unify (ACCESS|DEMUX)_GET_PTS_DELAY.

  • jack-input-use-vlc-pace <boolean> : Read the audio stream at VLC pace rather than Jack pace default value: disabled
  • jack-input-auto-connect <boolean> : Automatically connect VLC input ports to available output ports default value: disabled

Audio output

Module: jack
Type Audio output
First VLC version 0.8.5
Last VLC version -
Operating system(s) Unix, Linux, BSD
Description JACK audio output
Shortcut(s) (none)
  • jack-auto-connect <boolean> : If enabled, this option will automatically connect sound output to the first writable JACK clients found default value: enabled
  • jack-connect-regex <string> : If automatic connection is enabled, only JACK clients whose names match this regular expression will be considered for connection default value: "system"
  • jack-name <string> : JACK client name default value: ""

Source code

This page is part of official VLC media player Documentation (User GuideStreaming HowToHacker GuideModules)
Please read the Documentation Editing Guidelines before you edit the documentation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.