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

    Type Alias SendSystemCommandData

    type SendSystemCommandData = {
        body?: never;
        path: {
            sessionId: string;
            command:
                | "MoveUp"
                | "MoveDown"
                | "MoveLeft"
                | "MoveRight"
                | "PageUp"
                | "PageDown"
                | "PreviousLetter"
                | "NextLetter"
                | "ToggleOsd"
                | "ToggleContextMenu"
                | "Select"
                | "Back"
                | "TakeScreenshot"
                | "SendKey"
                | "SendString"
                | "GoHome"
                | "GoToSettings"
                | "VolumeUp"
                | "VolumeDown"
                | "Mute"
                | "Unmute"
                | "ToggleMute"
                | "SetVolume"
                | "SetAudioStreamIndex"
                | "SetSubtitleStreamIndex"
                | "ToggleFullscreen"
                | "DisplayContent"
                | "GoToSearch"
                | "DisplayMessage"
                | "SetRepeatMode"
                | "ChannelUp"
                | "ChannelDown"
                | "Guide"
                | "ToggleStats"
                | "PlayMediaSource"
                | "PlayTrailers"
                | "SetShuffleQueue"
                | "PlayState"
                | "PlayNext"
                | "ToggleOsdMenu"
                | "Play"
                | "SetMaxStreamingBitrate"
                | "SetPlaybackOrder";
        };
        query?: never;
        url: "/Sessions/{sessionId}/System/{command}";
    }
    Index
    body?: never
    path: {
        sessionId: string;
        command:
            | "MoveUp"
            | "MoveDown"
            | "MoveLeft"
            | "MoveRight"
            | "PageUp"
            | "PageDown"
            | "PreviousLetter"
            | "NextLetter"
            | "ToggleOsd"
            | "ToggleContextMenu"
            | "Select"
            | "Back"
            | "TakeScreenshot"
            | "SendKey"
            | "SendString"
            | "GoHome"
            | "GoToSettings"
            | "VolumeUp"
            | "VolumeDown"
            | "Mute"
            | "Unmute"
            | "ToggleMute"
            | "SetVolume"
            | "SetAudioStreamIndex"
            | "SetSubtitleStreamIndex"
            | "ToggleFullscreen"
            | "DisplayContent"
            | "GoToSearch"
            | "DisplayMessage"
            | "SetRepeatMode"
            | "ChannelUp"
            | "ChannelDown"
            | "Guide"
            | "ToggleStats"
            | "PlayMediaSource"
            | "PlayTrailers"
            | "SetShuffleQueue"
            | "PlayState"
            | "PlayNext"
            | "ToggleOsdMenu"
            | "Play"
            | "SetMaxStreamingBitrate"
            | "SetPlaybackOrder";
    }

    Type Declaration

    • sessionId: string

      The session id.

    • command:
          | "MoveUp"
          | "MoveDown"
          | "MoveLeft"
          | "MoveRight"
          | "PageUp"
          | "PageDown"
          | "PreviousLetter"
          | "NextLetter"
          | "ToggleOsd"
          | "ToggleContextMenu"
          | "Select"
          | "Back"
          | "TakeScreenshot"
          | "SendKey"
          | "SendString"
          | "GoHome"
          | "GoToSettings"
          | "VolumeUp"
          | "VolumeDown"
          | "Mute"
          | "Unmute"
          | "ToggleMute"
          | "SetVolume"
          | "SetAudioStreamIndex"
          | "SetSubtitleStreamIndex"
          | "ToggleFullscreen"
          | "DisplayContent"
          | "GoToSearch"
          | "DisplayMessage"
          | "SetRepeatMode"
          | "ChannelUp"
          | "ChannelDown"
          | "Guide"
          | "ToggleStats"
          | "PlayMediaSource"
          | "PlayTrailers"
          | "SetShuffleQueue"
          | "PlayState"
          | "PlayNext"
          | "ToggleOsdMenu"
          | "Play"
          | "SetMaxStreamingBitrate"
          | "SetPlaybackOrder"

      This exists simply to identify a set of known commands.

    query?: never
    url: "/Sessions/{sessionId}/System/{command}"