index :: proto

proto.vlc

VLC video player control over HTTP

available since version: 0.9.5

---

information

VLC video player control

arguments:

• HOST hostname on that VLC player is running on
  type: symbol
  

methods:

• add add URI to playlist
  parameters:
  • URI resource URI (file:// or http:// or camera://)
    type: symbol
    required: True
    
• browse browse resource
  parameters:
  • URI resource URI (file:///path)
    type: symbol
    required: True
    

• clear clear playlist
  

• delete delete item from playlist
  parameters:
  • [ID] playlist entry id
    type: int
    

• fs toggle VLC fullscreen mode
  

• loop toggle loop
  

• next go to the next entry on the playlist
  

• pause pause/resume playback
  parameters:
  • [VAL] 1 or omitted: pause, 0: resume
    type: int
    

• play start playback
  

• playlist request playlist. Output as dict to second outlet
  

• prev go to the previous entry on the playlist
  

• seek seek playback position
  parameters:
  • TIME absolute time position (int value in seconds or 00h:00m:00s) or relative offset (+val, -val)
    type: atom
    required: True
    

• status request playback status. Output as dict to second outlet
  

• stop stop playback
  

• volume set playing volume
  parameters:
  • VAL absolute value in percent or relative change +VOL or -VOL
    type: atom
    required: True
    

properties:

• @host Get/set hostname on that VLC player is running on
  type: symbol
  default: localhost
  

• @port Get/set hostname on that VLC player is running on
  type: int
  range: 1..32768
  default: 8080
  

• @pass Get/set VLC http password
  type: atom
  

inlets:

• commands
  type: control

outlets:

• int: 1 on success, 0 on error
  type: control
• dict: response data
  type: control

keywords:

mpv mplayer

Authors: Serge Poltavsky

License: GPL3 or later