Platform

Spicetify.Platform

interface ClipboardAPI {
    copy: (text: string) => Promise<void>;
    paste: () => Promise<string | undefined>;
};

// Will be copied as "Hello World!"
await Spicetify.Platform.ClipboardAPI.copy("Hello World!");

// Will be stringified to '{"0":0,"1":0,"2":0,"3":0}'
await Spicetify.Platform.ClipboardAPI.copy(new Uint16Array(4));

await Spicetify.Platform.ClipboardAPI.copy("Hello World!");
await Spicetify.Platform.ClipboardAPI.paste(); // "Hello World!"

await Spicetify.Platform.ClipboardAPI.copy(new Uint16Array(4));
await Spicetify.Platform.ClipboardAPI.paste(); // '{"0":0,"1":0,"2":0,"3":0}'

interface History {
    push: (path: Location | string) => void;
    replace: (path: Location | string) => void;
    goBack: () => void;
    goForward: () => void;
    listen: (listener: (location: Location) => void) => () => void;
    entries: Location[];
    location: Location;
};

interface Location {
    pathname: string;
    search: string;
    hash: string;
    state: Record<string, any>;
};

Spicetify.Platform.History.push("/app/your-app");

Spicetify.Platform.History.push({
    pathname: "/app/your-app",
    search: "?foo=bar",
    hash: "#baz",
    state: { foo: "bar" },
});

// Replace the current location with a new one.
Spicetify.Platform.History.replace("/app/your-app");

Spicetify.Platform.History.replace({
    pathname: "/app/your-app",
    search: "?foo=bar",
    hash: "#baz",
    state: { foo: "bar" },
});

Spicetify.Platform.History.listen((location) => {
    // Log the current pathname every time the user navigates to a new page.
    console.log(location.pathname);
});

`${namespace}:${key}`

interface LocalStorageAPI {
    items: Record<string, any>;
    namespace: string;
    getItem: (key: string) => any;
    setItem: (key: string, value: any) => void;
    clearItem: (key: string) => void;
};

Spicetify.Platform.LocalStorageAPI.items; // { "username:foo": "bar" }

// This is equivalent to Spicetify.Platform.LocalStorageAPI.items["username:foo"]
// or localStorage.getItem("username:foo")
Spicetify.Platform.LocalStorageAPI.getItem("foo"); // "bar"

Spicetify.Platform.LocalStorageAPI.setItem("foo", { bar: "baz" });
// localStorage.getItem("username:foo") === '{"bar":"baz"}'

Spicetify.Platform.LocalStorageAPI.clearItem("foo");
// localStorage.getItem("username:foo") === null

interface PlatformData {
    app_platform: string;
    client_capabilities: Record<string, any>;
    client_version_triple: string;
    client_version_quadruple: string;
    client_version_quintuple: string;
    event_sender_context_information: Record<string, any>;
    os_name: string;
    os_version: string;
}

Spicetify.Platform.PlatformData.app_platform; // "win32"

Spicetify.Platform.PlatformData.event_sender_context_information; // { "platform_type:"windows", "os_version": "10.0.19042" }

Spicetify.Platform.PlatformData.os_name; // "windows"

Spicetify.Platform.PlatformData.os_version; // "10.0.19042"

interface Session {
    accessToken: string;
    accessTokenExpirationTimestampMs: number;
    locale: string;
}

Spicetify.Platform.Session.locale; // "en"

interface Translations {
    [key: string]: string;
}

interface PlayerAPI {
    addToQueue: (items: ContextTrack[]) => Promise<void>;
    clearQueue: () => Promise<void>;
    pause: () => Promise<void>;
    play: (uri: ContextTrack, context, options = {}) => Promise<void>;
    removeFromQueue: (items: ContextTrack[]) => Promise<void>;
    resume: () => Promise<void>;
    seekBackward: (ms: number) => Promise<void>;
    seekBy: (ms: number) => Promise<void>;
    seekForward: (ms: number) => Promise<void>;
    seekTo: (ms: number) => Promise<void>;
    setRepeat: (mode: RepeatMode) => Promise<void>;
    setShuffle: (shuffle: boolean) => Promise<void>;
    setSpeed: (speed: number) => Promise<void>;
}

enum RepeatMode {
    Off = 0,
    RepeatAll = 1,
    RepeatOne = 2,
}

await Spicetify.Platform.PlayerAPI.addToQueue(items);

// Add a track to the queue

// 505 - Arctic Monkeys
const track = { uri: "spotify:track:0BxE4FqsDD1Ot4YuBXwAPp" };

await Spicetify.Platform.PlayerAPI.addToQueue([track]);

await Spicetify.Platform.PlayerAPI.clearQueue();

await Spicetify.Platform.PlayerAPI.pause();

await Spicetify.Platform.PlayerAPI.play(uri, context, options);

// 505 - Arctic Monkeys
const track = { uri: "spotify:track:0BxE4FqsDD1Ot4YuBXwAPp" };

// Play the track
// Spicetify.Player.playUri(track.uri);
await Spicetify.Platform.PlayerAPI.play(track, {}, {});

await Spicetify.Platform.PlayerAPI.removeFromQueue(items);

// Remove a track from the queue

// 505 - Arctic Monkeys
const track = { uri: "spotify:track:0BxE4FqsDD1Ot4YuBXwAPp" };

// Remove the track if it's in the queue
await Spicetify.Platform.PlayerAPI.removeFromQueue([track]);

await Spicetify.Platform.PlayerAPI.resume();

await Spicetify.Platform.PlayerAPI.seekBackward(ms);

// Seek backward 10 seconds
await Spicetify.Platform.PlayerAPI.seekBackward(10000);

await Spicetify.Platform.PlayerAPI.seekBy(ms);

// Seek forward 10 seconds
await Spicetify.Platform.PlayerAPI.seekBy(10000);

// Seek backward 10 seconds
await Spicetify.Platform.PlayerAPI.seekBy(-10000);

await Spicetify.Platform.PlayerAPI.seekForward(ms);

// Seek forward 10 seconds
await Spicetify.Platform.PlayerAPI.seekForward(10000);

await Spicetify.Platform.PlayerAPI.seekTo(ms);

// Seek to 1 minute
await Spicetify.Platform.PlayerAPI.seekTo(60000);

await Spicetify.Platform.PlayerAPI.setRepeat(mode);

// Set repeat mode to repeat one
await Spicetify.Platform.PlayerAPI.setRepeat(2);

await Spicetify.Platform.PlayerAPI.setShuffle(shuffle);

// Enable shuffle mode
await Spicetify.Platform.PlayerAPI.setShuffle(true);

await Spicetify.Platform.PlayerAPI.setSpeed(speed);

// Set playback speed to 1.5x
await Spicetify.Platform.PlayerAPI.setSpeed(1.5);