Function AudioApiAxiosParamCreator

AudioApi - axios parameter creator

Export

AudioApiAxiosParamCreator(configuration?): {
    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>);
    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>);
    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>);
    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>);
}
Parameters
- Optionalconfiguration: Configuration
Returns {
    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>);
    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>);
    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>);
    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>);
}
- 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.
  
  Throws
  - - (itemId, container?, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, mediaSourceId?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAudioVbrEncoding?, options?): Promise<RequestArgs>
    - Parameters
      itemId: string
      The item id.
      
      Optionalcontainer: string
      The audio container.
      
      Optional_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.
      
      Optionalparams: string
      The streaming parameters.
      
      Optionaltag: string
      The tag.
      
      OptionaldeviceProfileId: string
      Optional. The dlna device profile id to utilize.
      
      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.
      
      OptionalbreakOnNonKeyFrames: boolean
      Optional. Whether to break on non key frames.
      
      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.
      
      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: SubtitleDeliveryMethod
      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: EncodingContext
      Optional. The MediaBrowser.Model.Dlna.EncodingContext.
      
      OptionalstreamOptions: {
      [key: string]: string;
      }
      Optional. The streaming options.
      
      [key: string]: string
      OptionalenableAudioVbrEncoding: boolean
      Optional. Whether to enable Audio Encoding.
      
      Optionaloptions: RawAxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- 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.
  
  Throws
  - - (itemId, container, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, mediaSourceId?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAudioVbrEncoding?, options?): Promise<RequestArgs>
    - Parameters
      itemId: string
      The item id.
      
      container: string
      The audio container.
      
      Optional_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.
      
      Optionalparams: string
      The streaming parameters.
      
      Optionaltag: string
      The tag.
      
      OptionaldeviceProfileId: string
      Optional. The dlna device profile id to utilize.
      
      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.
      
      OptionalbreakOnNonKeyFrames: boolean
      Optional. Whether to break on non key frames.
      
      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.
      
      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: SubtitleDeliveryMethod
      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 anamporphic 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: EncodingContext
      Optional. The MediaBrowser.Model.Dlna.EncodingContext.
      
      OptionalstreamOptions: {
      [key: string]: string;
      }
      Optional. The streaming options.
      
      [key: string]: string
      OptionalenableAudioVbrEncoding: boolean
      Optional. Whether to enable Audio Encoding.
      
      Optionaloptions: RawAxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- 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.
  
  Throws
  - - (itemId, container?, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, mediaSourceId?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAudioVbrEncoding?, options?): Promise<RequestArgs>
    - Parameters
      itemId: string
      The item id.
      
      Optionalcontainer: string
      The audio container.
      
      Optional_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.
      
      Optionalparams: string
      The streaming parameters.
      
      Optionaltag: string
      The tag.
      
      OptionaldeviceProfileId: string
      Optional. The dlna device profile id to utilize.
      
      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.
      
      OptionalbreakOnNonKeyFrames: boolean
      Optional. Whether to break on non key frames.
      
      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.
      
      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: SubtitleDeliveryMethod
      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: EncodingContext
      Optional. The MediaBrowser.Model.Dlna.EncodingContext.
      
      OptionalstreamOptions: {
      [key: string]: string;
      }
      Optional. The streaming options.
      
      [key: string]: string
      OptionalenableAudioVbrEncoding: boolean
      Optional. Whether to enable Audio Encoding.
      
      Optionaloptions: RawAxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- 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>)
  Summary
  Gets an audio stream.
  
  Throws
  - - (itemId, container, _static?, params?, tag?, deviceProfileId?, playSessionId?, segmentContainer?, segmentLength?, minSegments?, mediaSourceId?, deviceId?, audioCodec?, enableAutoStreamCopy?, allowVideoStreamCopy?, allowAudioStreamCopy?, breakOnNonKeyFrames?, audioSampleRate?, maxAudioBitDepth?, audioBitRate?, audioChannels?, maxAudioChannels?, profile?, level?, framerate?, maxFramerate?, copyTimestamps?, startTimeTicks?, width?, height?, videoBitRate?, subtitleStreamIndex?, subtitleMethod?, maxRefFrames?, maxVideoBitDepth?, requireAvc?, deInterlace?, requireNonAnamorphic?, transcodingMaxAudioChannels?, cpuCoreLimit?, liveStreamId?, enableMpegtsM2TsMode?, videoCodec?, subtitleCodec?, transcodeReasons?, audioStreamIndex?, videoStreamIndex?, context?, streamOptions?, enableAudioVbrEncoding?, options?): Promise<RequestArgs>
    - Parameters
      itemId: string
      The item id.
      
      container: string
      The audio container.
      
      Optional_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.
      
      Optionalparams: string
      The streaming parameters.
      
      Optionaltag: string
      The tag.
      
      OptionaldeviceProfileId: string
      Optional. The dlna device profile id to utilize.
      
      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.
      
      OptionalbreakOnNonKeyFrames: boolean
      Optional. Whether to break on non key frames.
      
      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.
      
      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: SubtitleDeliveryMethod
      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 anamporphic 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: EncodingContext
      Optional. The MediaBrowser.Model.Dlna.EncodingContext.
      
      OptionalstreamOptions: {
      [key: string]: string;
      }
      Optional. The streaming options.
      
      [key: string]: string
      OptionalenableAudioVbrEncoding: boolean
      Optional. Whether to enable Audio Encoding.
      
      Optionaloptions: RawAxiosRequestConfig = {}
      Override http request option.
      Returns Promise<RequestArgs>
- Defined in generated-client/api/audio-api.ts:31

Function AudioApiAxiosParamCreator

Export

Parameters

Summary

Throws

Parameters

[key: string]: string

Returns Promise<RequestArgs>

Summary

Throws

Parameters

[key: string]: string

Returns Promise<RequestArgs>

Summary

Throws

Parameters

[key: string]: string

Returns Promise<RequestArgs>

Summary

Throws

Parameters

[key: string]: string

Returns Promise<RequestArgs>

Settings