Difference between revisions of "Documentation:Modules/osc"

From VideoLAN Wiki
Jump to navigation Jump to search
(Added patch for 0.9.9a)
 
Line 1: Line 1:
'''NOTE: this module is currently in development and has not made it into the main tree yet.'''
+
'''NOTE: this module is was never merged into the main VLC codebase and work on it has stopped'''
 +
 
 
* Patch against VLC 0.9.9a: http://www.aelius.com/njh/tmp/vlc-0.9.9a+osc.patch
 
* Patch against VLC 0.9.9a: http://www.aelius.com/njh/tmp/vlc-0.9.9a+osc.patch
 
* Patch against VLC 0.9.8a: http://www.aelius.com/njh/tmp/vlc-0.9.8a+osc.patch
 
* Patch against VLC 0.9.8a: http://www.aelius.com/njh/tmp/vlc-0.9.8a+osc.patch
 
* Patch against GIT master: http://www.aelius.com/njh/tmp/vlc-git+liblo.patch
 
* Patch against GIT master: http://www.aelius.com/njh/tmp/vlc-git+liblo.patch
 
 
{{Module|name=osc|type=Interface|os=Any that support the [http://liblo.sf.net/ liblo] library|description=control VLC using the Open Sound Control protocol}}
 
 
This module lets you send control messages to VLC using the [http://www.opensoundcontrol.org/ Open Sound Control] protocol.
 
 
The following methods are currently supported:
 
<pre>
 
&rarr; /deck/play          - Start playback
 
&rarr; /deck/pause        - Pause playback
 
&rarr; /deck/stop          - Stop playback
 
&rarr; /deck/eject        - Eject (stops and clears the playlist)
 
&rarr; /deck/load (s)      - Load &lt;mrl&gt;
 
</pre>
 
 
NOTE: These paths are designed to be compatible with [http://www.aelius.com/njh/madjack/ MadJACK] and are subject to change. They treat VLC as a single track player and playlist functionality isn't currently supported.
 
 
 
== Options ==
 
{{Option
 
|name=osc-port
 
|value=integer
 
|default=randomly allocated port number
 
|description=Port number to listen on
 
}}
 
 
 
== Example ==
 
 
Start VLC with the OSC control interface loaded:
 
<pre>$ vlc -I dummy --control osc --osc-port 4444
 
VLC media player 1.0.0-git Goldeneye
 
[00000001] main libvlc debug: VLC media player - version 1.0.0-git Goldeneye - (c) 1996-2008 the VideoLAN team
 
[00000001] main libvlc debug: translation test: code is "C"
 
[00000287] osc interface: Listening for OSC messages on: osc.udp://127.0.0.1:4444/
 
[00000293] dummy interface: using the dummy interface module...
 
</pre>
 
 
Load a track:
 
<pre>$ oscsend 127.0.0.1 4444 /deck/load 's' /Users/njh/Music/003820.mp3</pre>
 
 
Start the track playing:
 
<pre>$ oscsend 127.0.0.1 4444 /deck/play</pre>
 
 
Stop the track playing:
 
<pre>$ oscsend 127.0.0.1 4444 /deck/stop</pre>
 
 
 
[[Category:Interfaces]]
 

Latest revision as of 09:37, 12 April 2014

NOTE: this module is was never merged into the main VLC codebase and work on it has stopped