Skip to content
vlc-client allows to control VLC media player over TCP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Bump version Jan 23, 2017
.gitignore .gitignore entry for backup files Jan 19, 2014
.rspec Development infrastructure Oct 7, 2012
.travis.yml Restore some sanity to the development dependencies Jan 24, 2017
.yardopts Development infrastructure Oct 7, 2012
Gemfile Restore some sanity to the development dependencies Jan 24, 2017
LICENSE Add showcase for playlist support Jul 12, 2015
vlc-client.gemspec Remove blank line Aug 22, 2015

vlc-client Build Status

vlc-client manages a VLC media player instance through it's RC interface.


Add this line to your application's Gemfile:

gem 'vlc-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vlc-client


Create a client and connect to a running VLC media player instance.
vlc ='', 9999) #Expects a VLC media player running on ``, e.g. `vlc --extraintf rc --rc-host`

vlc.connect # connect to server
# => true'') # play media
# => true

# => true

# => true
Create a self managed client/server system.

Most of the time we want a local client/server VLC media player system

vlc = # A client/server system over a local managed VLC instance

vlc.connected? # auto connect
# => true'')
# => true

# => 1 #%

# Technically this is the same as
vlc ='localhost', 9595, false))

Playlist management

vlc =


#=> [{:number=>1, :title=>"Track #1 title", :length=>"00:03:10", :times_played=>1}, {:number=>2, :title=>"Track #2 title", :length=>"00:03:30", :times_played=>0}]




vlc-client has been tested on linux but it should work on any VLC installation as long as the command line is responsive for vlc and cvlc calls. On Mac OS X these are not available by default. They can be created with:

echo "alias vlc='/Applications/'" >> ~/.bash_profile
echo "alias cvlc='/Applications/'" >> ~/.bash_profile


  1. Fork it
  2. Create your topic branch (git checkout -b my-topic-branch)
  3. Add/change specs for your unimplemented feature or bug fix
  4. Hack it
  5. Make sure specs pass (bundle exec rake spec)
  6. Edit the documentation so it is coherent with your feature or fix. Run bundle exec rake yard to review
  7. Commit changes (git commit -am 'Add some feature/fix') and push to the branch (git push origin my-topic-branch)
  8. Submit a pull request


Copyright (c) 2012 Miguel Guinada LICENSE for details.

You can’t perform that action at this time.