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

Node.JS wrapper for the Dolby.io REST APIs

import { StreamStopResponse } from './types/stream';
/**
 * Stops an active stream.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/stream_stopstream
 * @note Prior to stopping the stream, you must call {@link disable}.
 *
 * @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.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/stream_stopbyaccount
 * @note Prior to stopping a stream, you must call {@link disable}.
 *
 * @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>;