@dolbyio/dolbyio-rest-apis-client/dist/media/diagnose.d.ts

Node.JS wrapper for the Dolby.io REST APIs

import { JwtToken } from './types/jwtToken';
import { DiagnoseJob } from './types/diagnose';
/**
 * Starts diagnosing to learn about the audio quality of your media.
 *
 * The `input` location of your source media file is required.
 *
 * This is an asynchronous operation so you will receive a job identifier to be used to get the job status and result.
 *
 * @link https://docs.dolby.io/media-apis/reference/media-diagnose-post
 *
 * @param accessToken Access token to use for authentication.
 * @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-diagnose-post
 *
 * @returns The job identifier through a {@link Promise}.
 */
export declare const start: (accessToken: JwtToken, jobContent: string) => Promise<string | null>;
/**
 * Gets Diagnose Results.
 *
 * For a given {@link jobId}, this method will check if the processing task has completed.
 *
 * The {@link DiagnoseJob.progress} attribute provides a percentage of job progress.
 *
 * If the {@link DiagnoseJob.status} is Success then the json result will be returned in the response.
 *
 * @link https://docs.dolby.io/media-apis/reference/media-diagnose-get
 *
 * @param accessToken Access token to use for authentication.
 * @param jobId Identifier of the job to retrieve.
 *
 * @returns The {@link DiagnoseJob} object through a {@link Promise}.
 */
export declare const getResults: (accessToken: JwtToken, jobId: string) => Promise<DiagnoseJob>;