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

    Type Alias HeadUniversalAudioStreamData

    type HeadUniversalAudioStreamData = {
        body?: never;
        path: { itemId: string };
        query?: {
            container?: string[];
            mediaSourceId?: string;
            deviceId?: string;
            userId?: string;
            audioCodec?: string;
            maxAudioChannels?: number;
            transcodingAudioChannels?: number;
            maxStreamingBitrate?: number;
            audioBitRate?: number;
            startTimeTicks?: number;
            transcodingContainer?: string;
            transcodingProtocol?: "http" | "hls";
            maxAudioSampleRate?: number;
            maxAudioBitDepth?: number;
            enableRemoteMedia?: boolean;
            enableAudioVbrEncoding?: boolean;
            enableRedirection?: boolean;
        };
        url: "/Audio/{itemId}/universal";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: { itemId: string }

    Type Declaration

    • itemId: string

      The item id.

    query?: {
        container?: string[];
        mediaSourceId?: string;
        deviceId?: string;
        userId?: string;
        audioCodec?: string;
        maxAudioChannels?: number;
        transcodingAudioChannels?: number;
        maxStreamingBitrate?: number;
        audioBitRate?: number;
        startTimeTicks?: number;
        transcodingContainer?: string;
        transcodingProtocol?: "http" | "hls";
        maxAudioSampleRate?: number;
        maxAudioBitDepth?: number;
        enableRemoteMedia?: boolean;
        enableAudioVbrEncoding?: boolean;
        enableRedirection?: boolean;
    }

    Type Declaration

    • Optionalcontainer?: string[]

      Optional. The audio container.

    • OptionalmediaSourceId?: string

      The media version id, if playing an alternate version.

    • OptionaldeviceId?: string

      The device id of the client requesting. Used to stop encoding processes when needed.

    • OptionaluserId?: string

      Optional. The user id.

    • OptionalaudioCodec?: string

      Optional. The audio codec to transcode to.

    • OptionalmaxAudioChannels?: number

      Optional. The maximum number of audio channels.

    • OptionaltranscodingAudioChannels?: number

      Optional. The number of how many audio channels to transcode to.

    • OptionalmaxStreamingBitrate?: number

      Optional. The maximum streaming bitrate.

    • OptionalaudioBitRate?: number

      Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.

    • OptionalstartTimeTicks?: number

      Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.

    • OptionaltranscodingContainer?: string

      Optional. The container to transcode to.

    • OptionaltranscodingProtocol?: "http" | "hls"

      Optional. The transcoding protocol.

    • OptionalmaxAudioSampleRate?: number

      Optional. The maximum audio sample rate.

    • OptionalmaxAudioBitDepth?: number

      Optional. The maximum audio bit depth.

    • OptionalenableRemoteMedia?: boolean

      Optional. Whether to enable remote media.

    • OptionalenableAudioVbrEncoding?: boolean

      Optional. Whether to enable Audio Encoding.

    • OptionalenableRedirection?: boolean

      Whether to enable redirection. Defaults to true.

    url: "/Audio/{itemId}/universal"

    Settings
    Member Visibility

    On This Page
    Properties