@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
56 lines (55 loc) • 3.11 kB
TypeScript
import { BaseAPI } from '../../../../../../../common/BaseAPI';
import Configuration from '../../../../../../../common/Configuration';
import BitmovinResponse from '../../../../../../../models/BitmovinResponse';
import DashChunkedTextRepresentation from '../../../../../../../models/DashChunkedTextRepresentation';
import PaginationResponse from '../../../../../../../models/PaginationResponse';
import { DashChunkedTextRepresentationListQueryParams, DashChunkedTextRepresentationListQueryParamsBuilder } from './DashChunkedTextRepresentationListQueryParams';
/**
* ChunkedTextApi - object-oriented interface
* @export
* @class ChunkedTextApi
* @extends {BaseAPI}
*/
export default class ChunkedTextApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add Chunked Text Representation
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {DashChunkedTextRepresentation} dashChunkedTextRepresentation The Chunked Text Representation to be added to the adaptation set
* @throws {BitmovinError}
* @memberof ChunkedTextApi
*/
create(manifestId: string, periodId: string, adaptationsetId: string, dashChunkedTextRepresentation?: DashChunkedTextRepresentation): Promise<DashChunkedTextRepresentation>;
/**
* @summary Delete Chunked Text Representation
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {string} representationId Id of the Chunked Text Representation to be deleted
* @throws {BitmovinError}
* @memberof ChunkedTextApi
*/
delete(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<BitmovinResponse>;
/**
* @summary Chunked Text Representation Details
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {string} representationId Id of the representation
* @throws {BitmovinError}
* @memberof ChunkedTextApi
*/
get(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<DashChunkedTextRepresentation>;
/**
* @summary List all Chunked Text Representations
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof ChunkedTextApi
*/
list(manifestId: string, periodId: string, adaptationsetId: string, queryParameters?: DashChunkedTextRepresentationListQueryParams | ((q: DashChunkedTextRepresentationListQueryParamsBuilder) => DashChunkedTextRepresentationListQueryParamsBuilder)): Promise<PaginationResponse<DashChunkedTextRepresentation>>;
}