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

    Type Alias OpenLiveStreamData

    type OpenLiveStreamData = {
        body?: OpenLiveStreamDto;
        path?: never;
        query?: {
            openToken?: string;
            userId?: string;
            playSessionId?: string;
            maxStreamingBitrate?: number;
            startTimeTicks?: number;
            audioStreamIndex?: number;
            subtitleStreamIndex?: number;
            maxAudioChannels?: number;
            itemId?: string;
            enableDirectPlay?: boolean;
            enableDirectStream?: boolean;
            alwaysBurnInSubtitleWhenTranscoding?: boolean;
        };
        url: "/LiveStreams/Open";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: OpenLiveStreamDto

    Open live stream dto.

    path?: never
    query?: {
        openToken?: string;
        userId?: string;
        playSessionId?: string;
        maxStreamingBitrate?: number;
        startTimeTicks?: number;
        audioStreamIndex?: number;
        subtitleStreamIndex?: number;
        maxAudioChannels?: number;
        itemId?: string;
        enableDirectPlay?: boolean;
        enableDirectStream?: boolean;
        alwaysBurnInSubtitleWhenTranscoding?: boolean;
    }

    Type Declaration

    • OptionalopenToken?: string

      The open token.

    • OptionaluserId?: string

      The user id.

    • OptionalplaySessionId?: string

      The play session id.

    • OptionalmaxStreamingBitrate?: number

      The maximum streaming bitrate.

    • OptionalstartTimeTicks?: number

      The start time in ticks.

    • OptionalaudioStreamIndex?: number

      The audio stream index.

    • OptionalsubtitleStreamIndex?: number

      The subtitle stream index.

    • OptionalmaxAudioChannels?: number

      The maximum number of audio channels.

    • OptionalitemId?: string

      The item id.

    • OptionalenableDirectPlay?: boolean

      Whether to enable direct play. Default: true.

    • OptionalenableDirectStream?: boolean

      Whether to enable direct stream. Default: true.

    • OptionalalwaysBurnInSubtitleWhenTranscoding?: boolean

      Always burn-in subtitle when transcoding.

    url: "/LiveStreams/Open"

    Settings
    Member Visibility

    On This Page
    Properties