@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
33 lines (32 loc) • 1.5 kB
TypeScript
import { BaseAPI } from '../../../../../common/BaseAPI';
import Configuration from '../../../../../common/Configuration';
import BitmovinResponse from '../../../../../models/BitmovinResponse';
import PsnrQualityMetric from '../../../../../models/PsnrQualityMetric';
import PaginationResponse from '../../../../../models/PaginationResponse';
import { PsnrQualityMetricListQueryParams, PsnrQualityMetricListQueryParamsBuilder } from './PsnrQualityMetricListQueryParams';
/**
* PsnrApi - object-oriented interface
* @export
* @class PsnrApi
* @extends {BaseAPI}
*/
export default class PsnrApi extends BaseAPI {
constructor(configuration: Configuration);
/**
* @summary PSNR quality metrics
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @throws {BitmovinError}
* @memberof PsnrApi
*/
create(encodingId: string, streamId: string): Promise<BitmovinResponse>;
/**
* @summary Get Stream PSNR metrics
* @param {string} encodingId Id of the encoding.
* @param {string} streamId Id of the stream.
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof PsnrApi
*/
list(encodingId: string, streamId: string, queryParameters?: PsnrQualityMetricListQueryParams | ((q: PsnrQualityMetricListQueryParamsBuilder) => PsnrQualityMetricListQueryParamsBuilder)): Promise<PaginationResponse<PsnrQualityMetric>>;
}