@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
54 lines (53 loc) • 2.59 kB
TypeScript
import { BaseAPI } from '../../../../../../common/BaseAPI';
import Configuration from '../../../../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../../../../models/BitmovinResponse';
import FrameIdId3Tag from '../../../../../../models/FrameIdId3Tag';
import PaginationResponse from '../../../../../../models/PaginationResponse';
import { FrameIdId3TagListQueryParams, FrameIdId3TagListQueryParamsBuilder } from './FrameIdId3TagListQueryParams';
/**
* FrameIdApi - object-oriented interface
* @export
* @class FrameIdApi
* @extends {BaseAPI}
*/
export default class FrameIdApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Add Frame ID ID3 Tag to a Progressive TS muxing
* @param {string} encodingId ID of the Encoding.
* @param {string} muxingId ID of the Progressive TS muxing
* @param {FrameIdId3Tag} frameIdId3Tag The Frame ID ID3 Tag to be created
* @throws {BitmovinError}
* @memberof FrameIdApi
*/
create(encodingId: string, muxingId: string, frameIdId3Tag?: FrameIdId3Tag): Promise<FrameIdId3Tag>;
/**
* @summary Delete Frame ID ID3 Tag of a Progressive TS muxing
* @param {string} encodingId ID of the Encoding.
* @param {string} muxingId ID of the Progressive TS muxing
* @param {string} id3TagId ID of the Frame ID ID3 Tag
* @throws {BitmovinError}
* @memberof FrameIdApi
*/
delete(encodingId: string, muxingId: string, id3TagId: string): Promise<BitmovinResponse>;
/**
* @summary Frame ID ID3 Tag Details of a Progressive TS muxing
* @param {string} encodingId ID of the Encoding.
* @param {string} muxingId ID of the Progressive TS muxing
* @param {string} id3TagId ID of the Frame ID ID3 Tag
* @throws {BitmovinError}
* @memberof FrameIdApi
*/
get(encodingId: string, muxingId: string, id3TagId: string): Promise<FrameIdId3Tag>;
/**
* @summary List Frame ID ID3 Tags of a Progressive TS muxing
* @param {string} encodingId ID of the Encoding.
* @param {string} muxingId ID of the Progressive TS muxing
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof FrameIdApi
*/
list(encodingId: string, muxingId: string, queryParameters?: FrameIdId3TagListQueryParams | ((q: FrameIdId3TagListQueryParamsBuilder) => FrameIdId3TagListQueryParamsBuilder)): Promise<PaginationResponse<FrameIdId3Tag>>;
}