Documentation:Modules/osc: Difference between revisions

From VideoLAN Wiki
Jump to navigation Jump to search
← Older editNewer edit →
Nhumfrey (talk | contribs)
29 edits
m Changed type from Control to Interface
Nhumfrey (talk | contribs)
29 edits
Added example
Line 5: Line 5:
The following commands are currently supported:
The following commands are currently supported:
<pre>
<pre>
  &rarr; /deck/play          - Start deck playing
  &rarr; /deck/play          - Start playback
  &rarr; /deck/pause        - Pause deck
  &rarr; /deck/pause        - Pause playback
  &rarr; /deck/stop          - Stop Deck playback
  &rarr; /deck/stop          - Stop playback
  &rarr; /deck/eject        - Eject the current track from deck
  &rarr; /deck/eject        - Eject (stops and clears the playlist)
  &rarr; /deck/load (s)      - Load &lt;mrl&gt; into deck
  &rarr; /deck/load (s)      - Load &lt;mrl&gt; (stops and clears the playlist first)
&rarr; /deck/volume (i)   - Load &lt;filename&gt; into deck
</pre>
</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.
NOTE: These paths are designed to be compatible with [http://www.aelius.com/njh/madjack/ MadJACK] but are subject to change.




Line 24: Line 22:
|description=Port number to listen on
|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 0.9.8a Grishenko
[00000001] main libvlc debug: VLC media player - version 0.9.8a Grishenko - (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://vmware.aelius.co.uk: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>

Revision as of 20:48, 13 December 2008

Module: osc
Type Interface
First VLC version -
Last VLC version -
Operating system(s) Any that support the liblo library
Description control VLC using the Open Sound Control protocol
Shortcut(s) -

This module lets you send control messages to VLC using the Open Sound Control protocol.

The following commands are currently supported: 

 → /deck/play          - Start playback
 → /deck/pause         - Pause playback
 → /deck/stop          - Stop playback
 → /deck/eject         - Eject (stops and clears the playlist)
 → /deck/load (s)      - Load <mrl> (stops and clears the playlist first)

NOTE: These paths are designed to be compatible with MadJACK and are subject to change. They treat VLC as a single track player and playlist functionality isn't currently supported.


Options

  • osc-port <integer> : Port number to listen on default value: randomly allocated port number


Example

Start VLC with the OSC control interface loaded: 

$ vlc -I dummy --control osc --osc-port 4444 
VLC media player 0.9.8a Grishenko
[00000001] main libvlc debug: VLC media player - version 0.9.8a Grishenko - (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://vmware.aelius.co.uk:4444/
[00000293] dummy interface: using the dummy interface module...

Load a track: 

$ oscsend 127.0.0.1 4444 /deck/load 's' /Users/njh/Music/003820.mp3

Start the track playing: 

$ oscsend 127.0.0.1 4444 /deck/play

Stop the track playing: 

$ oscsend 127.0.0.1 4444 /deck/stop
Retrieved from "https://wiki.videolan.org/index.php?title=Documentation:Modules/osc&oldid=12850"