Class MPC

Hierarchy

MPC
- MPC

Constructors

constructor

new MPC(): MPC
Returns MPC
Inherited from MPCBase.constructor
- Defined in src/mpcCore.ts:32

Properties

`Readonly`clientToClient

clientToClient: ClientToClientCommands

`Readonly`connection

connection: ConnectionCommands

`Readonly`currentPlaylist

currentPlaylist: CurrentPlaylistCommands

`Readonly`database

database: DatabaseCommands

`Readonly`mounts

mounts: MountCommands

`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 MPCBase.isReady
- Defined in src/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 MPCBase.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/mpc-node.ts:9

connectUnixSocket

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

connectWebSocket

connectWebSocket(url: string): Promise<void>
Parameters
- url: string
Returns Promise<void>
Inherited from MPCBase.connectWebSocket
- Defined in src/mpc.ts:8

disconnect

disconnect(err?: { errorCode: number; errorMessage: string }): void
Disconnect from the daemon
Parameters
- err: { errorCode: number; errorMessage: string } = ...
Returns void
Inherited from MPCBase.disconnect
- Defined in src/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 MPCBase.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 MPCBase.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 MPCBase.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 MPCBase.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 MPCBase.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 MPCBase.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 MPCBase.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from MPCBase.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 MPCBase.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 MPCBase.sendCommand
- Defined in src/protocol.ts:130