@dolbyio/dolbyio-rest-apis-client
Version:
Node.JS wrapper for the Dolby OptiView REST APIs
26 lines (25 loc) • 1.18 kB
TypeScript
import { PublishResponse, SubscribeResponse } from './types/director';
/**
* Request for url and authorization to publish a stream.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/director/director-publish/}
*
* @param publishingToken The publishing token.
* @param streamName The name of the stream.
* @param streamAccountId The account identifier.
*
* @returns A {@link PublishResponse} object through a {@link Promise}.
*/
export declare const publish: (publishingToken: string, streamName: string, streamAccountId?: string) => Promise<PublishResponse>;
/**
* Request for url and authorization to subscribe to a stream.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/director/director-subscribe/}
*
* @param streamName The name of the stream.
* @param streamAccountId The account identifier. Required only for published streams which have `subscribeRequiresAuth=false`.
* @param publishingToken The publish token.
*
* @returns A {@link SubscribeResponse} object through a {@link Promise}.
*/
export declare const subscribe: (streamName: string, streamAccountId?: string, publishingToken?: string) => Promise<SubscribeResponse>;