Type Alias GetVideoStreamData

type GetVideoStreamData = {
    body?: never;
    path: { itemId: string };
    query?: {
        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;
        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?: "Encode" | "Embed" | "External" | "Hls" | "Drop";
        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?: "Streaming" | "Static";
        streamOptions?: { [key: string]: string | null };
        enableAudioVbrEncoding?: boolean;
    };
    url: "/Videos/{itemId}/stream";
}

Index

Properties

body? path query? url

Properties

`Optional`body

body?: never

path

path: { itemId: string }

Type Declaration

itemId: string

The item id.

`Optional`query

query?: {
    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;
    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?: "Encode" | "Embed" | "External" | "Hls" | "Drop";
    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?: "Streaming" | "Static";
    streamOptions?: { [key: string]: string | null };
    enableAudioVbrEncoding?: boolean;
}

Type Declaration

Optionalcontainer?: 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.
Optionalstatic?: 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.

Deprecated
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. If omitted the server will auto-select using the url's extension.
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.
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?: "Encode" | "Embed" | "External" | "Hls" | "Drop"

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. If omitted the server will auto-select using the url's extension.
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?: "Streaming" | "Static"

Optional. The MediaBrowser.Model.Dlna.EncodingContext.
OptionalstreamOptions?: { [key: string]: string | null }

Optional. The streaming options.
OptionalenableAudioVbrEncoding?: boolean

Optional. Whether to enable Audio Encoding.

url

url: "/Videos/{itemId}/stream"

Type Alias GetVideoStreamData

Index

Properties

Properties

Optionalbody

path

Type Declaration

itemId: string

Optionalquery

Type Declaration

Optionalcontainer?: string

Optionalstatic?: boolean

Optionalparams?: string

Optionaltag?: string

OptionaldeviceProfileId?: string

Deprecated

OptionalplaySessionId?: string

OptionalsegmentContainer?: string

OptionalsegmentLength?: number

OptionalminSegments?: number

OptionalmediaSourceId?: string

OptionaldeviceId?: string

OptionalaudioCodec?: string

OptionalenableAutoStreamCopy?: boolean

OptionalallowVideoStreamCopy?: boolean

OptionalallowAudioStreamCopy?: boolean

OptionalaudioSampleRate?: number

OptionalmaxAudioBitDepth?: number

OptionalaudioBitRate?: number

OptionalaudioChannels?: number

OptionalmaxAudioChannels?: number

Optionalprofile?: string

Optionallevel?: string

Optionalframerate?: number

OptionalmaxFramerate?: number

OptionalcopyTimestamps?: boolean

OptionalstartTimeTicks?: number

Optionalwidth?: number

Optionalheight?: number

OptionalmaxWidth?: number

OptionalmaxHeight?: number

OptionalvideoBitRate?: number

OptionalsubtitleStreamIndex?: number

OptionalsubtitleMethod?: "Encode" | "Embed" | "External" | "Hls" | "Drop"

OptionalmaxRefFrames?: number

OptionalmaxVideoBitDepth?: number

OptionalrequireAvc?: boolean

OptionaldeInterlace?: boolean

OptionalrequireNonAnamorphic?: boolean

OptionaltranscodingMaxAudioChannels?: number

OptionalcpuCoreLimit?: number

OptionalliveStreamId?: string

OptionalenableMpegtsM2TsMode?: boolean

OptionalvideoCodec?: string

OptionalsubtitleCodec?: string

OptionaltranscodeReasons?: string

OptionalaudioStreamIndex?: number

OptionalvideoStreamIndex?: number

Optionalcontext?: "Streaming" | "Static"

OptionalstreamOptions?: { [key: string]: string | null }

OptionalenableAudioVbrEncoding?: boolean

url

Settings

On This Page

`Optional`body

`Optional`query

`Optional`container?: string

`Optional`static?: boolean

`Optional`params?: string

`Optional`tag?: string

`Optional`deviceProfileId?: string

`Optional`playSessionId?: string

`Optional`segmentContainer?: string

`Optional`segmentLength?: number

`Optional`minSegments?: number

`Optional`mediaSourceId?: string

`Optional`deviceId?: string

`Optional`audioCodec?: string

`Optional`enableAutoStreamCopy?: boolean

`Optional`allowVideoStreamCopy?: boolean

`Optional`allowAudioStreamCopy?: boolean

`Optional`audioSampleRate?: number

`Optional`maxAudioBitDepth?: number

`Optional`audioBitRate?: number

`Optional`audioChannels?: number

`Optional`maxAudioChannels?: number

`Optional`profile?: string

`Optional`level?: string

`Optional`framerate?: number

`Optional`maxFramerate?: number

`Optional`copyTimestamps?: boolean

`Optional`startTimeTicks?: number

`Optional`width?: number

`Optional`height?: number

`Optional`maxWidth?: number

`Optional`maxHeight?: number

`Optional`videoBitRate?: number

`Optional`subtitleStreamIndex?: number

`Optional`subtitleMethod?: "Encode" | "Embed" | "External" | "Hls" | "Drop"

`Optional`maxRefFrames?: number

`Optional`maxVideoBitDepth?: number

`Optional`requireAvc?: boolean

`Optional`deInterlace?: boolean

`Optional`requireNonAnamorphic?: boolean

`Optional`transcodingMaxAudioChannels?: number

`Optional`cpuCoreLimit?: number

`Optional`liveStreamId?: string

`Optional`enableMpegtsM2TsMode?: boolean

`Optional`videoCodec?: string

`Optional`subtitleCodec?: string

`Optional`transcodeReasons?: string

`Optional`audioStreamIndex?: number

`Optional`videoStreamIndex?: number

`Optional`context?: "Streaming" | "Static"

`Optional`streamOptions?: { [key: string]: string | null }

`Optional`enableAudioVbrEncoding?: boolean