@jellyfin/sdk
    Preparing search index...

    Interface AudioApiHeadAudioStreamRequest

    Request parameters for headAudioStream operation in AudioApi.

    AudioApiHeadAudioStreamRequest

    interface AudioApiHeadAudioStreamRequest {
        _static?: boolean;
        allowAudioStreamCopy?: boolean;
        allowVideoStreamCopy?: boolean;
        audioBitRate?: number;
        audioChannels?: number;
        audioCodec?: string;
        audioSampleRate?: number;
        audioStreamIndex?: number;
        breakOnNonKeyFrames?: boolean;
        container?: string;
        context?: EncodingContext;
        copyTimestamps?: boolean;
        cpuCoreLimit?: number;
        deInterlace?: boolean;
        deviceId?: string;
        deviceProfileId?: string;
        enableAudioVbrEncoding?: boolean;
        enableAutoStreamCopy?: boolean;
        enableMpegtsM2TsMode?: boolean;
        framerate?: number;
        height?: number;
        itemId: string;
        level?: string;
        liveStreamId?: string;
        maxAudioBitDepth?: number;
        maxAudioChannels?: number;
        maxFramerate?: number;
        maxRefFrames?: number;
        maxVideoBitDepth?: number;
        mediaSourceId?: string;
        minSegments?: number;
        params?: string;
        playSessionId?: string;
        profile?: string;
        requireAvc?: boolean;
        requireNonAnamorphic?: boolean;
        segmentContainer?: string;
        segmentLength?: number;
        startTimeTicks?: number;
        streamOptions?: { [key: string]: string };
        subtitleCodec?: string;
        subtitleMethod?: SubtitleDeliveryMethod;
        subtitleStreamIndex?: number;
        tag?: string;
        transcodeReasons?: string;
        transcodingMaxAudioChannels?: number;
        videoBitRate?: number;
        videoCodec?: string;
        videoStreamIndex?: number;
        width?: number;
    }
    Index

    Properties

    _static? allowAudioStreamCopy? allowVideoStreamCopy? audioBitRate? audioChannels? audioCodec? audioSampleRate? audioStreamIndex? breakOnNonKeyFrames? container? context? copyTimestamps? cpuCoreLimit? deInterlace? deviceId? deviceProfileId? enableAudioVbrEncoding? enableAutoStreamCopy? enableMpegtsM2TsMode? framerate? height? itemId level? liveStreamId? maxAudioBitDepth? maxAudioChannels? maxFramerate? maxRefFrames? maxVideoBitDepth? mediaSourceId? minSegments? params? playSessionId? profile? requireAvc? requireNonAnamorphic? segmentContainer? segmentLength? startTimeTicks? streamOptions? subtitleCodec? subtitleMethod? subtitleStreamIndex? tag? transcodeReasons? transcodingMaxAudioChannels? videoBitRate? videoCodec? videoStreamIndex? width?

    Properties

    Optional Readonly_static

    _static?: boolean

    Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.

    AudioApiHeadAudioStream

    allowAudioStreamCopy?: boolean

    Whether or not to allow copying of the audio stream url.

    AudioApiHeadAudioStream

    allowVideoStreamCopy?: boolean

    Whether or not to allow copying of the video stream url.

    AudioApiHeadAudioStream

    audioBitRate?: number

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

    AudioApiHeadAudioStream

    audioChannels?: number

    Optional. Specify a specific number of audio channels to encode to, e.g. 2.

    AudioApiHeadAudioStream

    audioCodec?: string

    Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension.

    AudioApiHeadAudioStream

    audioSampleRate?: number

    Optional. Specify a specific audio sample rate, e.g. 44100.

    AudioApiHeadAudioStream

    audioStreamIndex?: number

    Optional. The index of the audio stream to use. If omitted the first audio stream will be used.

    AudioApiHeadAudioStream

    breakOnNonKeyFrames?: boolean

    Optional. Whether to break on non key frames.

    AudioApiHeadAudioStream

    container?: string

    The audio container.

    AudioApiHeadAudioStream

    context?: EncodingContext

    Optional. The MediaBrowser.Model.Dlna.EncodingContext.

    AudioApiHeadAudioStream

    copyTimestamps?: boolean

    Whether or not to copy timestamps when transcoding with an offset. Defaults to false.

    AudioApiHeadAudioStream

    cpuCoreLimit?: number

    Optional. The limit of how many cpu cores to use.

    AudioApiHeadAudioStream

    deInterlace?: boolean

    Optional. Whether to deinterlace the video.

    AudioApiHeadAudioStream

    deviceId?: string

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

    AudioApiHeadAudioStream

    deviceProfileId?: string

    Optional. The dlna device profile id to utilize.

    AudioApiHeadAudioStream

    enableAudioVbrEncoding?: boolean

    Optional. Whether to enable Audio Encoding.

    AudioApiHeadAudioStream

    enableAutoStreamCopy?: boolean

    Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.

    AudioApiHeadAudioStream

    enableMpegtsM2TsMode?: boolean

    Optional. Whether to enable the MpegtsM2Ts mode.

    AudioApiHeadAudioStream

    framerate?: number

    Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.

    AudioApiHeadAudioStream

    height?: number

    Optional. The fixed vertical resolution of the encoded video.

    AudioApiHeadAudioStream

    itemId: string

    The item id.

    AudioApiHeadAudioStream

    level?: string

    Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.

    AudioApiHeadAudioStream

    liveStreamId?: string

    The live stream id.

    AudioApiHeadAudioStream

    maxAudioBitDepth?: number

    Optional. The maximum audio bit depth.

    AudioApiHeadAudioStream

    maxAudioChannels?: number

    Optional. Specify a maximum number of audio channels to encode to, e.g. 2.

    AudioApiHeadAudioStream

    maxFramerate?: number

    Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.

    AudioApiHeadAudioStream

    maxRefFrames?: number

    Optional.

    AudioApiHeadAudioStream

    maxVideoBitDepth?: number

    Optional. The maximum video bit depth.

    AudioApiHeadAudioStream

    mediaSourceId?: string

    The media version id, if playing an alternate version.

    AudioApiHeadAudioStream

    minSegments?: number

    The minimum number of segments.

    AudioApiHeadAudioStream

    params?: string

    The streaming parameters.

    AudioApiHeadAudioStream

    playSessionId?: string

    The play session id.

    AudioApiHeadAudioStream

    profile?: string

    Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.

    AudioApiHeadAudioStream

    requireAvc?: boolean

    Optional. Whether to require avc.

    AudioApiHeadAudioStream

    requireNonAnamorphic?: boolean

    Optional. Whether to require a non anamorphic stream.

    AudioApiHeadAudioStream

    segmentContainer?: string

    The segment container.

    AudioApiHeadAudioStream

    segmentLength?: number

    The segment length.

    AudioApiHeadAudioStream

    startTimeTicks?: number

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

    AudioApiHeadAudioStream

    streamOptions?: { [key: string]: string }

    Optional. The streaming options.

    AudioApiHeadAudioStream

    subtitleCodec?: string

    Optional. Specify a subtitle codec to encode to.

    AudioApiHeadAudioStream

    subtitleMethod?: SubtitleDeliveryMethod

    Optional. Specify the subtitle delivery method.

    AudioApiHeadAudioStream

    subtitleStreamIndex?: number

    Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.

    AudioApiHeadAudioStream

    tag?: string

    The tag.

    AudioApiHeadAudioStream

    transcodeReasons?: string

    Optional. The transcoding reason.

    AudioApiHeadAudioStream

    transcodingMaxAudioChannels?: number

    Optional. The maximum number of audio channels to transcode.

    AudioApiHeadAudioStream

    videoBitRate?: number

    Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.

    AudioApiHeadAudioStream

    videoCodec?: string

    Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension.

    AudioApiHeadAudioStream

    videoStreamIndex?: number

    Optional. The index of the video stream to use. If omitted the first video stream will be used.

    AudioApiHeadAudioStream

    width?: number

    Optional. The fixed horizontal resolution of the encoded video.

    AudioApiHeadAudioStream

    Settings

    Member Visibility

    On This Page

    Properties