Interface AudioApiGetAudioStreamRequest

Request parameters for getAudioStream operation in AudioApi.

Export

AudioApiGetAudioStreamRequest

interface AudioApiGetAudioStreamRequest {
    _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;
    maxRefFrames?: number;
    maxVideoBitDepth?: 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

_static? allowAudioStreamCopy? allowVideoStreamCopy? audioBitRate? audioChannels? audioCodec? audioSampleRate? audioStreamIndex? breakOnNonKeyFrames? container? context? copyTimestamps? cpuCoreLimit? deInterlace? deviceId? deviceProfileId? enableAudioVbrEncoding? enableAutoStreamCopy? enableMpegtsM2TsMode? framerate? height? itemId level? liveStreamId? maxAudioBitDepth? maxAudioChannels? maxFramerate? maxRefFrames? maxVideoBitDepth? 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

AudioApiGetAudioStream

Optional ReadonlyallowAudioStreamCopy

allowAudioStreamCopy?: boolean

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

Memberof

AudioApiGetAudioStream

Optional ReadonlyallowVideoStreamCopy

allowVideoStreamCopy?: boolean

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

Memberof

AudioApiGetAudioStream

Optional ReadonlyaudioBitRate

audioBitRate?: number

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

Memberof

AudioApiGetAudioStream

Optional ReadonlyaudioChannels

audioChannels?: number

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

Memberof

AudioApiGetAudioStream

Optional ReadonlyaudioCodec

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

AudioApiGetAudioStream

Optional ReadonlyaudioSampleRate

audioSampleRate?: number

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

Memberof

AudioApiGetAudioStream

Optional ReadonlyaudioStreamIndex

audioStreamIndex?: number

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

Memberof

AudioApiGetAudioStream

Optional ReadonlybreakOnNonKeyFrames

breakOnNonKeyFrames?: boolean

Optional. Whether to break on non key frames.

Memberof

AudioApiGetAudioStream

Optional Readonlycontainer

container?: string

The audio container.

Memberof

AudioApiGetAudioStream

Optional Readonlycontext

context?: EncodingContext

Optional. The MediaBrowser.Model.Dlna.EncodingContext.

Memberof

AudioApiGetAudioStream

Optional ReadonlycopyTimestamps

copyTimestamps?: boolean

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

Memberof

AudioApiGetAudioStream

Optional ReadonlycpuCoreLimit

cpuCoreLimit?: number

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

Memberof

AudioApiGetAudioStream

Optional ReadonlydeInterlace

deInterlace?: boolean

Optional. Whether to deinterlace the video.

Memberof

AudioApiGetAudioStream

Optional ReadonlydeviceId

deviceId?: string

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

Memberof

AudioApiGetAudioStream

Optional ReadonlydeviceProfileId

deviceProfileId?: string

Optional. The dlna device profile id to utilize.

Memberof

AudioApiGetAudioStream

Optional ReadonlyenableAudioVbrEncoding

enableAudioVbrEncoding?: boolean

Optional. Whether to enable Audio Encoding.

Memberof

AudioApiGetAudioStream

Optional ReadonlyenableAutoStreamCopy

enableAutoStreamCopy?: boolean

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

Memberof

AudioApiGetAudioStream

Optional ReadonlyenableMpegtsM2TsMode

enableMpegtsM2TsMode?: boolean

Optional. Whether to enable the MpegtsM2Ts mode.

Memberof

AudioApiGetAudioStream

Optional Readonlyframerate

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

AudioApiGetAudioStream

Optional Readonlyheight

height?: number

Optional. The fixed vertical resolution of the encoded video.

Memberof

AudioApiGetAudioStream

ReadonlyitemId

itemId: string

The item id.

Memberof

AudioApiGetAudioStream

Optional Readonlylevel

level?: string

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

Memberof

AudioApiGetAudioStream

Optional ReadonlyliveStreamId

liveStreamId?: string

The live stream id.

Memberof

AudioApiGetAudioStream

Optional ReadonlymaxAudioBitDepth

maxAudioBitDepth?: number

Optional. The maximum audio bit depth.

Memberof

AudioApiGetAudioStream

Optional ReadonlymaxAudioChannels

maxAudioChannels?: number

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

Memberof

AudioApiGetAudioStream

Optional ReadonlymaxFramerate

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

AudioApiGetAudioStream

Optional ReadonlymaxRefFrames

maxRefFrames?: number

Optional.

Memberof

AudioApiGetAudioStream

Optional ReadonlymaxVideoBitDepth

maxVideoBitDepth?: number

Optional. The maximum video bit depth.

Memberof

AudioApiGetAudioStream

Optional ReadonlymediaSourceId

mediaSourceId?: string

The media version id, if playing an alternate version.

Memberof

AudioApiGetAudioStream

Optional ReadonlyminSegments

minSegments?: number

The minimum number of segments.

Memberof

AudioApiGetAudioStream

Optional Readonlyparams

params?: string

The streaming parameters.

Memberof

AudioApiGetAudioStream

Optional ReadonlyplaySessionId

playSessionId?: string

The play session id.

Memberof

AudioApiGetAudioStream

Optional Readonlyprofile

profile?: string

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

Memberof

AudioApiGetAudioStream

Optional ReadonlyrequireAvc

requireAvc?: boolean

Optional. Whether to require avc.

Memberof

AudioApiGetAudioStream

Optional ReadonlyrequireNonAnamorphic

requireNonAnamorphic?: boolean

Optional. Whether to require a non anamorphic stream.

Memberof

AudioApiGetAudioStream

Optional ReadonlysegmentContainer

segmentContainer?: string

The segment container.

Memberof

AudioApiGetAudioStream

Optional ReadonlysegmentLength

segmentLength?: number

The segment length.

Memberof

AudioApiGetAudioStream

Optional ReadonlystartTimeTicks

startTimeTicks?: number

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

Memberof

AudioApiGetAudioStream

Optional ReadonlystreamOptions

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

Optional. The streaming options.

Memberof

AudioApiGetAudioStream

Optional ReadonlysubtitleCodec

subtitleCodec?: string

Optional. Specify a subtitle codec to encode to.

Memberof

AudioApiGetAudioStream

Optional ReadonlysubtitleMethod

subtitleMethod?: SubtitleDeliveryMethod

Optional. Specify the subtitle delivery method.

Memberof

AudioApiGetAudioStream

Optional ReadonlysubtitleStreamIndex

subtitleStreamIndex?: number

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

Memberof

AudioApiGetAudioStream

Optional Readonlytag

tag?: string

The tag.

Memberof

AudioApiGetAudioStream

Optional ReadonlytranscodeReasons

transcodeReasons?: string

Optional. The transcoding reason.

Memberof

AudioApiGetAudioStream

Optional ReadonlytranscodingMaxAudioChannels

transcodingMaxAudioChannels?: number

Optional. The maximum number of audio channels to transcode.

Memberof

AudioApiGetAudioStream

Optional ReadonlyvideoBitRate

videoBitRate?: number

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

Memberof

AudioApiGetAudioStream

Optional ReadonlyvideoCodec

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

AudioApiGetAudioStream

Optional ReadonlyvideoStreamIndex

videoStreamIndex?: number

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

Memberof

AudioApiGetAudioStream

Optional Readonlywidth

width?: number

Optional. The fixed horizontal resolution of the encoded video.

Memberof

AudioApiGetAudioStream

Settings

Member Visibility

On This Page

Properties