@dolbyio/dolbyio-rest-apis-client/dist/streaming/transcoders.d.ts

Node.JS wrapper for the Dolby.io REST APIs

import { ListTranscodersSortOptions, ListTranscodersInstancesSortOptions, ListTranscodersProfilesSortOptions, Transcoder, TranscoderProfile, TranscoderInstance, CreateTranscoderRequest, UpdateTranscoderRequest } from './types/transcoders';
/**
 * Lists all transcoders.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/transcoder_listtranscoders
 * @beta
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param options Options to sort the response.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives an array of {@link Transcoder} objects.
 */
export declare const listTranscoders: (apiSecret: string, options: ListTranscodersSortOptions) => Promise<Transcoder[]>;
/**
 * Gets the specified cloud transcoder.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/transcoder_gettranscoder
 * @beta
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param transcoderId Identifier of the cloud transcoder to retrieve.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link Transcoder} object.
 */
export declare const getTranscoder: (apiSecret: string, transcoderId: string) => Promise<Transcoder>;
/**
 * Deletes the specified cloud transcoder.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/transcoder_deletetranscoder
 * @beta
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param transcoderId Identifier of the cloud transcoder to delete.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a flag to indicate if the operation succeeded or not.
 */
export declare const deleteTranscoder: (apiSecret: string, transcoderId: number) => Promise<boolean>;
/**
 * Creates a cloud transcoder.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/transcoder_createtranscoder
 * @beta
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param transcoder Information about the new cloud transcoder.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link Transcoder} object.
 */
export declare const createTranscoder: (apiSecret: string, transcoder: CreateTranscoderRequest) => Promise<Transcoder>;
/**
 * Configures an existing Transcoder.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/transcoder_configuretranscoder
 * @beta
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param transcoderId Identifier of the cloud transcoder to update.
 * @param transcoder Settings of the cloud transcoder to update.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link Transcoder} object.
 */
export declare const updateTranscoder: (apiSecret: string, transcoderId: string, transcoder: UpdateTranscoderRequest) => Promise<Transcoder>;
/**
 * Starts the cloud transcoder.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/transcoder_starttranscoder
 * @beta
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param transcoderId Identifier of the cloud transcoder to start.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a flag to indicate if the operation succeeded or not.
 */
export declare const startTranscoder: (apiSecret: string, transcoderId: string) => Promise<boolean>;
/**
 * Stops the cloud transcoder.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/transcoder_stoptranscoder
 * @beta
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param transcoderId Identifier of the cloud transcoder to stop.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a flag to indicate if the operation succeeded or not.
 */
export declare const stopTranscoder: (apiSecret: string, transcoderId: string) => Promise<boolean>;
/**
 * Lists all transcoder instances.
 * Information on each instance is available for up to 90 days from its end date.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/transcoder_listtranscoderinstances
 * @beta
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param options Options to sort the response.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives an array of {@link TranscoderInstance} objects.
 */
export declare const listTranscoderInstances: (apiSecret: string, options: ListTranscodersInstancesSortOptions) => Promise<TranscoderInstance[]>;
/**
 * Gets the specified cloud transcoder instance.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/transcoder_gettranscoderinstance
 * @beta
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param transcoderInstanceId Identifier of the cloud transcoder instance to retrieve.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link TranscoderInstance} object.
 */
export declare const getTranscoderInstance: (apiSecret: string, transcoderInstanceId: string) => Promise<TranscoderInstance>;
/**
 * Lists all transcoder profiles.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/transcoder_listtranscoderprofiles
 * @beta
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param options Options to sort the response.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives an array of {@link TranscoderProfile} objects.
 */
export declare const listTranscoderProfiles: (apiSecret: string, options: ListTranscodersProfilesSortOptions) => Promise<TranscoderProfile[]>;