pedromsilvapt / unicast-mpv

A simple module that exposes MPV to be controlled through a RPC WebSockets API, that can be used with the unicast server

unicast-mpv

A simple module that exposes MPV to be controlled through a RPC WebSockets API, that can be used with the unicast server

Installation

This module can be used as a terminal application by simply installing it globally:

npm install -g unicast-mpv

Usage

Simply execute the application. The path to an YAML config file can optionally be passed as an argument. By default, the server listens on the port 2019.

# With only default configuration
unicast-mpv
# Or with custom configuration
unicast-mpv path/to/configuration.yaml

Configuration

Below is the default configuration.

player:
    # Launch the player window in full screen
    fullscreen: true

    # Index of the monitor (0-32) where to open the player window
    monitor: null

    # Force the player window to always be on top
    onTop: false

    # If false, when stopping a video, the player window is kept open. If true, it is automatically closed
    quitOnStop: true

    # Determines if the player restarts everytime the user plays a new media when something was already playing
    restartOnPlay: false

server:
    # The network port where the socket server will listen for incoming connections
    port: 2019

    # The network interface the server will bind to
    address: 0.0.0.0

    # Specify a password to authenticate clients. Null means no password
    authenticate: null

    # MPV provides a command that allows to run arbitrary system commands. In unprotected environments, 
    # this can present a security risk. Setting this value to true disables the command from socket requests
    disableRunCommand: false

On Windows, the following configuration file is also loaded. If the MPV binary is in a different folder, then it should be changed to reflect that.

player:
    binary: C:\Program Files\mpv\mpv.exe