@jellyfin/sdk
    Preparing search index...

    Interface DynamicHlsApiGetLiveHlsStreamRequest

    Request parameters for getLiveHlsStream operation in DynamicHlsApi.

    DynamicHlsApiGetLiveHlsStreamRequest

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

    DynamicHlsApiGetLiveHlsStream

    allowAudioStreamCopy?: boolean

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

    DynamicHlsApiGetLiveHlsStream

    allowVideoStreamCopy?: boolean

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

    DynamicHlsApiGetLiveHlsStream

    alwaysBurnInSubtitleWhenTranscoding?: boolean

    Whether to always burn in subtitles when transcoding.

    DynamicHlsApiGetLiveHlsStream

    audioBitRate?: number

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

    DynamicHlsApiGetLiveHlsStream

    audioChannels?: number

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

    DynamicHlsApiGetLiveHlsStream

    audioCodec?: string

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

    DynamicHlsApiGetLiveHlsStream

    audioSampleRate?: number

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

    DynamicHlsApiGetLiveHlsStream

    audioStreamIndex?: number

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

    DynamicHlsApiGetLiveHlsStream

    breakOnNonKeyFrames?: boolean

    Optional. Whether to break on non key frames.

    DynamicHlsApiGetLiveHlsStream

    container?: string

    The audio container.

    DynamicHlsApiGetLiveHlsStream

    context?: EncodingContext

    Optional. The MediaBrowser.Model.Dlna.EncodingContext.

    DynamicHlsApiGetLiveHlsStream

    copyTimestamps?: boolean

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

    DynamicHlsApiGetLiveHlsStream

    cpuCoreLimit?: number

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

    DynamicHlsApiGetLiveHlsStream

    deInterlace?: boolean

    Optional. Whether to deinterlace the video.

    DynamicHlsApiGetLiveHlsStream

    deviceId?: string

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

    DynamicHlsApiGetLiveHlsStream

    deviceProfileId?: string

    Optional. The dlna device profile id to utilize.

    DynamicHlsApiGetLiveHlsStream

    enableAudioVbrEncoding?: boolean

    Optional. Whether to enable Audio Encoding.

    DynamicHlsApiGetLiveHlsStream

    enableAutoStreamCopy?: boolean

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

    DynamicHlsApiGetLiveHlsStream

    enableMpegtsM2TsMode?: boolean

    Optional. Whether to enable the MpegtsM2Ts mode.

    DynamicHlsApiGetLiveHlsStream

    enableSubtitlesInManifest?: boolean

    Optional. Whether to enable subtitles in the manifest.

    DynamicHlsApiGetLiveHlsStream

    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.

    DynamicHlsApiGetLiveHlsStream

    height?: number

    Optional. The fixed vertical resolution of the encoded video.

    DynamicHlsApiGetLiveHlsStream

    itemId: string

    The item id.

    DynamicHlsApiGetLiveHlsStream

    level?: string

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

    DynamicHlsApiGetLiveHlsStream

    liveStreamId?: string

    The live stream id.

    DynamicHlsApiGetLiveHlsStream

    maxAudioBitDepth?: number

    Optional. The maximum audio bit depth.

    DynamicHlsApiGetLiveHlsStream

    maxAudioChannels?: number

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

    DynamicHlsApiGetLiveHlsStream

    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.

    DynamicHlsApiGetLiveHlsStream

    maxHeight?: number

    Optional. The max height.

    DynamicHlsApiGetLiveHlsStream

    maxRefFrames?: number

    Optional.

    DynamicHlsApiGetLiveHlsStream

    maxVideoBitDepth?: number

    Optional. The maximum video bit depth.

    DynamicHlsApiGetLiveHlsStream

    maxWidth?: number

    Optional. The max width.

    DynamicHlsApiGetLiveHlsStream

    mediaSourceId?: string

    The media version id, if playing an alternate version.

    DynamicHlsApiGetLiveHlsStream

    minSegments?: number

    The minimum number of segments.

    DynamicHlsApiGetLiveHlsStream

    params?: string

    The streaming parameters.

    DynamicHlsApiGetLiveHlsStream

    playSessionId?: string

    The play session id.

    DynamicHlsApiGetLiveHlsStream

    profile?: string

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

    DynamicHlsApiGetLiveHlsStream

    requireAvc?: boolean

    Optional. Whether to require avc.

    DynamicHlsApiGetLiveHlsStream

    requireNonAnamorphic?: boolean

    Optional. Whether to require a non anamorphic stream.

    DynamicHlsApiGetLiveHlsStream

    segmentContainer?: string

    The segment container.

    DynamicHlsApiGetLiveHlsStream

    segmentLength?: number

    The segment length.

    DynamicHlsApiGetLiveHlsStream

    startTimeTicks?: number

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

    DynamicHlsApiGetLiveHlsStream

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

    Optional. The streaming options.

    DynamicHlsApiGetLiveHlsStream

    subtitleCodec?: string

    Optional. Specify a subtitle codec to encode to.

    DynamicHlsApiGetLiveHlsStream

    subtitleMethod?: SubtitleDeliveryMethod

    Optional. Specify the subtitle delivery method.

    DynamicHlsApiGetLiveHlsStream

    subtitleStreamIndex?: number

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

    DynamicHlsApiGetLiveHlsStream

    tag?: string

    The tag.

    DynamicHlsApiGetLiveHlsStream

    transcodeReasons?: string

    Optional. The transcoding reason.

    DynamicHlsApiGetLiveHlsStream

    transcodingMaxAudioChannels?: number

    Optional. The maximum number of audio channels to transcode.

    DynamicHlsApiGetLiveHlsStream

    videoBitRate?: number

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

    DynamicHlsApiGetLiveHlsStream

    videoCodec?: string

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

    DynamicHlsApiGetLiveHlsStream

    videoStreamIndex?: number

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

    DynamicHlsApiGetLiveHlsStream

    width?: number

    Optional. The fixed horizontal resolution of the encoded video.

    DynamicHlsApiGetLiveHlsStream

    Settings

    Member Visibility

    On This Page

    Properties