Documentation:Modules/jack: Difference between revisions

From VideoLAN Wiki
Jump to navigation Jump to search
Format/copy-edit
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)}}
{{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)}}
''for {{VLC}}''
This module allows {{VLC}} to connect to [[wikipedia:JACK Audio Connection Kit|JACK]] by the [http://jackaudio.org Jack Audio Project].
<br>
 
== Introduction ==
Allows VLC to connect to [[wikipedia:JACK Audio Connection Kit|JACK]].
== Options ==
== Options ==
=== JACK audio input (access_jack) ===
=== JACK audio input (access_jack) ===
;<tt>--jack-input-caching <integer></tt>
{{Option
:''Caching value in ms''
|name=jack-input-caching
:Make VLC buffer audio data captured from JACK for the specified length in milliseconds.
|value=integer
;<tt>--jack-input-use-vlc-pace</tt>, <tt>--no-jack-input-use-vlc-pace</tt>
|description=Make VLC buffer audio data captured from JACK for the specified length in milliseconds
:''Pace (default disabled)''
}}
:Read the audio stream at VLC pace rather than JACK pace. (default disabled)
{{Option
;<tt>--jack-input-auto-connect</tt>, <tt>--no-jack-input-auto-connect</tt>
|name=jack-input-use-vlc-pace
:''Auto Connection (default disabled)''
|value=boolean
:Automatically connect VLC input ports to available output ports. (default disabled)
|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 ports to available output ports
}}


=== JACK audio output (jack) ===
=== JACK audio output (jack) ===
;<tt>--jack-auto-connect</tt>, <tt>--no-jack-auto-connect</tt>
{{Option
:''Automatically connect to writable clients (default disabled)''
|name=jack-auto-connect
:If enabled, this option will automatically connect sound output to the first writable JACK clients found. (default disabled)
|value=boolean
;<tt>--jack-connect-regex <string></tt>
|default=disabled
:''Connect to clients matching''
|description=If enabled, this option will automatically connect sound output to the first writable JACK clients found
: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-connect-regex
|value=string
|description=If automatic connection is enabled, only JACK clients whose names match this [[wikipedia:regular expression|regular expression]] will be considered for connection
}}
<!--
<!--
== See Also ==
== See Also ==
Line 37: Line 48:
</pre>
</pre>


== External Links ==
{{Documentation}}
*[[wikipedia:JACK_Audio_Connection_Kit|Jack]] at Wikipedia
*[http://jackaudio.org Jack Audio Project]

Revision as of 01:15, 18 May 2019

Module: jack
Type Audio input and output
First VLC version 0.8.5 (output)
0.9.0 (input)
Last VLC version -
Operating system(s) Unix, Linux, BSD
Description JACK Audio Connection Kit audio input and output
Shortcut(s) -

This module allows VLC media player to connect to JACK by the Jack Audio Project.

Options

JACK audio input (access_jack)

  • jack-input-caching <integer> : Make VLC buffer audio data captured from JACK for the specified length in milliseconds
  • 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

JACK audio output (jack)

  • jack-auto-connect <boolean> : If enabled, this option will automatically connect sound output to the first writable JACK clients found default value: disabled
  • jack-connect-regex <string> : If automatic connection is enabled, only JACK clients whose names match this regular expression will be considered for connection

References

vlc --version
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
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.