@bitmovin/api-sdk/dist/encoding/statistics/encodings/live/options/OptionsApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import LiveEncodingOptionsStatistics from '../../../../../models/LiveEncodingOptionsStatistics';
import LiveOptionsStatistics from '../../../../../models/LiveOptionsStatistics';
import { LiveOptionsStatisticsListByDateRangeQueryParams, LiveOptionsStatisticsListByDateRangeQueryParamsBuilder } from './LiveOptionsStatisticsListByDateRangeQueryParams';
/**
 * OptionsApi - object-oriented interface
 * @export
 * @class OptionsApi
 * @extends {BaseAPI}
 */
export default class OptionsApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary List live options encoding statistics for a given encoding
     * @param {string} encodingId Id of the encoding
     * @throws {BitmovinError}
     * @memberof OptionsApi
     */
    get(encodingId: string): Promise<LiveEncodingOptionsStatistics>;
    /**
     * @summary List live options encoding statistics within specific dates
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof OptionsApi
     */
    listByDateRange(queryParameters?: LiveOptionsStatisticsListByDateRangeQueryParams | ((q: LiveOptionsStatisticsListByDateRangeQueryParamsBuilder) => LiveOptionsStatisticsListByDateRangeQueryParamsBuilder)): Promise<LiveOptionsStatistics>;
}