@jellyfin/sdk

/** * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * Do not edit the class manually. * * Jellyfin API * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { EncodingContext } from '../models'; import type { SubtitleDeliveryMethod } from '../models'; /** * AudioApi - axios parameter creator * @export */ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Gets an audio stream. * @param {string} itemId The item id. * @param {string} [container] The audio container. * @param {boolean} [_static] 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. * @param {string} [params] The streaming parameters. * @param {string} [tag] The tag. * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url. * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url. * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames. * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2. * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2. * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video. * @param {number} [height] Optional. The fixed vertical resolution of the encoded video. * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method. * @param {number} [maxRefFrames] Optional. * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth. * @param {boolean} [requireAvc] Optional. Whether to require avc. * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video. * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream. * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode. * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use. * @param {string} [liveStreamId] The live stream id. * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode. * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to. * @param {string} [transcodeReasons] Optional. The transcoding reason. * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used. * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used. * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAudioStream: (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; }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets an audio stream. * @param {string} itemId The item id. * @param {string} container The audio container. * @param {boolean} [_static] 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. * @param {string} [params] The streaming parameters. * @param {string} [tag] The tag. * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url. * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url. * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames. * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2. * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2. * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video. * @param {number} [height] Optional. The fixed vertical resolution of the encoded video. * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method. * @param {number} [maxRefFrames] Optional. * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth. * @param {boolean} [requireAvc] Optional. Whether to require avc. * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video. * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream. * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode. * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use. * @param {string} [liveStreamId] The live stream id. * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode. * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to. * @param {string} [transcodeReasons] Optional. The transcoding reason. * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used. * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used. * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAudioStreamByContainer: (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; }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets an audio stream. * @param {string} itemId The item id. * @param {string} [container] The audio container. * @param {boolean} [_static] 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. * @param {string} [params] The streaming parameters. * @param {string} [tag] The tag. * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url. * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url. * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames. * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2. * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2. * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video. * @param {number} [height] Optional. The fixed vertical resolution of the encoded video. * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method. * @param {number} [maxRefFrames] Optional. * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth. * @param {boolean} [requireAvc] Optional. Whether to require avc. * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video. * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream. * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode. * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use. * @param {string} [liveStreamId] The live stream id. * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode. * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to. * @param {string} [transcodeReasons] Optional. The transcoding reason. * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used. * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used. * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding. * @param {*} [options] Override http request option. * @throws {RequiredError} */ headAudioStream: (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; }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Gets an audio stream. * @param {string} itemId The item id. * @param {string} container The audio container. * @param {boolean} [_static] 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. * @param {string} [params] The streaming parameters. * @param {string} [tag] The tag. * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url. * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url. * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames. * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2. * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2. * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video. * @param {number} [height] Optional. The fixed vertical resolution of the encoded video. * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method. * @param {number} [maxRefFrames] Optional. * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth. * @param {boolean} [requireAvc] Optional. Whether to require avc. * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video. * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream. * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode. * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use. * @param {string} [liveStreamId] The live stream id. * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode. * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to. * @param {string} [transcodeReasons] Optional. The transcoding reason. * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used. * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used. * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding. * @param {*} [options] Override http request option. * @throws {RequiredError} */ headAudioStreamByContainer: (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; }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * AudioApi - functional programming interface * @export */ export declare const AudioApiFp: (configuration?: Configuration) => { /** * * @summary Gets an audio stream. * @param {string} itemId The item id. * @param {string} [container] The audio container. * @param {boolean} [_static] 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. * @param {string} [params] The streaming parameters. * @param {string} [tag] The tag. * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url. * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url. * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames. * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2. * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2. * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video. * @param {number} [height] Optional. The fixed vertical resolution of the encoded video. * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method. * @param {number} [maxRefFrames] Optional. * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth. * @param {boolean} [requireAvc] Optional. Whether to require avc. * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video. * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream. * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode. * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use. * @param {string} [liveStreamId] The live stream id. * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode. * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to. * @param {string} [transcodeReasons] Optional. The transcoding reason. * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used. * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used. * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAudioStream(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; }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>; /** * * @summary Gets an audio stream. * @param {string} itemId The item id. * @param {string} container The audio container. * @param {boolean} [_static] 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. * @param {string} [params] The streaming parameters. * @param {string} [tag] The tag. * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url. * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url. * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames. * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2. * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2. * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video. * @param {number} [height] Optional. The fixed vertical resolution of the encoded video. * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method. * @param {number} [maxRefFrames] Optional. * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth. * @param {boolean} [requireAvc] Optional. Whether to require avc. * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video. * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamporphic stream. * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode. * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use. * @param {string} [liveStreamId] The live stream id. * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode. * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to. * @param {string} [transcodeReasons] Optional. The transcoding reason. * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used. * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used. * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAudioStreamByContainer(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; }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>; /** * * @summary Gets an audio stream. * @param {string} itemId The item id. * @param {string} [container] The audio container. * @param {boolean} [_static] 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. * @param {string} [params] The streaming parameters. * @param {string} [tag] The tag. * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url. * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url. * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames. * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2. * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2. * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high. * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1. * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements. * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false. * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms. * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video. * @param {number} [height] Optional. The fixed vertical resolution of the encoded video. * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method. * @param {number} [maxRefFrames] Optional. * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth. * @param {boolean} [requireAvc] Optional. Whether to require avc. * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video. * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream. * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode. * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use. * @param {string} [liveStreamId] The live stream id. * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode. * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\'s extension. * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to. * @param {string} [transcodeReasons] Optional. The transcoding reason. * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used. * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used. * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext. * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options. * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding. * @param {*} [options] Override http request option. * @throws {RequiredError} */ headAudioStream(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; }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>; /** * * @summary Gets an audio stream. * @param {string} itemId The item id. * @param {string} container The audio container. * @param {boolean} [_static] 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. * @param {string} [params] The streaming parameters. * @param {string} [tag] The tag. * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize. * @param {string} [playSessionId] The play session id. * @param {string} [segmentContainer] The segment container. * @param {number} [segmentLength] The segment length. * @param {number} [minSegments] The minimum number of segments. * @param {string} [mediaSourceId] The media version id, if playing an alternate version. * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed. * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\'s extension. * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url. * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url. * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames. * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100. * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth. * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2. * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to