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

Node.JS wrapper for the Dolby OptiView REST APIs

import { JwtToken } from './types/jwtToken';
import { AnalyzeJob } from './types/analyze';
/**
 * Starts analyzing to learn about your media.
 *
 * The `input` location of your source media file and `output` location of your Analyze JSON results file are required.
 *
 * This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
 *
 * There are additional optional parameters that can be provided to identify the type of content and additional loudness or validation requirements. See the samples for examples of what requests and responses look like.
 *
 * Content Length
 *
 * Media content with duration less than 2 seconds will not be processed. The API will return an ERROR in this case.
 *
 * @param accessToken Access token to use for authentication.
 * @param jobContent Content of the job description as a JSON payload.
 *
 * @returns The job identifier through a {@link Promise}.
 */
export declare const start: (accessToken: JwtToken, jobContent: string) => Promise<string | null>;
/**
 * Gets Analyze Status.
 *
 * For a given `jobId`, this method will check the job status.
 *
 * When {@link AnalyzeJob.status} is `Success`, you'll be able to retrieve your result from the `output` location you provided in the original {@link start} request.
 *
 * @param accessToken Access token to use for authentication.
 * @param jobId Identifier of the job to retrieve.
 *
 * @returns The {@link AnalyzeJob} object through a {@link Promise}.
 */
export declare const getResults: (accessToken: JwtToken, jobId: string) => Promise<AnalyzeJob>;