DynamicHlsApi - axios parameter creator

  • Parameters

    Returns {
        getHlsAudioSegment: ((itemId: string, playlistId: string, segmentId: number, container: string, runtimeTicks: number, actualSegmentLengthTicks: number, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
            [key: string]: string;
        }, enableAudioVbrEncoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getHlsVideoSegment: ((itemId: string, playlistId: string, segmentId: number, container: string, runtimeTicks: number, actualSegmentLengthTicks: number, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
            [key: string]: string;
        }, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getLiveHlsStream: ((itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
            [key: string]: string;
        }, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getMasterHlsAudioPlaylist: ((itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
            [key: string]: string;
        }, enableAdaptiveBitrateStreaming?: boolean, enableAudioVbrEncoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getMasterHlsVideoPlaylist: ((itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
            [key: string]: string;
        }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getVariantHlsAudioPlaylist: ((itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
            [key: string]: string;
        }, enableAudioVbrEncoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getVariantHlsVideoPlaylist: ((itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
            [key: string]: string;
        }, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        headMasterHlsAudioPlaylist: ((itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
            [key: string]: string;
        }, enableAdaptiveBitrateStreaming?: boolean, enableAudioVbrEncoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        headMasterHlsVideoPlaylist: ((itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
            [key: string]: string;
        }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • getHlsAudioSegment: ((itemId: string, playlistId: string, segmentId: number, container: string, runtimeTicks: number, actualSegmentLengthTicks: number, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
          [key: string]: string;
      }, enableAudioVbrEncoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Gets a video stream using HTTP live streaming.

        • (itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, mediaSourceId?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, maxStreamingBitrate?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAudioVbrEncoding?, options?): Promise<RequestArgs>
        • Parameters

          • itemId: string

            The item id.

          • playlistId: string

            The playlist id.

          • segmentId: number

            The segment id.

          • container: string

            The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.

          • runtimeTicks: number

            The position of the requested segment in ticks.

          • actualSegmentLengthTicks: number

            The length of the requested segment in ticks.

          • Optional_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.

          • Optionalparams: string

            The streaming parameters.

          • Optionaltag: string

            The tag.

          • OptionaldeviceProfileId: string

            Optional. The dlna device profile id to utilize.

          • OptionalplaySessionId: string

            The play session id.

          • OptionalsegmentContainer: string

            The segment container.

          • OptionalsegmentLength: number

            The segment length.

          • OptionalminSegments: number

            The minimum number of segments.

          • 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.

          • OptionalaudioCodec: string

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

          • OptionalenableAutoStreamCopy: boolean

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

          • OptionalallowVideoStreamCopy: boolean

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

          • OptionalallowAudioStreamCopy: boolean

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

          • OptionalbreakOnNonKeyFrames: boolean

            Optional. Whether to break on non key frames.

          • OptionalaudioSampleRate: number

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

          • OptionalmaxAudioBitDepth: number

            Optional. The maximum audio bit depth.

          • 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.

          • OptionalaudioChannels: number

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

          • OptionalmaxAudioChannels: number

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

          • Optionalprofile: string

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

          • Optionallevel: string

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

          • Optionalframerate: number

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

          • OptionalmaxFramerate: 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.

          • OptionalcopyTimestamps: boolean

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

          • OptionalstartTimeTicks: number

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

          • Optionalwidth: number

            Optional. The fixed horizontal resolution of the encoded video.

          • Optionalheight: number

            Optional. The fixed vertical resolution of the encoded video.

          • OptionalvideoBitRate: number

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

          • OptionalsubtitleStreamIndex: number

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

          • OptionalsubtitleMethod: SubtitleDeliveryMethod

            Optional. Specify the subtitle delivery method.

          • OptionalmaxRefFrames: number

            Optional.

          • OptionalmaxVideoBitDepth: number

            Optional. The maximum video bit depth.

          • OptionalrequireAvc: boolean

            Optional. Whether to require avc.

          • OptionaldeInterlace: boolean

            Optional. Whether to deinterlace the video.

          • OptionalrequireNonAnamorphic: boolean

            Optional. Whether to require a non anamorphic stream.

          • OptionaltranscodingMaxAudioChannels: number

            Optional. The maximum number of audio channels to transcode.

          • OptionalcpuCoreLimit: number

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

          • OptionalliveStreamId: string

            The live stream id.

          • OptionalenableMpegtsM2TsMode: boolean

            Optional. Whether to enable the MpegtsM2Ts mode.

          • OptionalvideoCodec: string

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

          • OptionalsubtitleCodec: string

            Optional. Specify a subtitle codec to encode to.

          • OptionaltranscodeReasons: string

            Optional. The transcoding reason.

          • OptionalaudioStreamIndex: number

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

          • OptionalvideoStreamIndex: number

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

          • Optionalcontext: EncodingContext

            Optional. The MediaBrowser.Model.Dlna.EncodingContext.

          • OptionalstreamOptions: {
                [key: string]: string;
            }

            Optional. The streaming options.

            • [key: string]: string
          • OptionalenableAudioVbrEncoding: boolean

            Optional. Whether to enable Audio Encoding.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getHlsVideoSegment: ((itemId: string, playlistId: string, segmentId: number, container: string, runtimeTicks: number, actualSegmentLengthTicks: number, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
          [key: string]: string;
      }, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Gets a video stream using HTTP live streaming.

        • (itemId, playlistId, segmentId, container, runtimeTicks, actualSegmentLengthTicks, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, mediaSourceId?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, maxWidth?, maxHeight?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAudioVbrEncoding?, alwaysBurnInSubtitleWhenTranscoding?, options?): Promise<RequestArgs>
        • Parameters

          • itemId: string

            The item id.

          • playlistId: string

            The playlist id.

          • segmentId: number

            The segment id.

          • container: string

            The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.

          • runtimeTicks: number

            The position of the requested segment in ticks.

          • actualSegmentLengthTicks: number

            The length of the requested segment in ticks.

          • Optional_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.

          • Optionalparams: string

            The streaming parameters.

          • Optionaltag: string

            The tag.

          • OptionaldeviceProfileId: string

            Optional. The dlna device profile id to utilize.

          • OptionalplaySessionId: string

            The play session id.

          • OptionalsegmentContainer: string

            The segment container.

          • OptionalsegmentLength: number

            The desired segment length.

          • OptionalminSegments: number

            The minimum number of segments.

          • 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.

          • OptionalaudioCodec: string

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

          • OptionalenableAutoStreamCopy: boolean

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

          • OptionalallowVideoStreamCopy: boolean

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

          • OptionalallowAudioStreamCopy: boolean

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

          • OptionalbreakOnNonKeyFrames: boolean

            Optional. Whether to break on non key frames.

          • OptionalaudioSampleRate: number

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

          • OptionalmaxAudioBitDepth: number

            Optional. The maximum audio bit depth.

          • OptionalaudioBitRate: number

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

          • OptionalaudioChannels: number

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

          • OptionalmaxAudioChannels: number

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

          • Optionalprofile: string

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

          • Optionallevel: string

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

          • Optionalframerate: number

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

          • OptionalmaxFramerate: 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.

          • OptionalcopyTimestamps: boolean

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

          • OptionalstartTimeTicks: number

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

          • Optionalwidth: number

            Optional. The fixed horizontal resolution of the encoded video.

          • Optionalheight: number

            Optional. The fixed vertical resolution of the encoded video.

          • OptionalmaxWidth: number

            Optional. The maximum horizontal resolution of the encoded video.

          • OptionalmaxHeight: number

            Optional. The maximum vertical resolution of the encoded video.

          • OptionalvideoBitRate: number

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

          • OptionalsubtitleStreamIndex: number

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

          • OptionalsubtitleMethod: SubtitleDeliveryMethod

            Optional. Specify the subtitle delivery method.

          • OptionalmaxRefFrames: number

            Optional.

          • OptionalmaxVideoBitDepth: number

            Optional. The maximum video bit depth.

          • OptionalrequireAvc: boolean

            Optional. Whether to require avc.

          • OptionaldeInterlace: boolean

            Optional. Whether to deinterlace the video.

          • OptionalrequireNonAnamorphic: boolean

            Optional. Whether to require a non anamorphic stream.

          • OptionaltranscodingMaxAudioChannels: number

            Optional. The maximum number of audio channels to transcode.

          • OptionalcpuCoreLimit: number

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

          • OptionalliveStreamId: string

            The live stream id.

          • OptionalenableMpegtsM2TsMode: boolean

            Optional. Whether to enable the MpegtsM2Ts mode.

          • OptionalvideoCodec: string

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

          • OptionalsubtitleCodec: string

            Optional. Specify a subtitle codec to encode to.

          • OptionaltranscodeReasons: string

            Optional. The transcoding reason.

          • OptionalaudioStreamIndex: number

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

          • OptionalvideoStreamIndex: number

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

          • Optionalcontext: EncodingContext

            Optional. The MediaBrowser.Model.Dlna.EncodingContext.

          • OptionalstreamOptions: {
                [key: string]: string;
            }

            Optional. The streaming options.

            • [key: string]: string
          • OptionalenableAudioVbrEncoding: boolean

            Optional. Whether to enable Audio Encoding.

          • OptionalalwaysBurnInSubtitleWhenTranscoding: boolean

            Whether to always burn in subtitles when transcoding.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getLiveHlsStream: ((itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
          [key: string]: string;
      }, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Gets a hls live stream.

        • (itemId, container?, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, mediaSourceId?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, maxWidth?, maxHeight?, enableSubtitlesInManifest?, enableAudioVbrEncoding?, alwaysBurnInSubtitleWhenTranscoding?, options?): Promise<RequestArgs>
        • Parameters

          • itemId: string

            The item id.

          • Optionalcontainer: string

            The audio container.

          • Optional_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.

          • Optionalparams: string

            The streaming parameters.

          • Optionaltag: string

            The tag.

          • OptionaldeviceProfileId: string

            Optional. The dlna device profile id to utilize.

          • OptionalplaySessionId: string

            The play session id.

          • OptionalsegmentContainer: string

            The segment container.

          • OptionalsegmentLength: number

            The segment length.

          • OptionalminSegments: number

            The minimum number of segments.

          • 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.

          • OptionalaudioCodec: string

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

          • OptionalenableAutoStreamCopy: boolean

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

          • OptionalallowVideoStreamCopy: boolean

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

          • OptionalallowAudioStreamCopy: boolean

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

          • OptionalbreakOnNonKeyFrames: boolean

            Optional. Whether to break on non key frames.

          • OptionalaudioSampleRate: number

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

          • OptionalmaxAudioBitDepth: number

            Optional. The maximum audio bit depth.

          • OptionalaudioBitRate: number

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

          • OptionalaudioChannels: number

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

          • OptionalmaxAudioChannels: number

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

          • Optionalprofile: string

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

          • Optionallevel: string

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

          • Optionalframerate: number

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

          • OptionalmaxFramerate: 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.

          • OptionalcopyTimestamps: boolean

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

          • OptionalstartTimeTicks: number

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

          • Optionalwidth: number

            Optional. The fixed horizontal resolution of the encoded video.

          • Optionalheight: number

            Optional. The fixed vertical resolution of the encoded video.

          • OptionalvideoBitRate: number

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

          • OptionalsubtitleStreamIndex: number

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

          • OptionalsubtitleMethod: SubtitleDeliveryMethod

            Optional. Specify the subtitle delivery method.

          • OptionalmaxRefFrames: number

            Optional.

          • OptionalmaxVideoBitDepth: number

            Optional. The maximum video bit depth.

          • OptionalrequireAvc: boolean

            Optional. Whether to require avc.

          • OptionaldeInterlace: boolean

            Optional. Whether to deinterlace the video.

          • OptionalrequireNonAnamorphic: boolean

            Optional. Whether to require a non anamorphic stream.

          • OptionaltranscodingMaxAudioChannels: number

            Optional. The maximum number of audio channels to transcode.

          • OptionalcpuCoreLimit: number

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

          • OptionalliveStreamId: string

            The live stream id.

          • OptionalenableMpegtsM2TsMode: boolean

            Optional. Whether to enable the MpegtsM2Ts mode.

          • OptionalvideoCodec: string

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

          • OptionalsubtitleCodec: string

            Optional. Specify a subtitle codec to encode to.

          • OptionaltranscodeReasons: string

            Optional. The transcoding reason.

          • OptionalaudioStreamIndex: number

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

          • OptionalvideoStreamIndex: number

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

          • Optionalcontext: EncodingContext

            Optional. The MediaBrowser.Model.Dlna.EncodingContext.

          • OptionalstreamOptions: {
                [key: string]: string;
            }

            Optional. The streaming options.

            • [key: string]: string
          • OptionalmaxWidth: number

            Optional. The max width.

          • OptionalmaxHeight: number

            Optional. The max height.

          • OptionalenableSubtitlesInManifest: boolean

            Optional. Whether to enable subtitles in the manifest.

          • OptionalenableAudioVbrEncoding: boolean

            Optional. Whether to enable Audio Encoding.

          • OptionalalwaysBurnInSubtitleWhenTranscoding: boolean

            Whether to always burn in subtitles when transcoding.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getMasterHlsAudioPlaylist: ((itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
          [key: string]: string;
      }, enableAdaptiveBitrateStreaming?: boolean, enableAudioVbrEncoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Gets an audio hls playlist stream.

        • (itemId, mediaSourceId, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, maxStreamingBitrate?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAdaptiveBitrateStreaming?, enableAudioVbrEncoding?, options?): Promise<RequestArgs>
        • Parameters

          • itemId: string

            The item id.

          • mediaSourceId: string

            The media version id, if playing an alternate version.

          • Optional_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.

          • Optionalparams: string

            The streaming parameters.

          • Optionaltag: string

            The tag.

          • OptionaldeviceProfileId: string

            Optional. The dlna device profile id to utilize.

          • OptionalplaySessionId: string

            The play session id.

          • OptionalsegmentContainer: string

            The segment container.

          • OptionalsegmentLength: number

            The segment length.

          • OptionalminSegments: number

            The minimum number of segments.

          • OptionaldeviceId: string

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

          • OptionalaudioCodec: string

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

          • OptionalenableAutoStreamCopy: boolean

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

          • OptionalallowVideoStreamCopy: boolean

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

          • OptionalallowAudioStreamCopy: boolean

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

          • OptionalbreakOnNonKeyFrames: boolean

            Optional. Whether to break on non key frames.

          • OptionalaudioSampleRate: number

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

          • OptionalmaxAudioBitDepth: number

            Optional. The maximum audio bit depth.

          • 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.

          • OptionalaudioChannels: number

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

          • OptionalmaxAudioChannels: number

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

          • Optionalprofile: string

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

          • Optionallevel: string

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

          • Optionalframerate: number

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

          • OptionalmaxFramerate: 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.

          • OptionalcopyTimestamps: boolean

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

          • OptionalstartTimeTicks: number

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

          • Optionalwidth: number

            Optional. The fixed horizontal resolution of the encoded video.

          • Optionalheight: number

            Optional. The fixed vertical resolution of the encoded video.

          • OptionalvideoBitRate: number

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

          • OptionalsubtitleStreamIndex: number

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

          • OptionalsubtitleMethod: SubtitleDeliveryMethod

            Optional. Specify the subtitle delivery method.

          • OptionalmaxRefFrames: number

            Optional.

          • OptionalmaxVideoBitDepth: number

            Optional. The maximum video bit depth.

          • OptionalrequireAvc: boolean

            Optional. Whether to require avc.

          • OptionaldeInterlace: boolean

            Optional. Whether to deinterlace the video.

          • OptionalrequireNonAnamorphic: boolean

            Optional. Whether to require a non anamorphic stream.

          • OptionaltranscodingMaxAudioChannels: number

            Optional. The maximum number of audio channels to transcode.

          • OptionalcpuCoreLimit: number

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

          • OptionalliveStreamId: string

            The live stream id.

          • OptionalenableMpegtsM2TsMode: boolean

            Optional. Whether to enable the MpegtsM2Ts mode.

          • OptionalvideoCodec: string

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

          • OptionalsubtitleCodec: string

            Optional. Specify a subtitle codec to encode to.

          • OptionaltranscodeReasons: string

            Optional. The transcoding reason.

          • OptionalaudioStreamIndex: number

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

          • OptionalvideoStreamIndex: number

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

          • Optionalcontext: EncodingContext

            Optional. The MediaBrowser.Model.Dlna.EncodingContext.

          • OptionalstreamOptions: {
                [key: string]: string;
            }

            Optional. The streaming options.

            • [key: string]: string
          • OptionalenableAdaptiveBitrateStreaming: boolean

            Enable adaptive bitrate streaming.

          • OptionalenableAudioVbrEncoding: boolean

            Optional. Whether to enable Audio Encoding.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getMasterHlsVideoPlaylist: ((itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
          [key: string]: string;
      }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Gets a video hls playlist stream.

        • (itemId, mediaSourceId, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, maxWidth?, maxHeight?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAdaptiveBitrateStreaming?, enableTrickplay?, enableAudioVbrEncoding?, alwaysBurnInSubtitleWhenTranscoding?, options?): Promise<RequestArgs>
        • Parameters

          • itemId: string

            The item id.

          • mediaSourceId: string

            The media version id, if playing an alternate version.

          • Optional_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.

          • Optionalparams: string

            The streaming parameters.

          • Optionaltag: string

            The tag.

          • OptionaldeviceProfileId: string

            Optional. The dlna device profile id to utilize.

          • OptionalplaySessionId: string

            The play session id.

          • OptionalsegmentContainer: string

            The segment container.

          • OptionalsegmentLength: number

            The segment length.

          • OptionalminSegments: number

            The minimum number of segments.

          • OptionaldeviceId: string

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

          • OptionalaudioCodec: string

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

          • OptionalenableAutoStreamCopy: boolean

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

          • OptionalallowVideoStreamCopy: boolean

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

          • OptionalallowAudioStreamCopy: boolean

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

          • OptionalbreakOnNonKeyFrames: boolean

            Optional. Whether to break on non key frames.

          • OptionalaudioSampleRate: number

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

          • OptionalmaxAudioBitDepth: number

            Optional. The maximum audio bit depth.

          • OptionalaudioBitRate: number

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

          • OptionalaudioChannels: number

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

          • OptionalmaxAudioChannels: number

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

          • Optionalprofile: string

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

          • Optionallevel: string

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

          • Optionalframerate: number

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

          • OptionalmaxFramerate: 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.

          • OptionalcopyTimestamps: boolean

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

          • OptionalstartTimeTicks: number

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

          • Optionalwidth: number

            Optional. The fixed horizontal resolution of the encoded video.

          • Optionalheight: number

            Optional. The fixed vertical resolution of the encoded video.

          • OptionalmaxWidth: number

            Optional. The maximum horizontal resolution of the encoded video.

          • OptionalmaxHeight: number

            Optional. The maximum vertical resolution of the encoded video.

          • OptionalvideoBitRate: number

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

          • OptionalsubtitleStreamIndex: number

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

          • OptionalsubtitleMethod: SubtitleDeliveryMethod

            Optional. Specify the subtitle delivery method.

          • OptionalmaxRefFrames: number

            Optional.

          • OptionalmaxVideoBitDepth: number

            Optional. The maximum video bit depth.

          • OptionalrequireAvc: boolean

            Optional. Whether to require avc.

          • OptionaldeInterlace: boolean

            Optional. Whether to deinterlace the video.

          • OptionalrequireNonAnamorphic: boolean

            Optional. Whether to require a non anamorphic stream.

          • OptionaltranscodingMaxAudioChannels: number

            Optional. The maximum number of audio channels to transcode.

          • OptionalcpuCoreLimit: number

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

          • OptionalliveStreamId: string

            The live stream id.

          • OptionalenableMpegtsM2TsMode: boolean

            Optional. Whether to enable the MpegtsM2Ts mode.

          • OptionalvideoCodec: string

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

          • OptionalsubtitleCodec: string

            Optional. Specify a subtitle codec to encode to.

          • OptionaltranscodeReasons: string

            Optional. The transcoding reason.

          • OptionalaudioStreamIndex: number

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

          • OptionalvideoStreamIndex: number

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

          • Optionalcontext: EncodingContext

            Optional. The MediaBrowser.Model.Dlna.EncodingContext.

          • OptionalstreamOptions: {
                [key: string]: string;
            }

            Optional. The streaming options.

            • [key: string]: string
          • OptionalenableAdaptiveBitrateStreaming: boolean

            Enable adaptive bitrate streaming.

          • OptionalenableTrickplay: boolean

            Enable trickplay image playlists being added to master playlist.

          • OptionalenableAudioVbrEncoding: boolean

            Whether to enable Audio Encoding.

          • OptionalalwaysBurnInSubtitleWhenTranscoding: boolean

            Whether to always burn in subtitles when transcoding.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getVariantHlsAudioPlaylist: ((itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
          [key: string]: string;
      }, enableAudioVbrEncoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Gets an audio stream using HTTP live streaming.

        • (itemId, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, mediaSourceId?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, maxStreamingBitrate?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAudioVbrEncoding?, options?): Promise<RequestArgs>
        • Parameters

          • itemId: string

            The item id.

          • Optional_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.

          • Optionalparams: string

            The streaming parameters.

          • Optionaltag: string

            The tag.

          • OptionaldeviceProfileId: string

            Optional. The dlna device profile id to utilize.

          • OptionalplaySessionId: string

            The play session id.

          • OptionalsegmentContainer: string

            The segment container.

          • OptionalsegmentLength: number

            The segment length.

          • OptionalminSegments: number

            The minimum number of segments.

          • 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.

          • OptionalaudioCodec: string

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

          • OptionalenableAutoStreamCopy: boolean

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

          • OptionalallowVideoStreamCopy: boolean

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

          • OptionalallowAudioStreamCopy: boolean

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

          • OptionalbreakOnNonKeyFrames: boolean

            Optional. Whether to break on non key frames.

          • OptionalaudioSampleRate: number

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

          • OptionalmaxAudioBitDepth: number

            Optional. The maximum audio bit depth.

          • 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.

          • OptionalaudioChannels: number

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

          • OptionalmaxAudioChannels: number

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

          • Optionalprofile: string

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

          • Optionallevel: string

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

          • Optionalframerate: number

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

          • OptionalmaxFramerate: 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.

          • OptionalcopyTimestamps: boolean

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

          • OptionalstartTimeTicks: number

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

          • Optionalwidth: number

            Optional. The fixed horizontal resolution of the encoded video.

          • Optionalheight: number

            Optional. The fixed vertical resolution of the encoded video.

          • OptionalvideoBitRate: number

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

          • OptionalsubtitleStreamIndex: number

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

          • OptionalsubtitleMethod: SubtitleDeliveryMethod

            Optional. Specify the subtitle delivery method.

          • OptionalmaxRefFrames: number

            Optional.

          • OptionalmaxVideoBitDepth: number

            Optional. The maximum video bit depth.

          • OptionalrequireAvc: boolean

            Optional. Whether to require avc.

          • OptionaldeInterlace: boolean

            Optional. Whether to deinterlace the video.

          • OptionalrequireNonAnamorphic: boolean

            Optional. Whether to require a non anamorphic stream.

          • OptionaltranscodingMaxAudioChannels: number

            Optional. The maximum number of audio channels to transcode.

          • OptionalcpuCoreLimit: number

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

          • OptionalliveStreamId: string

            The live stream id.

          • OptionalenableMpegtsM2TsMode: boolean

            Optional. Whether to enable the MpegtsM2Ts mode.

          • OptionalvideoCodec: string

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

          • OptionalsubtitleCodec: string

            Optional. Specify a subtitle codec to encode to.

          • OptionaltranscodeReasons: string

            Optional. The transcoding reason.

          • OptionalaudioStreamIndex: number

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

          • OptionalvideoStreamIndex: number

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

          • Optionalcontext: EncodingContext

            Optional. The MediaBrowser.Model.Dlna.EncodingContext.

          • OptionalstreamOptions: {
                [key: string]: string;
            }

            Optional. The streaming options.

            • [key: string]: string
          • OptionalenableAudioVbrEncoding: boolean

            Optional. Whether to enable Audio Encoding.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getVariantHlsVideoPlaylist: ((itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
          [key: string]: string;
      }, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Gets a video stream using HTTP live streaming.

        • (itemId, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, mediaSourceId?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, maxWidth?, maxHeight?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAudioVbrEncoding?, alwaysBurnInSubtitleWhenTranscoding?, options?): Promise<RequestArgs>
        • Parameters

          • itemId: string

            The item id.

          • Optional_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.

          • Optionalparams: string

            The streaming parameters.

          • Optionaltag: string

            The tag.

          • OptionaldeviceProfileId: string

            Optional. The dlna device profile id to utilize.

          • OptionalplaySessionId: string

            The play session id.

          • OptionalsegmentContainer: string

            The segment container.

          • OptionalsegmentLength: number

            The segment length.

          • OptionalminSegments: number

            The minimum number of segments.

          • 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.

          • OptionalaudioCodec: string

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

          • OptionalenableAutoStreamCopy: boolean

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

          • OptionalallowVideoStreamCopy: boolean

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

          • OptionalallowAudioStreamCopy: boolean

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

          • OptionalbreakOnNonKeyFrames: boolean

            Optional. Whether to break on non key frames.

          • OptionalaudioSampleRate: number

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

          • OptionalmaxAudioBitDepth: number

            Optional. The maximum audio bit depth.

          • OptionalaudioBitRate: number

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

          • OptionalaudioChannels: number

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

          • OptionalmaxAudioChannels: number

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

          • Optionalprofile: string

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

          • Optionallevel: string

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

          • Optionalframerate: number

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

          • OptionalmaxFramerate: 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.

          • OptionalcopyTimestamps: boolean

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

          • OptionalstartTimeTicks: number

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

          • Optionalwidth: number

            Optional. The fixed horizontal resolution of the encoded video.

          • Optionalheight: number

            Optional. The fixed vertical resolution of the encoded video.

          • OptionalmaxWidth: number

            Optional. The maximum horizontal resolution of the encoded video.

          • OptionalmaxHeight: number

            Optional. The maximum vertical resolution of the encoded video.

          • OptionalvideoBitRate: number

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

          • OptionalsubtitleStreamIndex: number

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

          • OptionalsubtitleMethod: SubtitleDeliveryMethod

            Optional. Specify the subtitle delivery method.

          • OptionalmaxRefFrames: number

            Optional.

          • OptionalmaxVideoBitDepth: number

            Optional. The maximum video bit depth.

          • OptionalrequireAvc: boolean

            Optional. Whether to require avc.

          • OptionaldeInterlace: boolean

            Optional. Whether to deinterlace the video.

          • OptionalrequireNonAnamorphic: boolean

            Optional. Whether to require a non anamorphic stream.

          • OptionaltranscodingMaxAudioChannels: number

            Optional. The maximum number of audio channels to transcode.

          • OptionalcpuCoreLimit: number

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

          • OptionalliveStreamId: string

            The live stream id.

          • OptionalenableMpegtsM2TsMode: boolean

            Optional. Whether to enable the MpegtsM2Ts mode.

          • OptionalvideoCodec: string

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

          • OptionalsubtitleCodec: string

            Optional. Specify a subtitle codec to encode to.

          • OptionaltranscodeReasons: string

            Optional. The transcoding reason.

          • OptionalaudioStreamIndex: number

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

          • OptionalvideoStreamIndex: number

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

          • Optionalcontext: EncodingContext

            Optional. The MediaBrowser.Model.Dlna.EncodingContext.

          • OptionalstreamOptions: {
                [key: string]: string;
            }

            Optional. The streaming options.

            • [key: string]: string
          • OptionalenableAudioVbrEncoding: boolean

            Optional. Whether to enable Audio Encoding.

          • OptionalalwaysBurnInSubtitleWhenTranscoding: boolean

            Whether to always burn in subtitles when transcoding.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • headMasterHlsAudioPlaylist: ((itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
          [key: string]: string;
      }, enableAdaptiveBitrateStreaming?: boolean, enableAudioVbrEncoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Gets an audio hls playlist stream.

        • (itemId, mediaSourceId, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, maxStreamingBitrate?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAdaptiveBitrateStreaming?, enableAudioVbrEncoding?, options?): Promise<RequestArgs>
        • Parameters

          • itemId: string

            The item id.

          • mediaSourceId: string

            The media version id, if playing an alternate version.

          • Optional_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.

          • Optionalparams: string

            The streaming parameters.

          • Optionaltag: string

            The tag.

          • OptionaldeviceProfileId: string

            Optional. The dlna device profile id to utilize.

          • OptionalplaySessionId: string

            The play session id.

          • OptionalsegmentContainer: string

            The segment container.

          • OptionalsegmentLength: number

            The segment length.

          • OptionalminSegments: number

            The minimum number of segments.

          • OptionaldeviceId: string

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

          • OptionalaudioCodec: string

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

          • OptionalenableAutoStreamCopy: boolean

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

          • OptionalallowVideoStreamCopy: boolean

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

          • OptionalallowAudioStreamCopy: boolean

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

          • OptionalbreakOnNonKeyFrames: boolean

            Optional. Whether to break on non key frames.

          • OptionalaudioSampleRate: number

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

          • OptionalmaxAudioBitDepth: number

            Optional. The maximum audio bit depth.

          • 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.

          • OptionalaudioChannels: number

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

          • OptionalmaxAudioChannels: number

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

          • Optionalprofile: string

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

          • Optionallevel: string

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

          • Optionalframerate: number

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

          • OptionalmaxFramerate: 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.

          • OptionalcopyTimestamps: boolean

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

          • OptionalstartTimeTicks: number

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

          • Optionalwidth: number

            Optional. The fixed horizontal resolution of the encoded video.

          • Optionalheight: number

            Optional. The fixed vertical resolution of the encoded video.

          • OptionalvideoBitRate: number

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

          • OptionalsubtitleStreamIndex: number

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

          • OptionalsubtitleMethod: SubtitleDeliveryMethod

            Optional. Specify the subtitle delivery method.

          • OptionalmaxRefFrames: number

            Optional.

          • OptionalmaxVideoBitDepth: number

            Optional. The maximum video bit depth.

          • OptionalrequireAvc: boolean

            Optional. Whether to require avc.

          • OptionaldeInterlace: boolean

            Optional. Whether to deinterlace the video.

          • OptionalrequireNonAnamorphic: boolean

            Optional. Whether to require a non anamorphic stream.

          • OptionaltranscodingMaxAudioChannels: number

            Optional. The maximum number of audio channels to transcode.

          • OptionalcpuCoreLimit: number

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

          • OptionalliveStreamId: string

            The live stream id.

          • OptionalenableMpegtsM2TsMode: boolean

            Optional. Whether to enable the MpegtsM2Ts mode.

          • OptionalvideoCodec: string

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

          • OptionalsubtitleCodec: string

            Optional. Specify a subtitle codec to encode to.

          • OptionaltranscodeReasons: string

            Optional. The transcoding reason.

          • OptionalaudioStreamIndex: number

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

          • OptionalvideoStreamIndex: number

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

          • Optionalcontext: EncodingContext

            Optional. The MediaBrowser.Model.Dlna.EncodingContext.

          • OptionalstreamOptions: {
                [key: string]: string;
            }

            Optional. The streaming options.

            • [key: string]: string
          • OptionalenableAdaptiveBitrateStreaming: boolean

            Enable adaptive bitrate streaming.

          • OptionalenableAudioVbrEncoding: boolean

            Optional. Whether to enable Audio Encoding.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • headMasterHlsVideoPlaylist: ((itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
          [key: string]: string;
      }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Gets a video hls playlist stream.

        • (itemId, mediaSourceId, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, maxWidth?, maxHeight?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAdaptiveBitrateStreaming?, enableTrickplay?, enableAudioVbrEncoding?, alwaysBurnInSubtitleWhenTranscoding?, options?): Promise<RequestArgs>
        • Parameters

          • itemId: string

            The item id.

          • mediaSourceId: string

            The media version id, if playing an alternate version.

          • Optional_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.

          • Optionalparams: string

            The streaming parameters.

          • Optionaltag: string

            The tag.

          • OptionaldeviceProfileId: string

            Optional. The dlna device profile id to utilize.

          • OptionalplaySessionId: string

            The play session id.

          • OptionalsegmentContainer: string

            The segment container.

          • OptionalsegmentLength: number

            The segment length.

          • OptionalminSegments: number

            The minimum number of segments.

          • OptionaldeviceId: string

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

          • OptionalaudioCodec: string

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

          • OptionalenableAutoStreamCopy: boolean

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

          • OptionalallowVideoStreamCopy: boolean

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

          • OptionalallowAudioStreamCopy: boolean

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

          • OptionalbreakOnNonKeyFrames: boolean

            Optional. Whether to break on non key frames.

          • OptionalaudioSampleRate: number

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

          • OptionalmaxAudioBitDepth: number

            Optional. The maximum audio bit depth.

          • OptionalaudioBitRate: number

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

          • OptionalaudioChannels: number

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

          • OptionalmaxAudioChannels: number

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

          • Optionalprofile: string

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

          • Optionallevel: string

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

          • Optionalframerate: number

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

          • OptionalmaxFramerate: 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.

          • OptionalcopyTimestamps: boolean

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

          • OptionalstartTimeTicks: number

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

          • Optionalwidth: number

            Optional. The fixed horizontal resolution of the encoded video.

          • Optionalheight: number

            Optional. The fixed vertical resolution of the encoded video.

          • OptionalmaxWidth: number

            Optional. The maximum horizontal resolution of the encoded video.

          • OptionalmaxHeight: number

            Optional. The maximum vertical resolution of the encoded video.

          • OptionalvideoBitRate: number

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

          • OptionalsubtitleStreamIndex: number

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

          • OptionalsubtitleMethod: SubtitleDeliveryMethod

            Optional. Specify the subtitle delivery method.

          • OptionalmaxRefFrames: number

            Optional.

          • OptionalmaxVideoBitDepth: number

            Optional. The maximum video bit depth.

          • OptionalrequireAvc: boolean

            Optional. Whether to require avc.

          • OptionaldeInterlace: boolean

            Optional. Whether to deinterlace the video.

          • OptionalrequireNonAnamorphic: boolean

            Optional. Whether to require a non anamorphic stream.

          • OptionaltranscodingMaxAudioChannels: number

            Optional. The maximum number of audio channels to transcode.

          • OptionalcpuCoreLimit: number

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

          • OptionalliveStreamId: string

            The live stream id.

          • OptionalenableMpegtsM2TsMode: boolean

            Optional. Whether to enable the MpegtsM2Ts mode.

          • OptionalvideoCodec: string

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

          • OptionalsubtitleCodec: string

            Optional. Specify a subtitle codec to encode to.

          • OptionaltranscodeReasons: string

            Optional. The transcoding reason.

          • OptionalaudioStreamIndex: number

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

          • OptionalvideoStreamIndex: number

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

          • Optionalcontext: EncodingContext

            Optional. The MediaBrowser.Model.Dlna.EncodingContext.

          • OptionalstreamOptions: {
                [key: string]: string;
            }

            Optional. The streaming options.

            • [key: string]: string
          • OptionalenableAdaptiveBitrateStreaming: boolean

            Enable adaptive bitrate streaming.

          • OptionalenableTrickplay: boolean

            Enable trickplay image playlists being added to master playlist.

          • OptionalenableAudioVbrEncoding: boolean

            Whether to enable Audio Encoding.

          • OptionalalwaysBurnInSubtitleWhenTranscoding: boolean

            Whether to always burn in subtitles when transcoding.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>