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

Node.JS wrapper for the Dolby OptiView REST APIs

import { CreateTranscoderScheduleRequest, TranscoderSchedule, UpdateTranscoderScheduleRequest, ListTranscoderSchedulesSortOptions } from './types/transcodersSchedules';
/**
 * Creates a Schedule for Transcoders specified.
 *
 * @remarks Cloud transcoder is not currently available for general usage.
 * If you would like to opt in, please contact our Sales team.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/transcoder-scheduler-create-schedule/}
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param schedule Information about the new cloud transcoder.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link TranscoderSchedule} object.
 */
export declare const createSchedule: (apiSecret: string, schedule: CreateTranscoderScheduleRequest) => Promise<TranscoderSchedule>;
/**
 * ## Delete Transcoder Schedule
 *
 * Deletes a Transcoder schedule by its Schedule ID. Schedule ID can be found from {@link createSchedule | Create}/{@link getSchedule | Get} Transcoder Schedule response.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/transcoder-scheduler-delete-schedule/}
 *
 * @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 scheduleId Identifier of the cloud transcoder schedule 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, scheduleId: string) => Promise<boolean>;
/**
 * Updates a Transcoder Schedule by its Schedule ID.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/transcoder-scheduler-update-schedule/}
 *
 * @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 scheduleId Identifier of the cloud transcoder schedule to retrieve.
 * @param schedule Settings of the cloud transcoder schedule to update.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link TranscoderSchedule} object.
 */
export declare const updateSchedule: (apiSecret: string, scheduleId: string, schedule: UpdateTranscoderScheduleRequest) => Promise<TranscoderSchedule>;
/**
 * Gets the specified cloud transcoder schedule.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/transcoder-scheduler-get-schedule-by-schedule-id/}
 *
 * @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 scheduleId Identifier of the cloud transcoder schedule to retrieve.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link TranscoderSchedule} object.
 */
export declare const getSchedule: (apiSecret: string, scheduleId: string) => Promise<TranscoderSchedule>;
/**
 * ## Lists all Transcoder Schedules.
 *
 * Sort by Created Date by default. Able to be filtered by Schedule Status.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/transcoder-scheduler-list-all-schedules/}
 *
 * @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 TranscoderSchedule} objects.
 */
export declare const listSchedules: (apiSecret: string, options: ListTranscoderSchedulesSortOptions) => Promise<TranscoderSchedule[]>;
/**
 * ## Lists all Transcoder Schedules.
 *
 * Sort by Created Date by default. Able to be filtered by Schedule Status.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/transcoder-scheduler-get-schedules-for-transcoder/}
 *
 * @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 transcoder to search the scheduled for.
 * @param options Options to sort the response.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives an array of {@link TranscoderSchedule} objects.
 */
export declare const listSchedulesByTranscoder: (apiSecret: string, transcoderId: string, options: ListTranscoderSchedulesSortOptions) => Promise<TranscoderSchedule[]>;