@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
56 lines (55 loc) • 2.88 kB
TypeScript
import { BaseAPI } from '../../../../../../../common/BaseAPI';
import Configuration from '../../../../../../../common/Configuration';
import BitmovinResponse from '../../../../../../../models/BitmovinResponse';
import DashVttRepresentation from '../../../../../../../models/DashVttRepresentation';
import PaginationResponse from '../../../../../../../models/PaginationResponse';
import { DashVttRepresentationListQueryParams, DashVttRepresentationListQueryParamsBuilder } from './DashVttRepresentationListQueryParams';
/**
* VttApi - object-oriented interface
* @export
* @class VttApi
* @extends {BaseAPI}
*/
export default class VttApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary Add VTT Representation
* @param {string} manifestId Id of the manifest
* @param {string} periodId Id of the period
* @param {string} adaptationsetId Id of the adaptation set
* @param {DashVttRepresentation} dashVttRepresentation The VTT representation to be added to the adaptation set
* @throws {BitmovinError}
* @memberof VttApi
*/
create(manifestId: string, periodId: string, adaptationsetId: string, dashVttRepresentation?: DashVttRepresentation): Promise<DashVttRepresentation>;
/**
* @summary Delete VTT 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 VTT representation to be deleted
* @throws {BitmovinError}
* @memberof VttApi
*/
delete(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<BitmovinResponse>;
/**
* @summary VTT 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 VTT representation
* @throws {BitmovinError}
* @memberof VttApi
*/
get(manifestId: string, periodId: string, adaptationsetId: string, representationId: string): Promise<DashVttRepresentation>;
/**
* @summary List all VTT 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 VttApi
*/
list(manifestId: string, periodId: string, adaptationsetId: string, queryParameters?: DashVttRepresentationListQueryParams | ((q: DashVttRepresentationListQueryParamsBuilder) => DashVttRepresentationListQueryParamsBuilder)): Promise<PaginationResponse<DashVttRepresentation>>;
}