@jellyfin/sdk 0.9.0 → 0.11.0

package/lib/generated-client/api/media-info-api.d.ts

@@ -8,13 +8,13 @@
  * 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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { Configuration } from '../configuration';
-import { RequestArgs, BaseAPI } from '../base';
-import { LiveStreamResponse } from '../models';
-import { OpenLiveStreamDto } from '../models';
-import { PlaybackInfoDto } from '../models';
-import { PlaybackInfoResponse } from '../models';
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { LiveStreamResponse } from '../models';
+import type { OpenLiveStreamDto } from '../models';
+import type { PlaybackInfoDto } from '../models';
+import type { PlaybackInfoResponse } from '../models';
 /**
  * MediaInfoApi - axios parameter creator
  * @export
@@ -27,7 +27,7 @@ export declare const MediaInfoApiAxiosParamCreator: (configuration?: Configurati
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    closeLiveStream: (liveStreamId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    closeLiveStream: (liveStreamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Tests the network with a request with the size of the bitrate.
@@ -35,7 +35,7 @@ export declare const MediaInfoApiAxiosParamCreator: (configuration?: Configurati
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getBitrateTestBytes: (size?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getBitrateTestBytes: (size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Gets live playback media info for an item.
@@ -44,7 +44,7 @@ export declare const MediaInfoApiAxiosParamCreator: (configuration?: Configurati
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPlaybackInfo: (itemId: string, userId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPlaybackInfo: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.  Query parameters are obsolete.
      * @summary Gets live playback media info for an item.
@@ -67,7 +67,7 @@ export declare const MediaInfoApiAxiosParamCreator: (configuration?: Configurati
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPostedPlaybackInfo: (itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPostedPlaybackInfo: (itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Opens a media source.
@@ -82,11 +82,12 @@ export declare const MediaInfoApiAxiosParamCreator: (configuration?: Configurati
      * @param {string} [itemId] The item id.
      * @param {boolean} [enableDirectPlay] Whether to enable direct play. Default: true.
      * @param {boolean} [enableDirectStream] Whether to enable direct stream. Default: true.
+     * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Always burn-in subtitle when transcoding.
      * @param {OpenLiveStreamDto} [openLiveStreamDto] The open live stream dto.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    openLiveStream: (openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    openLiveStream: (openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * MediaInfoApi - functional programming interface
@@ -100,7 +101,7 @@ export declare const MediaInfoApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    closeLiveStream(liveStreamId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    closeLiveStream(liveStreamId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
      * @summary Tests the network with a request with the size of the bitrate.
@@ -108,7 +109,7 @@ export declare const MediaInfoApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getBitrateTestBytes(size?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    getBitrateTestBytes(size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      *
      * @summary Gets live playback media info for an item.
@@ -117,7 +118,7 @@ export declare const MediaInfoApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPlaybackInfo(itemId: string, userId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>;
+    getPlaybackInfo(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>;
     /**
      * For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.  Query parameters are obsolete.
      * @summary Gets live playback media info for an item.
@@ -140,7 +141,7 @@ export declare const MediaInfoApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPostedPlaybackInfo(itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>;
+    getPostedPlaybackInfo(itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>;
     /**
      *
      * @summary Opens a media source.
@@ -155,11 +156,12 @@ export declare const MediaInfoApiFp: (configuration?: Configuration) => {
      * @param {string} [itemId] The item id.
      * @param {boolean} [enableDirectPlay] Whether to enable direct play. Default: true.
      * @param {boolean} [enableDirectStream] Whether to enable direct stream. Default: true.
+     * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Always burn-in subtitle when transcoding.
      * @param {OpenLiveStreamDto} [openLiveStreamDto] The open live stream dto.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    openLiveStream(openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveStreamResponse>>;
+    openLiveStream(openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveStreamResponse>>;
 };
 /**
  * MediaInfoApi - factory interface
@@ -169,70 +171,43 @@ export declare const MediaInfoApiFactory: (configuration?: Configuration, basePa
     /**
      *
      * @summary Closes a media source.
-     * @param {string} liveStreamId The livestream id.
+     * @param {MediaInfoApiCloseLiveStreamRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    closeLiveStream(liveStreamId: string, options?: any): AxiosPromise<void>;
+    closeLiveStream(requestParameters: MediaInfoApiCloseLiveStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
      * @summary Tests the network with a request with the size of the bitrate.
-     * @param {number} [size] The bitrate. Defaults to 102400.
+     * @param {MediaInfoApiGetBitrateTestBytesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getBitrateTestBytes(size?: number, options?: any): AxiosPromise<any>;
+    getBitrateTestBytes(requestParameters?: MediaInfoApiGetBitrateTestBytesRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      *
      * @summary Gets live playback media info for an item.
-     * @param {string} itemId The item id.
-     * @param {string} [userId] The user id.
+     * @param {MediaInfoApiGetPlaybackInfoRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPlaybackInfo(itemId: string, userId?: string, options?: any): AxiosPromise<PlaybackInfoResponse>;
+    getPlaybackInfo(requestParameters: MediaInfoApiGetPlaybackInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaybackInfoResponse>;
     /**
      * For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.  Query parameters are obsolete.
      * @summary Gets live playback media info for an item.
-     * @param {string} itemId The item id.
-     * @param {string} [userId] The user id.
-     * @param {number} [maxStreamingBitrate] The maximum streaming bitrate.
-     * @param {number} [startTimeTicks] The start time in ticks.
-     * @param {number} [audioStreamIndex] The audio stream index.
-     * @param {number} [subtitleStreamIndex] The subtitle stream index.
-     * @param {number} [maxAudioChannels] The maximum number of audio channels.
-     * @param {string} [mediaSourceId] The media source id.
-     * @param {string} [liveStreamId] The livestream id.
-     * @param {boolean} [autoOpenLiveStream] Whether to auto open the livestream.
-     * @param {boolean} [enableDirectPlay] Whether to enable direct play. Default: true.
-     * @param {boolean} [enableDirectStream] Whether to enable direct stream. Default: true.
-     * @param {boolean} [enableTranscoding] Whether to enable transcoding. Default: true.
-     * @param {boolean} [allowVideoStreamCopy] Whether to allow to copy the video stream. Default: true.
-     * @param {boolean} [allowAudioStreamCopy] Whether to allow to copy the audio stream. Default: true.
-     * @param {PlaybackInfoDto} [playbackInfoDto] The playback info.
+     * @param {MediaInfoApiGetPostedPlaybackInfoRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getPostedPlaybackInfo(itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any): AxiosPromise<PlaybackInfoResponse>;
+    getPostedPlaybackInfo(requestParameters: MediaInfoApiGetPostedPlaybackInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaybackInfoResponse>;
     /**
      *
      * @summary Opens a media source.
-     * @param {string} [openToken] The open token.
-     * @param {string} [userId] The user id.
-     * @param {string} [playSessionId] The play session id.
-     * @param {number} [maxStreamingBitrate] The maximum streaming bitrate.
-     * @param {number} [startTimeTicks] The start time in ticks.
-     * @param {number} [audioStreamIndex] The audio stream index.
-     * @param {number} [subtitleStreamIndex] The subtitle stream index.
-     * @param {number} [maxAudioChannels] The maximum number of audio channels.
-     * @param {string} [itemId] The item id.
-     * @param {boolean} [enableDirectPlay] Whether to enable direct play. Default: true.
-     * @param {boolean} [enableDirectStream] Whether to enable direct stream. Default: true.
-     * @param {OpenLiveStreamDto} [openLiveStreamDto] The open live stream dto.
+     * @param {MediaInfoApiOpenLiveStreamRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    openLiveStream(openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any): AxiosPromise<LiveStreamResponse>;
+    openLiveStream(requestParameters?: MediaInfoApiOpenLiveStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<LiveStreamResponse>;
 };
 /**
  * Request parameters for closeLiveStream operation in MediaInfoApi.
@@ -454,6 +429,12 @@ export interface MediaInfoApiOpenLiveStreamRequest {
      * @memberof MediaInfoApiOpenLiveStream
      */
     readonly enableDirectStream?: boolean;
+    /**
+     * Always burn-in subtitle when transcoding.
+     * @type {boolean}
+     * @memberof MediaInfoApiOpenLiveStream
+     */
+    readonly alwaysBurnInSubtitleWhenTranscoding?: boolean;
     /**
      * The open live stream dto.
      * @type {OpenLiveStreamDto}
@@ -476,7 +457,7 @@ export declare class MediaInfoApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof MediaInfoApi
      */
-    closeLiveStream(requestParameters: MediaInfoApiCloseLiveStreamRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    closeLiveStream(requestParameters: MediaInfoApiCloseLiveStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      *
      * @summary Tests the network with a request with the size of the bitrate.
@@ -485,7 +466,7 @@ export declare class MediaInfoApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof MediaInfoApi
      */
-    getBitrateTestBytes(requestParameters?: MediaInfoApiGetBitrateTestBytesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
+    getBitrateTestBytes(requestParameters?: MediaInfoApiGetBitrateTestBytesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
     /**
      *
      * @summary Gets live playback media info for an item.
@@ -494,7 +475,7 @@ export declare class MediaInfoApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof MediaInfoApi
      */
-    getPlaybackInfo(requestParameters: MediaInfoApiGetPlaybackInfoRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PlaybackInfoResponse, any>>;
+    getPlaybackInfo(requestParameters: MediaInfoApiGetPlaybackInfoRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlaybackInfoResponse, any>>;
     /**
      * For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence.  Query parameters are obsolete.
      * @summary Gets live playback media info for an item.
@@ -503,7 +484,7 @@ export declare class MediaInfoApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof MediaInfoApi
      */
-    getPostedPlaybackInfo(requestParameters: MediaInfoApiGetPostedPlaybackInfoRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PlaybackInfoResponse, any>>;
+    getPostedPlaybackInfo(requestParameters: MediaInfoApiGetPostedPlaybackInfoRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlaybackInfoResponse, any>>;
     /**
      *
      * @summary Opens a media source.
@@ -512,5 +493,5 @@ export declare class MediaInfoApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof MediaInfoApi
      */
-    openLiveStream(requestParameters?: MediaInfoApiOpenLiveStreamRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveStreamResponse, any>>;
+    openLiveStream(requestParameters?: MediaInfoApiOpenLiveStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveStreamResponse, any>>;
 }