@signageos/front-applet 7.1.1 → 8.0.0

package/es6/FrontApplet/Stream/Stream.d.ts

@@ -1,35 +1,150 @@
 import IPostMessage from '../IPostMessage';
-import StreamProtocol from './StreamProtocol';
-import IStreamMessage from './IStreamMessage';
-import { IStreamOptions, IStreamPrepareOptions } from '../Video/IOptions';
-import { ITrackInfo, TrackType } from './IStreamTrackInfo';
-import { IStreamErrorEventListener, IStreamEventListener, IStreamTracksChangedEventListener } from './streamListeners';
-import IVideoProperties from '../Video/IVideoProperties';
+import { IStreamOptions, type IStreamPrepareOptions } from '../Video/IOptions';
+import type IVideoProperties from '../Video/IVideoProperties';
 import IStream from './IStream';
+import IStreamMessage from './IStreamMessage';
+import type { ITrackInfo, TrackType } from './IStreamTrackInfo';
+import { IStreamErrorEvent, IStreamEvent, IStreamTracksChangedEvent } from './streamEvents';
+import StreamProtocol from './StreamProtocol';
+/**
+ * The `sos.video` API groups together methods for streaming videos.
+ *
+ * :::warning
+ *
+ * Are you using **Samsung Tizen** to play streams? Read more about limitation and
+ * [Tizen-specific details](https://docs.signageos.io/hc/en-us/articles/4405387373458).
+ *
+ * :::
+ *
+ * :::danger
+ *
+ * Be aware version of JS API (v6.0.0+) changed how stream functions `play()` and `prepare()` work. For using an options object you need to
+ * our latest core app versions. If you are using older core app versions, you need to use deprecated format.
+ *
+ * :::
+ */
 export default class Stream implements IStream {
     private messagePrefix;
     private postMessage;
     static MESSAGE_PREFIX: string;
     private eventEmitter;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `prepare()` method prepares the stream in the background.
+     *
+     * :::info
+     *
+     * If you want to play a video stream in full screen mode, use x = y = 0 and width = document.documentElement.clientWidth and height = document.documentElement.clientHeight as setup parameters.
+     *
+     * :::
+     *
+     * @since 4.7.0
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/stream}
+     */
     prepare(uri: string, x: number, y: number, width: number, height: number, options?: IStreamPrepareOptions | keyof typeof StreamProtocol): Promise<void>;
+    /**
+     * The `play()` method starts the streaming of a streaming previously prepared by `prepare()` method.
+     *
+     * @since 1.0.18
+     */
     play(uri: string, x: number, y: number, width: number, height: number, options?: IStreamOptions | keyof typeof StreamProtocol): Promise<void>;
+    /**
+     * The `stop()` method stops the stream, it can't be resumed with `resume()`.
+     *
+     * @since 1.0.18
+     */
     stop(uri: string, x: number, y: number, width: number, height: number): Promise<void>;
+    /**
+     * The `pause()` method pauses the stream, it can be resumed with `resume()`.
+     *
+     * @since 6.4.0
+     */
     pause(uri: string, x: number, y: number, width: number, height: number): Promise<void>;
+    /**
+     * The `resume()` method resumes the stream paused by `pause()`.
+     *
+     * @since 6.4.0
+     */
     resume(uri: string, x: number, y: number, width: number, height: number): Promise<void>;
+    /**
+     * The `getTracks()` method returns a track list of a stream.
+     *
+     * @since 6.1.0
+     */
     getTracks(videoId: IVideoProperties): Promise<ITrackInfo[]>;
+    /**
+     * The `selectTrack()` method selects a track of a stream.
+     *
+     * @since 6.1.0
+     */
     selectTrack(videoId: IVideoProperties, trackType: TrackType, groupId: string, trackIndex: number): Promise<void>;
+    /**
+     * The `resetTrack()` method resets a track of a stream.
+     *
+     * @since 6.1.0
+     */
     resetTrack(videoId: IVideoProperties, trackType: TrackType, groupId?: string): Promise<void>;
-    onTracksChanged(listener: IStreamTracksChangedEventListener): void;
-    onError(listener: IStreamErrorEventListener): void;
-    onConnected(listener: IStreamEventListener<'connected'>): void;
-    onDisconnected(listener: IStreamEventListener<'disconnected'>): void;
-    onPrepare(listener: IStreamEventListener<'prepare'>): void;
-    onPlay(listener: IStreamEventListener<'play'>): void;
-    onStop(listener: IStreamEventListener<'stop'>): void;
-    onPause(listener: IStreamEventListener<'pause'>): void;
-    onResume(listener: IStreamEventListener<'resume'>): void;
+    /**
+     * The `onTracksChanged()` method sets up a listener, which is called whenever a track is changed.
+     *
+     * @since 6.1.0
+     */
+    onTracksChanged(listener: (event: IStreamTracksChangedEvent) => void): void;
+    /**
+     * The `onTracksChanged()` method sets up a listener, which is called whenever an unexpected error occurs during a stream.
+     *
+     * @since 1.0.20
+     */
+    onError(listener: (event: IStreamErrorEvent) => void): void;
+    /**
+     * The `onConnected()` method sets up a listener, which is called whenever a stream is connected.
+     *
+     * @since 1.0.20
+     */
+    onConnected(listener: (event: IStreamEvent<'connected'>) => void): void;
+    /**
+     * The `onDisconnected()` method sets up a listener, which is called whenever a stream gets disconnected.
+     *
+     * @since 1.0.20
+     */
+    onDisconnected(listener: (event: IStreamEvent<'disconnected'>) => void): void;
+    /**
+     * The `onPrepare()` method sets up a listener, which is called whenever a stream gets prepared.
+     *
+     * @since 5.12.0
+     */
+    onPrepare(listener: (event: IStreamEvent<'prepare'>) => void): void;
+    /**
+     * The `onPlay()` method sets up a listener, which is called whenever a stream starts playing.
+     *
+     * @since 5.12.0
+     */
+    onPlay(listener: (event: IStreamEvent<'play'>) => void): void;
+    /**
+     * The `onStop()` method sets up a listener, which is called whenever a stream stops.
+     *
+     * @since 5.12.0
+     */
+    onStop(listener: (event: IStreamEvent<'stop'>) => void): void;
+    /**
+     * The `onStop()` method sets up a listener, which is called whenever a stream is paused.
+     *
+     * @since 5.12.0
+     */
+    onPause(listener: (event: IStreamEvent<'pause'>) => void): void;
+    /**
+     * The `onStop()` method sets up a listener, which is called whenever a stream is resumed.
+     *
+     * @since 5.12.0
+     */
+    onResume(listener: (event: IStreamEvent<'resume'>) => void): void;
+    /** @internal */
     handleMessageData(data: IStreamMessage): void;
+    /**
+     * The `removeEventListeners()` removes all listeners set up on `sos.stream`.
+     */
     removeEventListeners(): void;
     private createAndEmitEvent;
     private getMessage;