Documentation:Modules/osc

From VideoLAN Wiki

Jump to: navigation, search

NOTE: this module is currently in development and has not made it into the main tree yet.


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

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

The following methods 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>

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

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