mpc-js
    Preparing search index...

    Interface PlaybackOptionsCommands

    interface PlaybackOptionsCommands {
        changeVolume(change: number): Promise<void>;
        getReplayGainMode(): Promise<"off" | "track" | "album" | "auto">;
        getVolume(): Promise<undefined | number>;
        setConsume(consume: boolean): Promise<void>;
        setCrossfade(seconds: number): Promise<void>;
        setMixrampdb(decibels: number): Promise<void>;
        setMixrampDelay(seconds: number): Promise<void>;
        setRandom(random: boolean): Promise<void>;
        setRepeat(repeat: boolean): Promise<void>;
        setReplayGainMode(mode: "off" | "track" | "album" | "auto"): Promise<void>;
        setSingle(single: boolean | "oneshot"): Promise<void>;
        setVolume(volume: number): Promise<void>;
    }

    Hierarchy

    • ReturnType<typeof createPlaybackOptionsCommands>
      • PlaybackOptionsCommands
    Index

    Methods

    changeVolume getReplayGainMode getVolume setConsume setCrossfade setMixrampdb setMixrampDelay setRandom setRepeat setReplayGainMode setSingle setVolume

    Methods

    • Changes volume by the given amount.

      Parameters

      • change: number

      Returns Promise<void>

    • Returns Promise<"off" | "track" | "album" | "auto">

    • Read the volume. The result is in the range 0-100. Returns undefined if there is no mixer.

      Returns Promise<undefined | number>

    • Sets consume state. When consume is activated, each song played is removed from playlist.

      Parameters

      • consume: boolean

      Returns Promise<void>

    • Sets crossfading between songs

      Parameters

      • seconds: number

      Returns Promise<void>

    • Sets the threshold at which songs will be overlapped. Like crossfading but doesn't fade the track volume, just overlaps. The songs need to have MixRamp tags added by an external tool. 0dB is the normalized maximum volume so use negative values, I prefer -17dB. In the absence of mixramp tags * crossfading will be used. See [http://sourceforge.net/projects/mixramp]

      Parameters

      • decibels: number

      Returns Promise<void>

    • Additional time subtracted from the overlap calculated by mixrampdb. A value of null disables MixRamp overlapping and falls back to crossfading.

      Parameters

      • seconds: number

      Returns Promise<void>

    • Sets repeat state. If enabled, MPD keeps repeating the whole queue (single mode disabled) or the current song (single mode enabled). If random mode is also enabled, the playback order will be shuffled each time the queue gets repeated.

      Parameters

      • repeat: boolean

      Returns Promise<void>

    • Sets the replay gain mode. One of off, track, album, auto. Changing the mode during playback may take several seconds, because the new settings does not affect the buffered data. This command triggers the options idle event.

      Parameters

      • mode: "off" | "track" | "album" | "auto"

      Returns Promise<void>

    • Sets single state. When single is activated, playback is stopped after current song, or song is repeated if the 'repeat' mode is enabled.

      Parameters

      • single: boolean | "oneshot"

      Returns Promise<void>

    • Sets volume, the range of volume is 0-100.

      Parameters

      • volume: number

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods