Class MPC

Hierarchy

MPCCore
- MPC

Constructors

constructor

new MPC(): MPC
Returns MPC
Inherited from MPCCore.constructor
- Defined in src/core/mpcCore.ts:22

Properties

`Optional`mpdVersion

mpdVersion?: [number, number, number]

The version (major, minor, patch) of the connected daemon

`Readonly`outputDevices

outputDevices: OutputDeviceCommands

`Readonly`partition

partition: PartitionCommands

`Readonly`playback

playback: PlaybackCommands

`Readonly`playbackOptions

playbackOptions: PlaybackOptionsCommands

`Readonly`reflection

reflection: ReflectionCommands

`Readonly`status

status: StatusCommands

`Readonly`stickers

stickers: StickerCommands

`Readonly`storedPlaylists

storedPlaylists: StoredPlaylistsCommands

`Static`prefixed

prefixed: string | boolean

Accessors

isReady

get isReady(): boolean
Returns boolean
Inherited from MPCCore.isReady
- Defined in src/core/protocol.ts:29

Methods

addListener

addListener<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from MPCCore.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

connectTCP

connectTCP(hostname?: string, port?: number): Promise<void>
Parameters
- hostname: string = 'localhost'
- port: number = 6600
Returns Promise<void>
- Defined in src/node/mpc.ts:6

connectUnixSocket

connectUnixSocket(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
- Defined in src/node/mpc.ts:10

disconnect

disconnect(err?: { errorCode: number; errorMessage: string }): void
Disconnect from the daemon
Parameters
- err: { errorCode: number; errorMessage: string } = ...
Returns void
Inherited from MPCCore.disconnect
- Defined in src/core/protocol.ts:107

emit

emit<T extends string | symbol>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- ...args: any[]
Returns boolean
Inherited from MPCCore.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from MPCCore.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from MPCCore.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends string | symbol>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from MPCCore.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from MPCCore.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from MPCCore.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from MPCCore.once
- Defined in node_modules/eventemitter3/index.d.ts:54

parse

parse<T>(
    lines: string[],
    markers: string[],
    convert: (valueMap: Map<string, string>) => T,
): T[]
Helper function for parsing a response from the daemon into an array of objects
Type Parameters
- T
Parameters
- lines: string[]
  The daemon response
- markers: string[]
  Markers are keys denoting the start of a new object within the response
- convert: (valueMap: Map<string, string>) => T
  Converts a key-value Map from the response into the desired target object
Returns T[]
Inherited from MPCCore.parse
- Defined in src/core/protocol.ts:143

parseGrouped

parseGrouped<T>(
lines: string[],
groupingTag: undefined | string,
): Map<string, string[]>
Type Parameters
- T
Parameters
- lines: string[]
- groupingTag: undefined | string
Returns Map<string, string[]>
Inherited from MPCCore.parseGrouped
- Defined in src/core/protocol.ts:174

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from MPCCore.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from MPCCore.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

sendCommand

sendCommand(cmd: string): Promise<MPDResponse>
Send a command to the daemon. The returned promise will be resolved with an array containing the lines of the daemon's response.
Parameters
- cmd: string
Returns Promise<MPDResponse>
Inherited from MPCCore.sendCommand
- Defined in src/core/protocol.ts:130

Class MPC

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MPC

Properties

ReadonlyclientToClient

Readonlyconnection

ReadonlycurrentPlaylist

Readonlydatabase

Readonlymounts

OptionalmpdVersion

ReadonlyoutputDevices

Readonlypartition

Readonlyplayback

ReadonlyplaybackOptions

Readonlyreflection

Readonlystatus

Readonlystickers

ReadonlystoredPlaylists

Staticprefixed

Accessors

isReady

Returns boolean

Methods

addListener

Type Parameters

Parameters

Returns this

connectTCP

Parameters

Returns Promise<void>

connectUnixSocket

Parameters

Returns Promise<void>

disconnect

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: any[]) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

parse

Type Parameters

Parameters

Returns T[]

parseGrouped

Type Parameters

Parameters

Returns Map<string, string[]>

removeAllListeners

Parameters

Returns this

removeListener

`Readonly`clientToClient

`Readonly`connection

`Readonly`currentPlaylist

`Readonly`database

`Readonly`mounts

`Optional`mpdVersion

`Readonly`outputDevices

`Readonly`partition

`Readonly`playback

`Readonly`playbackOptions

`Readonly`reflection

`Readonly`status

`Readonly`stickers

`Readonly`storedPlaylists

`Static`prefixed