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)
 
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
{{Module|name=jack|type=Audio input and output|description=JACK Audio Connection Kit audio input and output|os=Unix, Linux, BSD|first_version=0.8.5 (output)<br> 0.9.0 (input)}}
+
This module allows {{VLC}} to connect to [[JACK Audio Connection Kit]].
−
''for {{VLC media player}}''
 
−
<br>
 
−
== Introduction ==
 
−
Allows VLC to connect to [[wikipedia:JACK Audio Connection Kit|JACK]].
 
−
== Options ==
 
−
=== JACK audio input (access_jack) ===
 
−
;<tt>--jack-input-caching <integer></tt>
 
−
:''Caching value in ms''
 
−
:Make VLC buffer audio data captured from JACK for the specified length in milliseconds.
 
−
;<tt>--jack-input-use-vlc-pace</tt>, <tt>--no-jack-input-use-vlc-pace</tt>
 
−
:''Pace (default disabled)''
 
−
:Read the audio stream at VLC pace rather than JACK pace. (default disabled)
 
−
;<tt>--jack-input-auto-connect</tt>, <tt>--no-jack-input-auto-connect</tt>
 
−
:''Auto Connection (default disabled)''
 
−
:Automatically connect VLC input ports to available output ports. (default disabled)
 
  
−
=== JACK audio output (jack) ===
+
== Access ==
−
;<tt>--jack-auto-connect</tt>, <tt>--no-jack-auto-connect</tt>
+
{{Module|name=jack|type=Access|first_version=0.9.0|os=Unix, Linux, BSD|description=JACK input|sc=jack}}
−
:''Automatically connect to writable clients (default disabled)''
+
 
−
:If enabled, this option will automatically connect sound output to the first writable JACK clients found. (default disabled)
+
The option <code>--jack-input-caching</code> no longer exists, removed with a commitdiff entitled {{Commitdiff|31ac20b22fc37bcf78991159bf8a0f138db05b44|l=Unify (ACCESS{{!}}DEMUX)_GET_PTS_DELAY}}.
−
;<tt>--jack-connect-regex <string></tt>
 
−
:''Connect to clients matching''
 
−
:If automatic connection is enabled, only JACK clients whose names match this [[wikipedia:regular expression|regular expression]] will be considered for connection.
 
 
<!--
 
<!--
−
== See Also ==
+
{{Option
 +
|name=jack-input-caching
 +
|value=integer
 +
|description=Make VLC buffer audio data captured from JACK for the specified length in milliseconds
 +
}}
 
-->
 
-->
 +
{{Option
 +
|name=jack-input-use-vlc-pace
 +
|value=boolean
 +
|default=disabled
 +
|description=Read the audio stream at VLC pace rather than Jack pace
 +
}}
 +
{{Option
 +
|name=jack-input-auto-connect
 +
|value=boolean
 +
|default=disabled
 +
|description=Automatically connect VLC input [[port]]s to available output ports
 +
}}
 +
{{Clear}}
 +
 +
== 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}}
  
−
== References ==
+
== Source code ==
−
<pre>
+
* {{VLCSourceFile|modules/access/jack.c}}
−
vlc --version
+
* {{VLCSourceFile|modules/audio_output/jack.c}}
−
VLC media player 1.0.6 Goldeneye
 
−
VLC version 1.0.6 Goldeneye
 
−
Compiled by buildd@palmer.buildd
 
−
Compiler: gcc version 4.4.3 (Ubuntu 4.4.3-4ubuntu5)
 
−
vlc -p jack --advanced --help-verbose
 
−
</pre>
 
  
−
== External Links ==
+
{{Documentation}}
−
*[[wikipedia:JACK_Audio_Connection_Kit|Jack]] at Wikipedia
 
−
*[http://jackaudio.org Jack Audio Project]
 
−
[[Category:Modules]]
 

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 Guide • Streaming HowTo • Hacker Guide • Modules)
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.
Retrieved from "https://wiki.videolan.org/index.php?title=Documentation:Modules/jack&oldid=61453"