@jellyfin/sdk
    Preparing search index...

    Interface DynamicHlsApiGetVariantHlsAudioPlaylistRequest

    Request parameters for getVariantHlsAudioPlaylist operation in DynamicHlsApi.

    DynamicHlsApiGetVariantHlsAudioPlaylistRequest

    interface DynamicHlsApiGetVariantHlsAudioPlaylistRequest {
        _static?: boolean;
        allowAudioStreamCopy?: boolean;
        allowVideoStreamCopy?: boolean;
        audioBitRate?: number;
        audioChannels?: number;
        audioCodec?: string;
        audioSampleRate?: number;
        audioStreamIndex?: number;
        breakOnNonKeyFrames?: boolean;
        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;
        maxStreamingBitrate?: 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? context? copyTimestamps? cpuCoreLimit? deInterlace? deviceId? deviceProfileId? enableAudioVbrEncoding? enableAutoStreamCopy? enableMpegtsM2TsMode? framerate? height? itemId level? liveStreamId? maxAudioBitDepth? maxAudioChannels? maxFramerate? maxRefFrames? maxStreamingBitrate? 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.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    allowAudioStreamCopy?: boolean

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    allowVideoStreamCopy?: boolean

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    audioBitRate?: number

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    audioChannels?: number

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    audioCodec?: string

    Optional. Specify an audio codec to encode to, e.g. mp3.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    audioSampleRate?: number

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    audioStreamIndex?: number

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    breakOnNonKeyFrames?: boolean

    Optional. Whether to break on non key frames.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    context?: EncodingContext

    Optional. The MediaBrowser.Model.Dlna.EncodingContext.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    copyTimestamps?: boolean

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    cpuCoreLimit?: number

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    deInterlace?: boolean

    Optional. Whether to deinterlace the video.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    deviceId?: string

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    deviceProfileId?: string

    Optional. The dlna device profile id to utilize.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    enableAudioVbrEncoding?: boolean

    Optional. Whether to enable Audio Encoding.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    enableAutoStreamCopy?: boolean

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    enableMpegtsM2TsMode?: boolean

    Optional. Whether to enable the MpegtsM2Ts mode.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    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.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    height?: number

    Optional. The fixed vertical resolution of the encoded video.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    itemId: string

    The item id.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    level?: string

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    liveStreamId?: string

    The live stream id.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    maxAudioBitDepth?: number

    Optional. The maximum audio bit depth.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    maxAudioChannels?: number

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    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.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    maxRefFrames?: number

    Optional.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    maxStreamingBitrate?: number

    Optional. The maximum streaming bitrate.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    maxVideoBitDepth?: number

    Optional. The maximum video bit depth.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    mediaSourceId?: string

    The media version id, if playing an alternate version.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    minSegments?: number

    The minimum number of segments.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    params?: string

    The streaming parameters.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    playSessionId?: string

    The play session id.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    profile?: string

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    requireAvc?: boolean

    Optional. Whether to require avc.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    requireNonAnamorphic?: boolean

    Optional. Whether to require a non anamorphic stream.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    segmentContainer?: string

    The segment container.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    segmentLength?: number

    The segment length.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    startTimeTicks?: number

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

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

    Optional. The streaming options.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    subtitleCodec?: string

    Optional. Specify a subtitle codec to encode to.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    subtitleMethod?: SubtitleDeliveryMethod

    Optional. Specify the subtitle delivery method.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    subtitleStreamIndex?: number

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    tag?: string

    The tag.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    transcodeReasons?: string

    Optional. The transcoding reason.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    transcodingMaxAudioChannels?: number

    Optional. The maximum number of audio channels to transcode.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    videoBitRate?: number

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    videoCodec?: string

    Optional. Specify a video codec to encode to, e.g. h264.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    videoStreamIndex?: number

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

    DynamicHlsApiGetVariantHlsAudioPlaylist

    width?: number

    Optional. The fixed horizontal resolution of the encoded video.

    DynamicHlsApiGetVariantHlsAudioPlaylist

    Settings

    Member Visibility

    On This Page

    Properties