@bitmovin/api-sdk/dist/player/customBuilds/web/WebApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import DomainsApi from './domains/DomainsApi';
import StatusApi from './status/StatusApi';
import DownloadApi from './download/DownloadApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import CustomPlayerBuildDetails from '../../../models/CustomPlayerBuildDetails';
import CustomPlayerBuildStatus from '../../../models/CustomPlayerBuildStatus';
import PaginationResponse from '../../../models/PaginationResponse';
/**
 * WebApi - object-oriented interface
 * @export
 * @class WebApi
 * @extends {BaseAPI}
 */
export default class WebApi extends BaseAPI {
    domains: DomainsApi;
    status: StatusApi;
    download: DownloadApi;
    constructor(configuration: Configuration);
    /**
     * @summary Add Custom Web Player Build
     * @param {CustomPlayerBuildDetails} customPlayerBuildDetails The Custom Web Player Build to be added
     * @throws {BitmovinError}
     * @memberof WebApi
     */
    create(customPlayerBuildDetails?: CustomPlayerBuildDetails): Promise<CustomPlayerBuildDetails>;
    /**
     * @summary Custom Web Player Build Details
     * @param {string} customBuildId Id of the custom player build
     * @throws {BitmovinError}
     * @memberof WebApi
     */
    get(customBuildId: string): Promise<CustomPlayerBuildStatus>;
    /**
     * @summary List Custom Web Player Builds
     * @throws {BitmovinError}
     * @memberof WebApi
     */
    list(): Promise<PaginationResponse<CustomPlayerBuildDetails>>;
    /**
     * @summary Start Custom Web Player Build
     * @param {string} customBuildId Id of the custom player build
     * @throws {BitmovinError}
     * @memberof WebApi
     */
    start(customBuildId: string): Promise<BitmovinResponse>;
}