@jellyfin/sdk/lib/generated-client/api/media-info-api.d.ts

A TypeScript SDK for Jellyfin.

/**
 * 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 { LiveStreamResponse } from '../models';
import type { OpenLiveStreamDto } from '../models';
import type { PlaybackInfoDto } from '../models';
import type { PlaybackInfoResponse } from '../models';
/**
 * MediaInfoApi - axios parameter creator
 * @export
 */
export declare const MediaInfoApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Closes a media source.
     * @param {string} liveStreamId The livestream id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    closeLiveStream: (liveStreamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Tests the network with a request with the size of the bitrate.
     * @param {number} [size] The bitrate. Defaults to 102400.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getBitrateTestBytes: (size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets live playback media info for an item.
     * @param {string} itemId The item id.
     * @param {string} [userId] The user id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    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.
     * @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 {*} [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?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @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 {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, alwaysBurnInSubtitleWhenTranscoding?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * MediaInfoApi - functional programming interface
 * @export
 */
export declare const MediaInfoApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Closes a media source.
     * @param {string} liveStreamId The livestream id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    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.
     * @param {number} [size] The bitrate. Defaults to 102400.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getBitrateTestBytes(size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
    /**
     *
     * @summary Gets live playback media info for an item.
     * @param {string} itemId The item id.
     * @param {string} [userId] The user id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    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.
     * @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 {*} [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?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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 {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, alwaysBurnInSubtitleWhenTranscoding?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveStreamResponse>>;
};
/**
 * MediaInfoApi - factory interface
 * @export
 */
export declare const MediaInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Closes a media source.
     * @param {MediaInfoApiCloseLiveStreamRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    closeLiveStream(requestParameters: MediaInfoApiCloseLiveStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Tests the network with a request with the size of the bitrate.
     * @param {MediaInfoApiGetBitrateTestBytesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getBitrateTestBytes(requestParameters?: MediaInfoApiGetBitrateTestBytesRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
    /**
     *
     * @summary Gets live playback media info for an item.
     * @param {MediaInfoApiGetPlaybackInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    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 {MediaInfoApiGetPostedPlaybackInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPostedPlaybackInfo(requestParameters: MediaInfoApiGetPostedPlaybackInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaybackInfoResponse>;
    /**
     *
     * @summary Opens a media source.
     * @param {MediaInfoApiOpenLiveStreamRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    openLiveStream(requestParameters?: MediaInfoApiOpenLiveStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<LiveStreamResponse>;
};
/**
 * Request parameters for closeLiveStream operation in MediaInfoApi.
 * @export
 * @interface MediaInfoApiCloseLiveStreamRequest
 */
export interface MediaInfoApiCloseLiveStreamRequest {
    /**
     * The livestream id.
     * @type {string}
     * @memberof MediaInfoApiCloseLiveStream
     */
    readonly liveStreamId: string;
}
/**
 * Request parameters for getBitrateTestBytes operation in MediaInfoApi.
 * @export
 * @interface MediaInfoApiGetBitrateTestBytesRequest
 */
export interface MediaInfoApiGetBitrateTestBytesRequest {
    /**
     * The bitrate. Defaults to 102400.
     * @type {number}
     * @memberof MediaInfoApiGetBitrateTestBytes
     */
    readonly size?: number;
}
/**
 * Request parameters for getPlaybackInfo operation in MediaInfoApi.
 * @export
 * @interface MediaInfoApiGetPlaybackInfoRequest
 */
export interface MediaInfoApiGetPlaybackInfoRequest {
    /**
     * The item id.
     * @type {string}
     * @memberof MediaInfoApiGetPlaybackInfo
     */
    readonly itemId: string;
    /**
     * The user id.
     * @type {string}
     * @memberof MediaInfoApiGetPlaybackInfo
     */
    readonly userId?: string;
}
/**
 * Request parameters for getPostedPlaybackInfo operation in MediaInfoApi.
 * @export
 * @interface MediaInfoApiGetPostedPlaybackInfoRequest
 */
export interface MediaInfoApiGetPostedPlaybackInfoRequest {
    /**
     * The item id.
     * @type {string}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly itemId: string;
    /**
     * The user id.
     * @type {string}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly userId?: string;
    /**
     * The maximum streaming bitrate.
     * @type {number}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly maxStreamingBitrate?: number;
    /**
     * The start time in ticks.
     * @type {number}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly startTimeTicks?: number;
    /**
     * The audio stream index.
     * @type {number}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly audioStreamIndex?: number;
    /**
     * The subtitle stream index.
     * @type {number}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly subtitleStreamIndex?: number;
    /**
     * The maximum number of audio channels.
     * @type {number}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly maxAudioChannels?: number;
    /**
     * The media source id.
     * @type {string}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly mediaSourceId?: string;
    /**
     * The livestream id.
     * @type {string}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly liveStreamId?: string;
    /**
     * Whether to auto open the livestream.
     * @type {boolean}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly autoOpenLiveStream?: boolean;
    /**
     * Whether to enable direct play. Default: true.
     * @type {boolean}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly enableDirectPlay?: boolean;
    /**
     * Whether to enable direct stream. Default: true.
     * @type {boolean}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly enableDirectStream?: boolean;
    /**
     * Whether to enable transcoding. Default: true.
     * @type {boolean}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly enableTranscoding?: boolean;
    /**
     * Whether to allow to copy the video stream. Default: true.
     * @type {boolean}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly allowVideoStreamCopy?: boolean;
    /**
     * Whether to allow to copy the audio stream. Default: true.
     * @type {boolean}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly allowAudioStreamCopy?: boolean;
    /**
     * The playback info.
     * @type {PlaybackInfoDto}
     * @memberof MediaInfoApiGetPostedPlaybackInfo
     */
    readonly playbackInfoDto?: PlaybackInfoDto;
}
/**
 * Request parameters for openLiveStream operation in MediaInfoApi.
 * @export
 * @interface MediaInfoApiOpenLiveStreamRequest
 */
export interface MediaInfoApiOpenLiveStreamRequest {
    /**
     * The open token.
     * @type {string}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly openToken?: string;
    /**
     * The user id.
     * @type {string}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly userId?: string;
    /**
     * The play session id.
     * @type {string}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly playSessionId?: string;
    /**
     * The maximum streaming bitrate.
     * @type {number}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly maxStreamingBitrate?: number;
    /**
     * The start time in ticks.
     * @type {number}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly startTimeTicks?: number;
    /**
     * The audio stream index.
     * @type {number}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly audioStreamIndex?: number;
    /**
     * The subtitle stream index.
     * @type {number}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly subtitleStreamIndex?: number;
    /**
     * The maximum number of audio channels.
     * @type {number}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly maxAudioChannels?: number;
    /**
     * The item id.
     * @type {string}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly itemId?: string;
    /**
     * Whether to enable direct play. Default: true.
     * @type {boolean}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly enableDirectPlay?: boolean;
    /**
     * Whether to enable direct stream. Default: true.
     * @type {boolean}
     * @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}
     * @memberof MediaInfoApiOpenLiveStream
     */
    readonly openLiveStreamDto?: OpenLiveStreamDto;
}
/**
 * MediaInfoApi - object-oriented interface
 * @export
 * @class MediaInfoApi
 * @extends {BaseAPI}
 */
export declare class MediaInfoApi extends BaseAPI {
    /**
     *
     * @summary Closes a media source.
     * @param {MediaInfoApiCloseLiveStreamRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MediaInfoApi
     */
    closeLiveStream(requestParameters: MediaInfoApiCloseLiveStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Tests the network with a request with the size of the bitrate.
     * @param {MediaInfoApiGetBitrateTestBytesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MediaInfoApi
     */
    getBitrateTestBytes(requestParameters?: MediaInfoApiGetBitrateTestBytesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
    /**
     *
     * @summary Gets live playback media info for an item.
     * @param {MediaInfoApiGetPlaybackInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MediaInfoApi
     */
    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.
     * @param {MediaInfoApiGetPostedPlaybackInfoRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MediaInfoApi
     */
    getPostedPlaybackInfo(requestParameters: MediaInfoApiGetPostedPlaybackInfoRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlaybackInfoResponse, any>>;
    /**
     *
     * @summary Opens a media source.
     * @param {MediaInfoApiOpenLiveStreamRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MediaInfoApi
     */
    openLiveStream(requestParameters?: MediaInfoApiOpenLiveStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveStreamResponse, any>>;
}