sndplay/README.md

   1 # nihav-sndplay
   2
   3 nihav-sndplay is a minimalistic audio player based on NihAV and SDL2.
   4
   5 ## Getting Started
   6
   7 In order to build it, put it into some subdirectory with other NihAV crates (or edit `Cargo.toml` to point to the proper crate locations) and invoke `cargo build`.
   8
   9 Usage: `nihav-sndplay file1 file2 ...`.
  10
  11 Recognized keyboard commands:
  12 * `escape` / `q`    - quit
  13 * `space`           - pause / resume playback
  14 * `enter` / `end`   - play next file
  15 * `home`            - play current track from the beginning
  16 * `left` / `right`  - seek 10 seconds forward / back
  17 * `up` / `down`     - seek 1 minute forward / back
  18 * `pgup` / `pgdn`   - seek 10 minutes forward / back
  19 * `+` / `-`         - increase / decrease volume
  20 * `m`               - mute output
  21
  22 ## Contributing
  23
  24 You're not supposed to. Even I hardly do that so why should you?
  25
  26 ## License
  27
  28 NihAV is licensed under GNU Affero Public License - see [COPYING] for details.
  29
  30 Parts of the project can be relicensed to other free licenses like LGPLv2 on request.