Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias PlayData

    type PlayData = {
        body?: never;
        path: { sessionId: string };
        query: {
            playCommand:
                | "PlayNow"
                | "PlayNext"
                | "PlayLast"
                | "PlayInstantMix"
                | "PlayShuffle";
            itemIds: string[];
            startPositionTicks?: number;
            mediaSourceId?: string;
            audioStreamIndex?: number;
            subtitleStreamIndex?: number;
            startIndex?: number;
        };
        url: "/Sessions/{sessionId}/Playing";
    }
    Index
    body? path query url

    Optionalbody

    body?: never
    path: { sessionId: string }

    Type Declaration

    • sessionId: string

      The session id.

    query: {
        playCommand:
            | "PlayNow"
            | "PlayNext"
            | "PlayLast"
            | "PlayInstantMix"
            | "PlayShuffle";
        itemIds: string[];
        startPositionTicks?: number;
        mediaSourceId?: string;
        audioStreamIndex?: number;
        subtitleStreamIndex?: number;
        startIndex?: number;
    }

    Type Declaration

    • playCommand: "PlayNow" | "PlayNext" | "PlayLast" | "PlayInstantMix" | "PlayShuffle"

      Enum PlayCommand.

    • itemIds: string[]

      The ids of the items to play, comma delimited.

    • OptionalstartPositionTicks?: number

      The starting position of the first item.

    • OptionalmediaSourceId?: string

      Optional. The media source id.

    • OptionalaudioStreamIndex?: number

      Optional. The index of the audio stream to play.

    • OptionalsubtitleStreamIndex?: number

      Optional. The index of the subtitle stream to play.

    • OptionalstartIndex?: number

      Optional. The start index.

    url: "/Sessions/{sessionId}/Playing"

    Settings
    Member Visibility

    On This Page
    Properties