Class ConnectionCommands

Hierarchy

ConnectionCommands

Index

Constructors

constructor

Properties

protocol

Methods

Constructors

constructor

new ConnectionCommands(protocol: MPDProtocol): ConnectionCommands

- Defined in src/commands/connection.ts:3
Parameters
- protocol: MPDProtocol
Returns ConnectionCommands

Properties

Private protocol

protocol: MPDProtocol

Methods

allTagTypes

allTagTypes(): Promise<void>

- Defined in src/commands/connection.ts:81
Announce that this client is interested in all tag types. This is the default setting for new clients.

Returns Promise<void>

clearTagTypes

clearTagTypes(): Promise<void>

- Defined in src/commands/connection.ts:73
Clear the list of tag types this client is interested in. This means that MPD will not send any tags to this client.

Returns Promise<void>

close

close(): void

- Defined in src/commands/connection.ts:12
Closes the connection to MPD. MPD will try to send the remaining output buffer before it actually closes the connection, but that cannot be guaranteed. This command will not generate a response.

Returns void

disableTagTypes

disableTagTypes(names: string[]): Promise<void>

- Defined in src/commands/connection.ts:53
Remove one or more tags from the list of tag types the client is interested in. These will be omitted from responses to this client.

Parameters
- names: string[]
Returns Promise<void>

enableTagTypes

enableTagTypes(names: string[]): Promise<void>

- Defined in src/commands/connection.ts:63
Re-enable one or more tags from the list of tag types for this client. These will no longer be hidden from responses to this client.

Parameters
- names: string[]
Returns Promise<void>

kill

kill(): void

- Defined in src/commands/connection.ts:19
Kills MPD.

Returns void

password

password(password: string): Promise<void>

- Defined in src/commands/connection.ts:26
This is used for authentication with the server. password is simply the plaintext password.

Parameters
- password: string
Returns Promise<void>

ping

ping(): Promise<void>

- Defined in src/commands/connection.ts:34
Does nothing but return "OK".

Returns Promise<void>

tagTypes

tagTypes(): Promise<string[]>

- Defined in src/commands/connection.ts:45
Shows a list of available tag types. It is an intersection of the metadata_to_use setting and this client's tag mask. About the tag mask: each client can decide to disable any number of tag types, which will be omitted from responses to this client. That is a good idea, because it makes responses smaller.

Returns Promise<string[]>

Generated using TypeDoc