@bitmovin/api-sdk/dist/encoding/outputs/local/LocalApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import LocalOutput from '../../../models/LocalOutput';
import PaginationResponse from '../../../models/PaginationResponse';
import { LocalOutputListQueryParams, LocalOutputListQueryParamsBuilder } from './LocalOutputListQueryParams';
/**
 * LocalApi - object-oriented interface
 * @export
 * @class LocalApi
 * @extends {BaseAPI}
 */
export default class LocalApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create Local Output
     * @param {LocalOutput} localOutput The Local output to be created
     * @throws {BitmovinError}
     * @memberof LocalApi
     */
    create(localOutput?: LocalOutput): Promise<LocalOutput>;
    /**
     * @summary Delete Local Output
     * @param {string} outputId Id of the output
     * @throws {BitmovinError}
     * @memberof LocalApi
     */
    delete(outputId: string): Promise<LocalOutput>;
    /**
     * @summary Local Output Details
     * @param {string} outputId Id of the output
     * @throws {BitmovinError}
     * @memberof LocalApi
     */
    get(outputId: string): Promise<LocalOutput>;
    /**
     * @summary List Local Outputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof LocalApi
     */
    list(queryParameters?: LocalOutputListQueryParams | ((q: LocalOutputListQueryParamsBuilder) => LocalOutputListQueryParamsBuilder)): Promise<PaginationResponse<LocalOutput>>;
}