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