@jellyfin/sdk 0.0.0-unstable.202212091849

package/lib/generated-client/api/hls-segment-api.js

@@ -0,0 +1,426 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI } from '../base';
+/**
+ * HlsSegmentApi - axios parameter creator
+ * @export
+ */
+export const HlsSegmentApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary Gets the specified audio segment for an audio item.
+         * @param {string} itemId The item id.
+         * @param {string} segmentId The segment id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsAudioSegmentLegacyAac: (itemId, segmentId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'itemId' is not null or undefined
+            assertParamExists('getHlsAudioSegmentLegacyAac', 'itemId', itemId);
+            // verify required parameter 'segmentId' is not null or undefined
+            assertParamExists('getHlsAudioSegmentLegacyAac', 'segmentId', segmentId);
+            const localVarPath = `/Audio/{itemId}/hls/{segmentId}/stream.aac`
+                .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)))
+                .replace(`{${"segmentId"}}`, encodeURIComponent(String(segmentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Gets the specified audio segment for an audio item.
+         * @param {string} itemId The item id.
+         * @param {string} segmentId The segment id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsAudioSegmentLegacyMp3: (itemId, segmentId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'itemId' is not null or undefined
+            assertParamExists('getHlsAudioSegmentLegacyMp3', 'itemId', itemId);
+            // verify required parameter 'segmentId' is not null or undefined
+            assertParamExists('getHlsAudioSegmentLegacyMp3', 'segmentId', segmentId);
+            const localVarPath = `/Audio/{itemId}/hls/{segmentId}/stream.mp3`
+                .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)))
+                .replace(`{${"segmentId"}}`, encodeURIComponent(String(segmentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Gets a hls video playlist.
+         * @param {string} itemId The video id.
+         * @param {string} playlistId The playlist id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsPlaylistLegacy: (itemId, playlistId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'itemId' is not null or undefined
+            assertParamExists('getHlsPlaylistLegacy', 'itemId', itemId);
+            // verify required parameter 'playlistId' is not null or undefined
+            assertParamExists('getHlsPlaylistLegacy', 'playlistId', playlistId);
+            const localVarPath = `/Videos/{itemId}/hls/{playlistId}/stream.m3u8`
+                .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)))
+                .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication CustomAuthentication required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Gets a hls video segment.
+         * @param {string} itemId The item id.
+         * @param {string} playlistId The playlist id.
+         * @param {string} segmentId The segment id.
+         * @param {string} segmentContainer The segment container.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsVideoSegmentLegacy: (itemId, playlistId, segmentId, segmentContainer, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'itemId' is not null or undefined
+            assertParamExists('getHlsVideoSegmentLegacy', 'itemId', itemId);
+            // verify required parameter 'playlistId' is not null or undefined
+            assertParamExists('getHlsVideoSegmentLegacy', 'playlistId', playlistId);
+            // verify required parameter 'segmentId' is not null or undefined
+            assertParamExists('getHlsVideoSegmentLegacy', 'segmentId', segmentId);
+            // verify required parameter 'segmentContainer' is not null or undefined
+            assertParamExists('getHlsVideoSegmentLegacy', 'segmentContainer', segmentContainer);
+            const localVarPath = `/Videos/{itemId}/hls/{playlistId}/{segmentId}.{segmentContainer}`
+                .replace(`{${"itemId"}}`, encodeURIComponent(String(itemId)))
+                .replace(`{${"playlistId"}}`, encodeURIComponent(String(playlistId)))
+                .replace(`{${"segmentId"}}`, encodeURIComponent(String(segmentId)))
+                .replace(`{${"segmentContainer"}}`, encodeURIComponent(String(segmentContainer)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Stops an active encoding.
+         * @param {string} deviceId The device id of the client requesting. Used to stop encoding processes when needed.
+         * @param {string} playSessionId The play session id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        stopEncodingProcess: (deviceId, playSessionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'deviceId' is not null or undefined
+            assertParamExists('stopEncodingProcess', 'deviceId', deviceId);
+            // verify required parameter 'playSessionId' is not null or undefined
+            assertParamExists('stopEncodingProcess', 'playSessionId', playSessionId);
+            const localVarPath = `/Videos/ActiveEncodings`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication CustomAuthentication required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (deviceId !== undefined) {
+                localVarQueryParameter['deviceId'] = deviceId;
+            }
+            if (playSessionId !== undefined) {
+                localVarQueryParameter['playSessionId'] = playSessionId;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * HlsSegmentApi - functional programming interface
+ * @export
+ */
+export const HlsSegmentApiFp = function (configuration) {
+    const localVarAxiosParamCreator = HlsSegmentApiAxiosParamCreator(configuration);
+    return {
+        /**
+         *
+         * @summary Gets the specified audio segment for an audio item.
+         * @param {string} itemId The item id.
+         * @param {string} segmentId The segment id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsAudioSegmentLegacyAac(itemId, segmentId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getHlsAudioSegmentLegacyAac(itemId, segmentId, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Gets the specified audio segment for an audio item.
+         * @param {string} itemId The item id.
+         * @param {string} segmentId The segment id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsAudioSegmentLegacyMp3(itemId, segmentId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getHlsAudioSegmentLegacyMp3(itemId, segmentId, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Gets a hls video playlist.
+         * @param {string} itemId The video id.
+         * @param {string} playlistId The playlist id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsPlaylistLegacy(itemId, playlistId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getHlsPlaylistLegacy(itemId, playlistId, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Gets a hls video segment.
+         * @param {string} itemId The item id.
+         * @param {string} playlistId The playlist id.
+         * @param {string} segmentId The segment id.
+         * @param {string} segmentContainer The segment container.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsVideoSegmentLegacy(itemId, playlistId, segmentId, segmentContainer, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getHlsVideoSegmentLegacy(itemId, playlistId, segmentId, segmentContainer, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Stops an active encoding.
+         * @param {string} deviceId The device id of the client requesting. Used to stop encoding processes when needed.
+         * @param {string} playSessionId The play session id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        stopEncodingProcess(deviceId, playSessionId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.stopEncodingProcess(deviceId, playSessionId, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * HlsSegmentApi - factory interface
+ * @export
+ */
+export const HlsSegmentApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = HlsSegmentApiFp(configuration);
+    return {
+        /**
+         *
+         * @summary Gets the specified audio segment for an audio item.
+         * @param {string} itemId The item id.
+         * @param {string} segmentId The segment id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsAudioSegmentLegacyAac(itemId, segmentId, options) {
+            return localVarFp.getHlsAudioSegmentLegacyAac(itemId, segmentId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Gets the specified audio segment for an audio item.
+         * @param {string} itemId The item id.
+         * @param {string} segmentId The segment id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsAudioSegmentLegacyMp3(itemId, segmentId, options) {
+            return localVarFp.getHlsAudioSegmentLegacyMp3(itemId, segmentId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Gets a hls video playlist.
+         * @param {string} itemId The video id.
+         * @param {string} playlistId The playlist id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsPlaylistLegacy(itemId, playlistId, options) {
+            return localVarFp.getHlsPlaylistLegacy(itemId, playlistId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Gets a hls video segment.
+         * @param {string} itemId The item id.
+         * @param {string} playlistId The playlist id.
+         * @param {string} segmentId The segment id.
+         * @param {string} segmentContainer The segment container.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getHlsVideoSegmentLegacy(itemId, playlistId, segmentId, segmentContainer, options) {
+            return localVarFp.getHlsVideoSegmentLegacy(itemId, playlistId, segmentId, segmentContainer, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Stops an active encoding.
+         * @param {string} deviceId The device id of the client requesting. Used to stop encoding processes when needed.
+         * @param {string} playSessionId The play session id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        stopEncodingProcess(deviceId, playSessionId, options) {
+            return localVarFp.stopEncodingProcess(deviceId, playSessionId, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * HlsSegmentApi - object-oriented interface
+ * @export
+ * @class HlsSegmentApi
+ * @extends {BaseAPI}
+ */
+export class HlsSegmentApi extends BaseAPI {
+    /**
+     *
+     * @summary Gets the specified audio segment for an audio item.
+     * @param {HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HlsSegmentApi
+     */
+    getHlsAudioSegmentLegacyAac(requestParameters, options) {
+        return HlsSegmentApiFp(this.configuration).getHlsAudioSegmentLegacyAac(requestParameters.itemId, requestParameters.segmentId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Gets the specified audio segment for an audio item.
+     * @param {HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HlsSegmentApi
+     */
+    getHlsAudioSegmentLegacyMp3(requestParameters, options) {
+        return HlsSegmentApiFp(this.configuration).getHlsAudioSegmentLegacyMp3(requestParameters.itemId, requestParameters.segmentId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Gets a hls video playlist.
+     * @param {HlsSegmentApiGetHlsPlaylistLegacyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HlsSegmentApi
+     */
+    getHlsPlaylistLegacy(requestParameters, options) {
+        return HlsSegmentApiFp(this.configuration).getHlsPlaylistLegacy(requestParameters.itemId, requestParameters.playlistId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Gets a hls video segment.
+     * @param {HlsSegmentApiGetHlsVideoSegmentLegacyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HlsSegmentApi
+     */
+    getHlsVideoSegmentLegacy(requestParameters, options) {
+        return HlsSegmentApiFp(this.configuration).getHlsVideoSegmentLegacy(requestParameters.itemId, requestParameters.playlistId, requestParameters.segmentId, requestParameters.segmentContainer, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Stops an active encoding.
+     * @param {HlsSegmentApiStopEncodingProcessRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof HlsSegmentApi
+     */
+    stopEncodingProcess(requestParameters, options) {
+        return HlsSegmentApiFp(this.configuration).stopEncodingProcess(requestParameters.deviceId, requestParameters.playSessionId, options).then((request) => request(this.axios, this.basePath));
+    }
+}