@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
48 lines (47 loc) • 2.15 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import SubtitlesMediaInfo from '../../../../../models/SubtitlesMediaInfo';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { SubtitlesMediaInfoListQueryParams, SubtitlesMediaInfoListQueryParamsBuilder } from './SubtitlesMediaInfoListQueryParams';
/**
* SubtitlesApi - object-oriented interface
* @export
* @class SubtitlesApi
* @extends {BaseAPI}
*/
export default class SubtitlesApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add Subtitles Media
* @param {string} manifestId Id of the hls manifest.
* @param {SubtitlesMediaInfo} subtitlesMediaInfo The Subtitles Media to be added
* @throws {BitmovinError}
* @memberof SubtitlesApi
*/
create(manifestId: string, subtitlesMediaInfo?: SubtitlesMediaInfo): Promise<SubtitlesMediaInfo>;
/**
* @summary Delete Subtitles Media
* @param {string} manifestId Id of the hls manifest.
* @param {string} mediaId Id of the subtitles media.
* @throws {BitmovinError}
* @memberof SubtitlesApi
*/
delete(manifestId: string, mediaId: string): Promise<BitmovinResponse>;
/**
* @summary Subtitles Media Details
* @param {string} manifestId Id of the hls manifest.
* @param {string} mediaId Id of the subtitles media.
* @throws {BitmovinError}
* @memberof SubtitlesApi
*/
get(manifestId: string, mediaId: string): Promise<SubtitlesMediaInfo>;
/**
* @summary List all Subtitles Media
* @param {string} manifestId Id of the hls manifest.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof SubtitlesApi
*/
list(manifestId: string, queryParameters?: SubtitlesMediaInfoListQueryParams | ((q: SubtitlesMediaInfoListQueryParamsBuilder) => SubtitlesMediaInfoListQueryParamsBuilder)): Promise<PaginationResponse<SubtitlesMediaInfo>>;
}