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

Node.JS wrapper for the Dolby OptiView REST APIs

import { GetStreamDetailsOptions, ListAllStreamsSortOptions, ListStreamsResponse, ListStreamsSortOptions, ListStreamSummariesResponse, ListStreamSummariesSortOptions, StreamDetails, StreamSummary } from './types/monitoring';
/**
 * ## List Streams
 *
 * List all streams created within last hour with specific sorting and pagination.
 * If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
 * regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-recent-streams/}
 *
 * @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 {@link ListStreamsResponse} object.
 */
export declare const listStreams: (apiSecret: string, options: ListStreamsSortOptions) => Promise<ListStreamsResponse>;
/**
 * ## List all Streams
 *
 * List all streams created within last hour with specific sorting and pagination.
 * If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
 * regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-recent-streams/}
 *
 * @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 StreamDetails} object.
 */
export declare const listAllStreams: (apiSecret: string, options: ListAllStreamsSortOptions) => Promise<StreamDetails[]>;
/**
 * ## Stream Details
 *
 * Get stream details by stream name.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-get-stream/}
 *
 * @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 a {@link StreamDetails} object.
 */
export declare const streamDetails: (apiSecret: string, options: GetStreamDetailsOptions) => Promise<StreamDetails>;
/**
 * ## List Stream Summaries
 *
 * List a summary of all streams created within last hour with specific sorting and pagination.
 * If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
 * regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
 * This is a lite version of {@link listStreams} which does not include feed details.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-stream-summary/}
 *
 * @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 {@link ListStreamSummariesResponse} object.
 */
export declare const listStreamSummaries: (apiSecret: string, options: ListStreamSummariesSortOptions) => Promise<ListStreamSummariesResponse>;
/**
 * ## List all Stream Summaries
 *
 * List a summary of all streams created within last hour with specific sorting and pagination.
 * If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
 * regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
 * This is a lite version of {@link listAllStreams} which does not include feed details.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-stream-summary/}
 *
 * @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 StreamSummary} object.
 */
export declare const listAllStreamSummaries: (apiSecret: string, options: ListAllStreamsSortOptions) => Promise<StreamSummary[]>;
/**
 * ## Stream Summary
 *
 * Get stream summary by stream name.
 *
 * @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-get-stream-summary/}
 *
 * @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 a {@link StreamSummary} object.
 */
export declare const streamSummary: (apiSecret: string, options: GetStreamDetailsOptions) => Promise<StreamSummary>;