Metadata-Version: 2.1
Name: plover_vlc_commands
Version: 0.6.6
Summary: VLC commands for Plover
Home-page: https://github.com/benoit-pierre/plover_vlc_commands
Author: Benoit Pierre
Author-email: benoit.pierre@gmail.com
License: GNU General Public License v2 or later (GPLv2+)
Keywords: plover plover_plugin
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Plugins
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# Plover VLC commands

Add support for controlling VLC from Plover.


## Setup

* create `vlc.json` in the same directory as your configuration, set
  those settings that differ from defaults, e.g.:

    ``` json
    {
      "host": "localhost",
      "port": "8080",
      "user": "",
      "pass": "password"
    }
    ```

* start VLC with the HTTP interface enabled, e.g.:
  `vlc --extraintf http --http-password password ...`


## Available commands

* `VLC_add:<URI>`: append `<URI>` to the playlist.

* `VLC_clear`: clear the playlist.

* `VLC_play:<name>`: play the specified playlist item, or the last
   active item if not `<name>` is not specified, e.g.:
   `{PLOVER:VLC_play:click.wav}`

* `VLC_pause`, `VLC_resume`, `VLC_stop`, `VLC_toggle_pause`: self
  explanatory.

* `VLC_rate`: change the rate of playback, for example
  `{PLOVER:VLC_rate:0.5}` to halve the playback speed, or
  `{PLOVER:VLC_rate:2.0}` to double it. Percentage and relative rate
  changes are also supported: `{PLOVER:VLC_rate:-10%}`.

* `VLC_seek`: seek the video, for example `{PLOVER:VLC_seek:-10s}` to
  seek backward 10 seconds, `{PLOVER:VLC_seek:+1m}` to seek forward 1
  minute, or `{PLOVER:VLC_seek:50%}` to seek to the halfway point.


## Timestamp support

A custom meta to get the current video timestamp is also provided:
`VLC_timestamp`. For example using `{[inaudible ^}{:VLC_timestamp}{^]}`
would translate to something like: `[inaudible 00:08:01]`.


## Release history

### 0.6.6

* add support for `add`, `clear`, and `play` commands

### 0.6.5

* add timestamp support

### 0.6.4

* fix rate command documentation
* add support for percentage and relative rate changes

### 0.6.3

* improve seek command documentation
* add rate command
