Difference between revisions of "Documentation:Modules/jack"

From VideoLAN Wiki
Jump to navigation Jump to search
(Format/copy-edit)
(Updated to reflect current options. Should be GPL now)
 
(One intermediate revision by the same user 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]].
This module allows {{VLC}} to connect to [[wikipedia:JACK Audio Connection Kit|JACK]] by the [http://jackaudio.org Jack Audio Project].
 
  
== Options ==
+
== 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}}
 +
 
 +
The option <code>--jack-input-caching</code> no longer exists, removed with a commitdiff entitled {{Commitdiff|31ac20b22fc37bcf78991159bf8a0f138db05b44|l=Unify (ACCESS{{!}}DEMUX)_GET_PTS_DELAY}}.
 +
<!--
 
{{Option
 
{{Option
 
|name=jack-input-caching
 
|name=jack-input-caching
Line 9: Line 11:
 
|description=Make VLC buffer audio data captured from JACK for the specified length in milliseconds
 
|description=Make VLC buffer audio data captured from JACK for the specified length in milliseconds
 
}}
 
}}
 +
-->
 
{{Option
 
{{Option
 
|name=jack-input-use-vlc-pace
 
|name=jack-input-use-vlc-pace
 
|value=boolean
 
|value=boolean
 
|default=disabled
 
|default=disabled
|description=Read the audio stream at VLC pace rather than JACK pace
+
|description=Read the audio stream at VLC pace rather than Jack pace
 
}}
 
}}
 
{{Option
 
{{Option
Line 19: Line 22:
 
|value=boolean
 
|value=boolean
 
|default=disabled
 
|default=disabled
|description=Automatically connect VLC input ports to available output ports
+
|description=Automatically connect VLC input [[port]]s to available output ports
 
}}
 
}}
 +
{{Clear}}
  
=== JACK audio output (jack) ===
+
== Audio output ==
 +
{{Module|name=jack|type=Audio output|first_version=0.8.5|os=Unix, Linux, BSD|description=JACK audio output|sc=none}}
 
{{Option
 
{{Option
 
|name=jack-auto-connect
 
|name=jack-auto-connect
 
|value=boolean
 
|value=boolean
|default=disabled
+
|default=enabled
 
|description=If enabled, this option will automatically connect sound output to the first writable JACK clients found
 
|description=If enabled, this option will automatically connect sound output to the first writable JACK clients found
 
}}
 
}}
Line 32: Line 37:
 
|name=jack-connect-regex
 
|name=jack-connect-regex
 
|value=string
 
|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
 
|description=If automatic connection is enabled, only JACK clients whose names match this [[wikipedia:regular expression|regular expression]] will be considered for connection
 
}}
 
}}
<!--
+
{{Option
== See Also ==
+
|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>
 
  
 
{{Documentation}}
 
{{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.