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

Node.JS wrapper for the Dolby OptiView REST APIs

import { ReprioritizeOptions, StreamStopResponse } from './types/stream';
/**
 * Stops an active stream.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/stream-stop-stream/}
 * @remarks Prior to stopping the stream, you must call {@link disableToken}.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param streamId Identifier of the stream to stop.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StreamStopResponse} object.
 */
export declare const stop: (apiSecret: string, streamId: string) => Promise<StreamStopResponse>;
/**
 * Stops all currently active streams associated with your account.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/stream-stop-by-account/}
 * @remarks Prior to stopping a stream, you must call {@link disableToken}.
 *
 * @param apiSecret The API Secret used to authenticate this request.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StreamStopResponse} object.
 */
export declare const stopAll: (apiSecret: string) => Promise<StreamStopResponse>;
/**
 * ## Reprioritize an active stream
 *
 * Update stream priority specified in token and restart stream to re-assign priority.
 *
 * Use {@link listTokensByName | List Tokens By Name} and filter by StreamName to identify the tokenId associated with the target stream.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/stream-reprioritize-stream/}
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param options The options to reprioritize the stream.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StreamStopResponse} object.
 */
export declare const reprioritize: (apiSecret: string, options: ReprioritizeOptions) => Promise<StreamStopResponse>;