@jellyfin/sdk
    Preparing search index...

    Interface UniversalAudioApiHeadUniversalAudioStreamRequest

    Request parameters for headUniversalAudioStream operation in UniversalAudioApi.

    UniversalAudioApiHeadUniversalAudioStreamRequest

    interface UniversalAudioApiHeadUniversalAudioStreamRequest {
        audioBitRate?: number;
        audioCodec?: string;
        breakOnNonKeyFrames?: boolean;
        container?: string[];
        deviceId?: string;
        enableAudioVbrEncoding?: boolean;
        enableRedirection?: boolean;
        enableRemoteMedia?: boolean;
        itemId: string;
        maxAudioBitDepth?: number;
        maxAudioChannels?: number;
        maxAudioSampleRate?: number;
        maxStreamingBitrate?: number;
        mediaSourceId?: string;
        startTimeTicks?: number;
        transcodingAudioChannels?: number;
        transcodingContainer?: string;
        transcodingProtocol?: MediaStreamProtocol;
        userId?: string;
    }
    Index

    Properties

    audioBitRate?: number

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

    UniversalAudioApiHeadUniversalAudioStream

    audioCodec?: string

    Optional. The audio codec to transcode to.

    UniversalAudioApiHeadUniversalAudioStream

    breakOnNonKeyFrames?: boolean

    Optional. Whether to break on non key frames.

    UniversalAudioApiHeadUniversalAudioStream

    container?: string[]

    Optional. The audio container.

    UniversalAudioApiHeadUniversalAudioStream

    deviceId?: string

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

    UniversalAudioApiHeadUniversalAudioStream

    enableAudioVbrEncoding?: boolean

    Optional. Whether to enable Audio Encoding.

    UniversalAudioApiHeadUniversalAudioStream

    enableRedirection?: boolean

    Whether to enable redirection. Defaults to true.

    UniversalAudioApiHeadUniversalAudioStream

    enableRemoteMedia?: boolean

    Optional. Whether to enable remote media.

    UniversalAudioApiHeadUniversalAudioStream

    itemId: string

    The item id.

    UniversalAudioApiHeadUniversalAudioStream

    maxAudioBitDepth?: number

    Optional. The maximum audio bit depth.

    UniversalAudioApiHeadUniversalAudioStream

    maxAudioChannels?: number

    Optional. The maximum number of audio channels.

    UniversalAudioApiHeadUniversalAudioStream

    maxAudioSampleRate?: number

    Optional. The maximum audio sample rate.

    UniversalAudioApiHeadUniversalAudioStream

    maxStreamingBitrate?: number

    Optional. The maximum streaming bitrate.

    UniversalAudioApiHeadUniversalAudioStream

    mediaSourceId?: string

    The media version id, if playing an alternate version.

    UniversalAudioApiHeadUniversalAudioStream

    startTimeTicks?: number

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

    UniversalAudioApiHeadUniversalAudioStream

    transcodingAudioChannels?: number

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

    UniversalAudioApiHeadUniversalAudioStream

    transcodingContainer?: string

    Optional. The container to transcode to.

    UniversalAudioApiHeadUniversalAudioStream

    transcodingProtocol?: MediaStreamProtocol

    Optional. The transcoding protocol.

    UniversalAudioApiHeadUniversalAudioStream

    userId?: string

    Optional. The user id.

    UniversalAudioApiHeadUniversalAudioStream