@bitmovin/api-sdk/dist/encoding/live/standbyPools/encodings/EncodingsApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import LiveStandbyPoolEncoding from '../../../../models/LiveStandbyPoolEncoding';
import PaginationResponse from '../../../../models/PaginationResponse';
import { LiveStandbyPoolEncodingListQueryParams, LiveStandbyPoolEncodingListQueryParamsBuilder } from './LiveStandbyPoolEncodingListQueryParams';
/**
 * EncodingsApi - object-oriented interface
 * @export
 * @class EncodingsApi
 * @extends {BaseAPI}
 */
export default class EncodingsApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Delete encoding from pool by id
     * @param {string} poolId Id of the standby pool
     * @param {string} id Id of the standby pool encoding
     * @throws {BitmovinError}
     * @memberof EncodingsApi
     */
    delete(poolId: string, id: string): Promise<BitmovinResponse>;
    /**
     * @summary List encodings from a standby pool
     * @param {string} poolId Id of the standby pool
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof EncodingsApi
     */
    list(poolId: string, queryParameters?: LiveStandbyPoolEncodingListQueryParams | ((q: LiveStandbyPoolEncodingListQueryParamsBuilder) => LiveStandbyPoolEncodingListQueryParamsBuilder)): Promise<PaginationResponse<LiveStandbyPoolEncoding>>;
}