Interface DynamicHlsApiHeadMasterHlsVideoPlaylistRequest

Request parameters for headMasterHlsVideoPlaylist operation in DynamicHlsApi.

Export

DynamicHlsApiHeadMasterHlsVideoPlaylistRequest

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

Index

Properties

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

Properties

`Optional` `Readonly`_static

_static?: boolean

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`allowAudioStreamCopy

allowAudioStreamCopy?: boolean

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`allowVideoStreamCopy

allowVideoStreamCopy?: boolean

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`alwaysBurnInSubtitleWhenTranscoding

alwaysBurnInSubtitleWhenTranscoding?: boolean

Whether to always burn in subtitles when transcoding.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`audioBitRate

audioBitRate?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`audioChannels

audioChannels?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`audioCodec

audioCodec?: string

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`audioSampleRate

audioSampleRate?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`audioStreamIndex

audioStreamIndex?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`breakOnNonKeyFrames

breakOnNonKeyFrames?: boolean

Optional. Whether to break on non key frames.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`context

context?: EncodingContext

Optional. The MediaBrowser.Model.Dlna.EncodingContext.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`copyTimestamps

copyTimestamps?: boolean

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`cpuCoreLimit

cpuCoreLimit?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`deInterlace

deInterlace?: boolean

Optional. Whether to deinterlace the video.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`deviceId

deviceId?: string

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`deviceProfileId

deviceProfileId?: string

Optional. The dlna device profile id to utilize.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`enableAdaptiveBitrateStreaming

enableAdaptiveBitrateStreaming?: boolean

Enable adaptive bitrate streaming.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`enableAudioVbrEncoding

enableAudioVbrEncoding?: boolean

Whether to enable Audio Encoding.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`enableAutoStreamCopy

enableAutoStreamCopy?: boolean

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`enableMpegtsM2TsMode

enableMpegtsM2TsMode?: boolean

Optional. Whether to enable the MpegtsM2Ts mode.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`enableTrickplay

enableTrickplay?: boolean

Enable trickplay image playlists being added to master playlist.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`framerate

framerate?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`height

height?: number

Optional. The fixed vertical resolution of the encoded video.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Readonly`itemId

itemId: string

The item id.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`level

level?: string

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`liveStreamId

liveStreamId?: string

The live stream id.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`maxAudioBitDepth

maxAudioBitDepth?: number

Optional. The maximum audio bit depth.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`maxAudioChannels

maxAudioChannels?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`maxFramerate

maxFramerate?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`maxHeight

maxHeight?: number

Optional. The maximum vertical resolution of the encoded video.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`maxRefFrames

maxRefFrames?: number

Optional.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`maxVideoBitDepth

maxVideoBitDepth?: number

Optional. The maximum video bit depth.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`maxWidth

maxWidth?: number

Optional. The maximum horizontal resolution of the encoded video.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Readonly`mediaSourceId

mediaSourceId: string

The media version id, if playing an alternate version.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`minSegments

minSegments?: number

The minimum number of segments.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`params

params?: string

The streaming parameters.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`playSessionId

playSessionId?: string

The play session id.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`profile

profile?: string

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`requireAvc

requireAvc?: boolean

Optional. Whether to require avc.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`requireNonAnamorphic

requireNonAnamorphic?: boolean

Optional. Whether to require a non anamorphic stream.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`segmentContainer

segmentContainer?: string

The segment container.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`segmentLength

segmentLength?: number

The segment length.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`startTimeTicks

startTimeTicks?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`streamOptions

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

Optional. The streaming options.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`subtitleCodec

subtitleCodec?: string

Optional. Specify a subtitle codec to encode to.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`subtitleMethod

subtitleMethod?: SubtitleDeliveryMethod

Optional. Specify the subtitle delivery method.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`subtitleStreamIndex

subtitleStreamIndex?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`tag

tag?: string

The tag.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`transcodeReasons

transcodeReasons?: string

Optional. The transcoding reason.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`transcodingMaxAudioChannels

transcodingMaxAudioChannels?: number

Optional. The maximum number of audio channels to transcode.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`videoBitRate

videoBitRate?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`videoCodec

videoCodec?: string

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`videoStreamIndex

videoStreamIndex?: number

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

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist

`Optional` `Readonly`width

width?: number

Optional. The fixed horizontal resolution of the encoded video.

Memberof

DynamicHlsApiHeadMasterHlsVideoPlaylist