Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@miqilin21/node-player

zonemeen22MIT1.0.11TypeScript support: included

A command line player for NodeJS

cli, sound, audio, play, player, music, node, window, mac, sound play, audio play, music play, sound player, audio player, music player, node audio, audio node, cli player

readme

node-player

A simple command line player for NodeJS on Windows and MacOS.

Support .mp3, .wav, .flac and other extensions.

Install

npm install @miqilin21/node-player

or

yarn add @miqilin21/node-player

Usage Examples

cjs:

const { Player } = require('@miqilin21/node-player')
const player = new Player()

esm:

import { Player } from '@miqilin21/node-player'
const player = new Player()

Relative path

cjs:

const path = require('path')
const filePath = path.join(__dirname, 'file.mp3')
player.play(filePath)

esm:

import path from 'path'
import { fileURLToPath } from 'url'
const __filename = fileURLToPath(import.meta.url)
const __dirname = path.dirname(__filename)
const filePath = path.join(__dirname, 'foo.mp3')
player.play(filePath)

Absolute path

player.play('C:\\file.mp3')

Adjusting volume

/**
 * 0   = silent
 * 0.5 = default
 * 1   = max volume
 */
const volume = 0.1
player.play('file.mp3', volume)

Kill process

player.kill()

License

Released under MIT by @zonemeen.