@richienb/vlc

An interface to VLC Media Player.

Usage no npm install needed!

<script type="module">
  import richienbVlc from 'https://cdn.skypack.dev/@richienb/vlc';
</script>

README

VLC Travis CI Build Status

An interface to VLC Media Player.

NPM Badge

Highlights

  • Automatic command encoding and delivery.
  • Automatic port acquisition.
  • TypeScript support.
  • Bundled binaries.
  • No native dependencies.
  • Actively maintained.

Install

npm install @richienb/vlc

Usage

const vlc = require("@richienb/vlc");

(async () => {
    const vlc = await vlc()

    // Play audio
    await vlc.command("in_play", {
        input: "audioFile.mp3"
    })

    // Pause/resume audio
    await vlc.command("pl_pause")
})()

API

See the documentation: https://richienb.github.io/vlc