@dolbyio/dolbyio-rest-apis-client
Version:
Node.JS wrapper for the Dolby.io REST APIs
31 lines (30 loc) • 1.36 kB
TypeScript
import { JwtToken } from './types/jwtToken';
import { TranscodeJob } from './types/transcode';
/**
* Starts Transcoding.
*
* Start transcoding to modify the size, bitrates, and formats for your media.
*
* @link https://docs.dolby.io/media-apis/reference/media-transcode-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-transcode-post
*
* @returns The job identifier through a {@link Promise}.
*/
export declare const start: (accessToken: JwtToken, jobContent: string) => Promise<string | null>;
/**
* Gets Transcode Results.
*
* For a given {@link jobId}, this method will check if the processing task has completed and return the transcode results.
*
* When the {@link TranscodeJob.status} is Success you'll be able to retrieve your result from the output location you provided in the original POST.
*
* @link https://docs.dolby.io/media-apis/reference/media-transcode-get
*
* @param accessToken Access token to use for authentication.
* @param jobId Identifier of the job to retrieve.
*
* @returns The {@link TranscodeJob} object through a {@link Promise}.
*/
export declare const getResults: (accessToken: JwtToken, jobId: string) => Promise<TranscodeJob>;