Interface VideosApiHeadVideoStreamByContainerRequest

Request parameters for headVideoStreamByContainer operation in VideosApi.

Export

VideosApiHeadVideoStreamByContainerRequest

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

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

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`allowAudioStreamCopy

allowAudioStreamCopy?: boolean

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`allowVideoStreamCopy

allowVideoStreamCopy?: boolean

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

Memberof

VideosApiHeadVideoStreamByContainer

`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

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`audioChannels

audioChannels?: number

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`audioCodec

audioCodec?: string

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`audioSampleRate

audioSampleRate?: number

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`audioStreamIndex

audioStreamIndex?: number

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`breakOnNonKeyFrames

breakOnNonKeyFrames?: boolean

Optional. Whether to break on non key frames.

Memberof

VideosApiHeadVideoStreamByContainer

`Readonly`container

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.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`context

context?: EncodingContext

Optional. The MediaBrowser.Model.Dlna.EncodingContext.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`copyTimestamps

copyTimestamps?: boolean

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`cpuCoreLimit

cpuCoreLimit?: number

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`deInterlace

deInterlace?: boolean

Optional. Whether to deinterlace the video.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`deviceId

deviceId?: string

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`deviceProfileId

deviceProfileId?: string

Optional. The dlna device profile id to utilize.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`enableAudioVbrEncoding

enableAudioVbrEncoding?: boolean

Optional. Whether to enable Audio Encoding.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`enableAutoStreamCopy

enableAutoStreamCopy?: boolean

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`enableMpegtsM2TsMode

enableMpegtsM2TsMode?: boolean

Optional. Whether to enable the MpegtsM2Ts mode.

Memberof

VideosApiHeadVideoStreamByContainer

`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

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`height

height?: number

Optional. The fixed vertical resolution of the encoded video.

Memberof

VideosApiHeadVideoStreamByContainer

`Readonly`itemId

itemId: string

The item id.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`level

level?: string

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`liveStreamId

liveStreamId?: string

The live stream id.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`maxAudioBitDepth

maxAudioBitDepth?: number

Optional. The maximum audio bit depth.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`maxAudioChannels

maxAudioChannels?: number

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

Memberof

VideosApiHeadVideoStreamByContainer

`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

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`maxHeight

maxHeight?: number

Optional. The maximum vertical resolution of the encoded video.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`maxRefFrames

maxRefFrames?: number

Optional.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`maxVideoBitDepth

maxVideoBitDepth?: number

Optional. The maximum video bit depth.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`maxWidth

maxWidth?: number

Optional. The maximum horizontal resolution of the encoded video.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`mediaSourceId

mediaSourceId?: string

The media version id, if playing an alternate version.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`minSegments

minSegments?: number

The minimum number of segments.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`params

params?: string

The streaming parameters.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`playSessionId

playSessionId?: string

The play session id.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`profile

profile?: string

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`requireAvc

requireAvc?: boolean

Optional. Whether to require avc.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`requireNonAnamorphic

requireNonAnamorphic?: boolean

Optional. Whether to require a non anamorphic stream.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`segmentContainer

segmentContainer?: string

The segment container.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`segmentLength

segmentLength?: number

The segment length.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`startTimeTicks

startTimeTicks?: number

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`streamOptions

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

Optional. The streaming options.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`subtitleCodec

subtitleCodec?: string

Optional. Specify a subtitle codec to encode to.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`subtitleMethod

subtitleMethod?: SubtitleDeliveryMethod

Optional. Specify the subtitle delivery method.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`subtitleStreamIndex

subtitleStreamIndex?: number

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`tag

tag?: string

The tag.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`transcodeReasons

transcodeReasons?: string

Optional. The transcoding reason.

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`transcodingMaxAudioChannels

transcodingMaxAudioChannels?: number

Optional. The maximum number of audio channels to transcode.

Memberof

VideosApiHeadVideoStreamByContainer

`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

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`videoCodec

videoCodec?: string

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`videoStreamIndex

videoStreamIndex?: number

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

Memberof

VideosApiHeadVideoStreamByContainer

`Optional` `Readonly`width

width?: number

Optional. The fixed horizontal resolution of the encoded video.

Memberof

VideosApiHeadVideoStreamByContainer