@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
416 lines (413 loc) • 23.4 kB
JavaScript
import globalAxios from 'axios';
import { assertParamExists, DUMMY_BASE_URL, setSearchParams, toPathString, setApiKeyToObject, createRequestFunction } from '../common.js';
import { operationServerMap, BaseAPI, BASE_PATH } from '../base.js';
/* 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/.
*/
/**
* HlsSegmentApi - axios parameter creator
* @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: async (itemId, segmentId, options = {}) => {
// 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 = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...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: async (itemId, segmentId, options = {}) => {
// 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 = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...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: async (itemId, playlistId, options = {}) => {
// 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 = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...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: async (itemId, playlistId, segmentId, segmentContainer, options = {}) => {
// 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 = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...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: async (deviceId, playSessionId, options = {}) => {
// 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 = { method: 'DELETE', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication CustomAuthentication required
await 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 = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
/**
* HlsSegmentApi - functional programming interface
* @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}
*/
async getHlsAudioSegmentLegacyAac(itemId, segmentId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getHlsAudioSegmentLegacyAac(itemId, segmentId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['HlsSegmentApi.getHlsAudioSegmentLegacyAac']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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}
*/
async getHlsAudioSegmentLegacyMp3(itemId, segmentId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getHlsAudioSegmentLegacyMp3(itemId, segmentId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['HlsSegmentApi.getHlsAudioSegmentLegacyMp3']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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}
*/
async getHlsPlaylistLegacy(itemId, playlistId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getHlsPlaylistLegacy(itemId, playlistId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['HlsSegmentApi.getHlsPlaylistLegacy']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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}
*/
async getHlsVideoSegmentLegacy(itemId, playlistId, segmentId, segmentContainer, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.getHlsVideoSegmentLegacy(itemId, playlistId, segmentId, segmentContainer, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['HlsSegmentApi.getHlsVideoSegmentLegacy']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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}
*/
async stopEncodingProcess(deviceId, playSessionId, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.stopEncodingProcess(deviceId, playSessionId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['HlsSegmentApi.stopEncodingProcess']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
};
};
/**
* HlsSegmentApi - factory interface
* @export
*/
const HlsSegmentApiFactory = function (configuration, basePath, axios) {
const localVarFp = HlsSegmentApiFp(configuration);
return {
/**
*
* @summary Gets the specified audio segment for an audio item.
* @param {HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getHlsAudioSegmentLegacyAac(requestParameters, options) {
return localVarFp.getHlsAudioSegmentLegacyAac(requestParameters.itemId, requestParameters.segmentId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets the specified audio segment for an audio item.
* @param {HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getHlsAudioSegmentLegacyMp3(requestParameters, options) {
return localVarFp.getHlsAudioSegmentLegacyMp3(requestParameters.itemId, requestParameters.segmentId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets a hls video playlist.
* @param {HlsSegmentApiGetHlsPlaylistLegacyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getHlsPlaylistLegacy(requestParameters, options) {
return localVarFp.getHlsPlaylistLegacy(requestParameters.itemId, requestParameters.playlistId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Gets a hls video segment.
* @param {HlsSegmentApiGetHlsVideoSegmentLegacyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getHlsVideoSegmentLegacy(requestParameters, options) {
return localVarFp.getHlsVideoSegmentLegacy(requestParameters.itemId, requestParameters.playlistId, requestParameters.segmentId, requestParameters.segmentContainer, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Stops an active encoding.
* @param {HlsSegmentApiStopEncodingProcessRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
stopEncodingProcess(requestParameters, options) {
return localVarFp.stopEncodingProcess(requestParameters.deviceId, requestParameters.playSessionId, options).then((request) => request(axios, basePath));
},
};
};
/**
* HlsSegmentApi - object-oriented interface
* @export
* @class HlsSegmentApi
* @extends {BaseAPI}
*/
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));
}
}
export { HlsSegmentApi, HlsSegmentApiAxiosParamCreator, HlsSegmentApiFactory, HlsSegmentApiFp };