@signageos/front-applet 8.5.3 → 8.7.0

package/docs/sos/stream.md

@@ -40,63 +40,26 @@ interface ITrackVideoInfo extends ITrack<'VIDEO'> {
     };
 }
 
-/**
- * Interface representing stream track information.
- */
 interface ITrack<T extends TrackType> {
-    /**
-     * Type of the track, e.g., "VIDEO", "AUDIO", "TEXT".
-     */
     trackType: T;
-    /**
-     * MIME type of the track, e.g., "video/mp4", "audio/mp3", "text/vtt".
-     */
     mimeType: string;
-    /**
-     * Unique identifier for the track group.
-     * This is used to group tracks of the same type (e.g., multiple audio tracks).
-     */
     groupId: string;
-    /**
-     * Unique identifier for the track.
-     */
     trackIndex: number;
-    /**
-     * If the track is selected for playback.
-     */
     selected: boolean;
-    /**
-     * Selected language of subtitles or captions.
-     */
     language: string | null;
-    /**
-     * If the track is supported by the device.
-     */
     supported: boolean;
 }
 
-/**
- * Available track types for media streams.
- */
 type TrackType = 'TEXT' | 'AUDIO' | 'VIDEO';
 
 interface ITrackAudioInfo extends ITrack<'AUDIO'> {
-    /**
-     * Number of audio channels.
-     */
     channelCount: number;
 }
 
 interface ITrackTextInfo extends ITrack<'TEXT'> {
-    /**
-     * Selected subtitles or captions.
-     */
     selection: string[];
 }
 
-/**
- * Video properties interface for defining the properties of a played video.
- */
 interface IVideoProperties {
     uri: string;
     x: number;
@@ -135,31 +98,13 @@ The `onConnected()` method sets up a listener, which is called whenever a stream
 ```ts expandable
 onConnected(listener: (event: IStreamEvent<'connected'>) => void): void;
 // show-more
-/**
- * Generic interface for stream events.
- */
 interface IStreamEvent<T extends StreamEventType> {
-    /**
-     * Type of the event.
-     * @see {@link StreamEventType}
-     */
     type: T;
-    /**
-     * Additional stream properties that are relevant to the event.
-     * If there is more than one stream active, this will contain the properties of the stream that emitted the event.
-     */
     srcArguments: IStreamEventProperties;
 }
 
-/**
- * List of all possible stream event types.
- */
 type StreamEventType = 'connected' | 'disconnected' | 'error' | 'stop' | 'play' | 'prepare' | 'pause' | 'resume' | 'tracks_changed';
 
-/**
- * Returned properties of stream events that occur on stream events:
- * connected, disconnected, error, stop, tracks_changed
- */
 interface IStreamEventProperties {
     uri: string;
     x: number;
@@ -167,88 +112,39 @@ interface IStreamEventProperties {
     width: number;
     height: number;
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * @deprecated Events should not return options objects. Instead, they should return protocol {@link protocol}
-     */
     options?: IStreamOptions | IStreamPrepareOptions;
 }
 
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
-/**
- * Available options for stream function `prepare()`.
- */
 interface IStreamPrepareOptions extends IStreamOptions {
-    /**
-     * Track selection for subtitles, audio, and video.
-     */
     trackSelection?: {
-        /** Maximum number of audio channels to play */
         maxAudioChannelCount?: number;
-        /** Minimum video size to play */
         minVideoSize?: {
             width: number;
             height: number;
         };
-        /** Maximum video size to play */
         maxVideoSize?: {
             width: number;
             height: number;
         };
-        /** Preferred audio languages to play */
         preferredAudioLanguages?: string[];
-        /** Preferred text languages to play */
         preferredTextLanguages?: string[];
     };
-    /**
-     * DRM (Digital Rights Management) options for the stream.
-     */
     drm?: {
         scheme: DrmScheme;
-        /**
-         * URI to the license server.
-         */
         licenseUri: string;
-        /**
-         * Additional headers to include in the license request.
-         */
         licenseRequestHeaders: {
             [key: string]: string;
         };
@@ -291,31 +187,13 @@ Usually when source URI is not available anymore or when the stream is stopped.
 ```ts expandable
 onDisconnected(listener: (event: IStreamEvent<'disconnected'>) => void): void;
 // show-more
-/**
- * Generic interface for stream events.
- */
 interface IStreamEvent<T extends StreamEventType> {
-    /**
-     * Type of the event.
-     * @see {@link StreamEventType}
-     */
     type: T;
-    /**
-     * Additional stream properties that are relevant to the event.
-     * If there is more than one stream active, this will contain the properties of the stream that emitted the event.
-     */
     srcArguments: IStreamEventProperties;
 }
 
-/**
- * List of all possible stream event types.
- */
 type StreamEventType = 'connected' | 'disconnected' | 'error' | 'stop' | 'play' | 'prepare' | 'pause' | 'resume' | 'tracks_changed';
 
-/**
- * Returned properties of stream events that occur on stream events:
- * connected, disconnected, error, stop, tracks_changed
- */
 interface IStreamEventProperties {
     uri: string;
     x: number;
@@ -323,88 +201,39 @@ interface IStreamEventProperties {
     width: number;
     height: number;
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * @deprecated Events should not return options objects. Instead, they should return protocol {@link protocol}
-     */
     options?: IStreamOptions | IStreamPrepareOptions;
 }
 
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
-/**
- * Available options for stream function `prepare()`.
- */
 interface IStreamPrepareOptions extends IStreamOptions {
-    /**
-     * Track selection for subtitles, audio, and video.
-     */
     trackSelection?: {
-        /** Maximum number of audio channels to play */
         maxAudioChannelCount?: number;
-        /** Minimum video size to play */
         minVideoSize?: {
             width: number;
             height: number;
         };
-        /** Maximum video size to play */
         maxVideoSize?: {
             width: number;
             height: number;
         };
-        /** Preferred audio languages to play */
         preferredAudioLanguages?: string[];
-        /** Preferred text languages to play */
         preferredTextLanguages?: string[];
     };
-    /**
-     * DRM (Digital Rights Management) options for the stream.
-     */
     drm?: {
         scheme: DrmScheme;
-        /**
-         * URI to the license server.
-         */
         licenseUri: string;
-        /**
-         * Additional headers to include in the license request.
-         */
         licenseRequestHeaders: {
             [key: string]: string;
         };
@@ -446,41 +275,17 @@ The `onError()` method sets up a listener, which is called whenever an unexpecte
 ```ts expandable
 onError(listener: (event: IStreamErrorEvent) => void): void;
 // show-more
-/**
- * Stream Error Event, which is emitted when an error occurs during stream operations.
- */
 interface IStreamErrorEvent extends IStreamEvent<'error'> {
-    /**
-     * Additional info about the error that occurred, if any info is available.
-     */
     errorMessage?: string | undefined;
 }
 
-/**
- * Generic interface for stream events.
- */
 interface IStreamEvent<T extends StreamEventType> {
-    /**
-     * Type of the event.
-     * @see {@link StreamEventType}
-     */
     type: T;
-    /**
-     * Additional stream properties that are relevant to the event.
-     * If there is more than one stream active, this will contain the properties of the stream that emitted the event.
-     */
     srcArguments: IStreamEventProperties;
 }
 
-/**
- * List of all possible stream event types.
- */
 type StreamEventType = 'connected' | 'disconnected' | 'error' | 'stop' | 'play' | 'prepare' | 'pause' | 'resume' | 'tracks_changed';
 
-/**
- * Returned properties of stream events that occur on stream events:
- * connected, disconnected, error, stop, tracks_changed
- */
 interface IStreamEventProperties {
     uri: string;
     x: number;
@@ -488,88 +293,39 @@ interface IStreamEventProperties {
     width: number;
     height: number;
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * @deprecated Events should not return options objects. Instead, they should return protocol {@link protocol}
-     */
     options?: IStreamOptions | IStreamPrepareOptions;
 }
 
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
-/**
- * Available options for stream function `prepare()`.
- */
 interface IStreamPrepareOptions extends IStreamOptions {
-    /**
-     * Track selection for subtitles, audio, and video.
-     */
     trackSelection?: {
-        /** Maximum number of audio channels to play */
         maxAudioChannelCount?: number;
-        /** Minimum video size to play */
         minVideoSize?: {
             width: number;
             height: number;
         };
-        /** Maximum video size to play */
         maxVideoSize?: {
             width: number;
             height: number;
         };
-        /** Preferred audio languages to play */
         preferredAudioLanguages?: string[];
-        /** Preferred text languages to play */
         preferredTextLanguages?: string[];
     };
-    /**
-     * DRM (Digital Rights Management) options for the stream.
-     */
     drm?: {
         scheme: DrmScheme;
-        /**
-         * URI to the license server.
-         */
         licenseUri: string;
-        /**
-         * Additional headers to include in the license request.
-         */
         licenseRequestHeaders: {
             [key: string]: string;
         };
@@ -611,31 +367,13 @@ The `onPause()` method sets up a listener, which is called whenever a stream is
 ```ts expandable
 onPause(listener: (event: IStreamEvent<'pause'>) => void): void;
 // show-more
-/**
- * Generic interface for stream events.
- */
 interface IStreamEvent<T extends StreamEventType> {
-    /**
-     * Type of the event.
-     * @see {@link StreamEventType}
-     */
     type: T;
-    /**
-     * Additional stream properties that are relevant to the event.
-     * If there is more than one stream active, this will contain the properties of the stream that emitted the event.
-     */
     srcArguments: IStreamEventProperties;
 }
 
-/**
- * List of all possible stream event types.
- */
 type StreamEventType = 'connected' | 'disconnected' | 'error' | 'stop' | 'play' | 'prepare' | 'pause' | 'resume' | 'tracks_changed';
 
-/**
- * Returned properties of stream events that occur on stream events:
- * connected, disconnected, error, stop, tracks_changed
- */
 interface IStreamEventProperties {
     uri: string;
     x: number;
@@ -643,88 +381,39 @@ interface IStreamEventProperties {
     width: number;
     height: number;
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * @deprecated Events should not return options objects. Instead, they should return protocol {@link protocol}
-     */
     options?: IStreamOptions | IStreamPrepareOptions;
 }
 
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
-/**
- * Available options for stream function `prepare()`.
- */
 interface IStreamPrepareOptions extends IStreamOptions {
-    /**
-     * Track selection for subtitles, audio, and video.
-     */
     trackSelection?: {
-        /** Maximum number of audio channels to play */
         maxAudioChannelCount?: number;
-        /** Minimum video size to play */
         minVideoSize?: {
             width: number;
             height: number;
         };
-        /** Maximum video size to play */
         maxVideoSize?: {
             width: number;
             height: number;
         };
-        /** Preferred audio languages to play */
         preferredAudioLanguages?: string[];
-        /** Preferred text languages to play */
         preferredTextLanguages?: string[];
     };
-    /**
-     * DRM (Digital Rights Management) options for the stream.
-     */
     drm?: {
         scheme: DrmScheme;
-        /**
-         * URI to the license server.
-         */
         licenseUri: string;
-        /**
-         * Additional headers to include in the license request.
-         */
         licenseRequestHeaders: {
             [key: string]: string;
         };
@@ -766,31 +455,13 @@ The `onPlay()` method sets up a listener, which is called whenever a stream star
 ```ts expandable
 onPlay(listener: (event: IStreamEvent<'play'>) => void): void;
 // show-more
-/**
- * Generic interface for stream events.
- */
 interface IStreamEvent<T extends StreamEventType> {
-    /**
-     * Type of the event.
-     * @see {@link StreamEventType}
-     */
     type: T;
-    /**
-     * Additional stream properties that are relevant to the event.
-     * If there is more than one stream active, this will contain the properties of the stream that emitted the event.
-     */
     srcArguments: IStreamEventProperties;
 }
 
-/**
- * List of all possible stream event types.
- */
 type StreamEventType = 'connected' | 'disconnected' | 'error' | 'stop' | 'play' | 'prepare' | 'pause' | 'resume' | 'tracks_changed';
 
-/**
- * Returned properties of stream events that occur on stream events:
- * connected, disconnected, error, stop, tracks_changed
- */
 interface IStreamEventProperties {
     uri: string;
     x: number;
@@ -798,88 +469,39 @@ interface IStreamEventProperties {
     width: number;
     height: number;
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * @deprecated Events should not return options objects. Instead, they should return protocol {@link protocol}
-     */
     options?: IStreamOptions | IStreamPrepareOptions;
 }
 
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
-/**
- * Available options for stream function `prepare()`.
- */
 interface IStreamPrepareOptions extends IStreamOptions {
-    /**
-     * Track selection for subtitles, audio, and video.
-     */
     trackSelection?: {
-        /** Maximum number of audio channels to play */
         maxAudioChannelCount?: number;
-        /** Minimum video size to play */
         minVideoSize?: {
             width: number;
             height: number;
         };
-        /** Maximum video size to play */
         maxVideoSize?: {
             width: number;
             height: number;
         };
-        /** Preferred audio languages to play */
         preferredAudioLanguages?: string[];
-        /** Preferred text languages to play */
         preferredTextLanguages?: string[];
     };
-    /**
-     * DRM (Digital Rights Management) options for the stream.
-     */
     drm?: {
         scheme: DrmScheme;
-        /**
-         * URI to the license server.
-         */
         licenseUri: string;
-        /**
-         * Additional headers to include in the license request.
-         */
         licenseRequestHeaders: {
             [key: string]: string;
         };
@@ -921,31 +543,13 @@ The `onPrepare()` method sets up a listener, which is called whenever a stream g
 ```ts expandable
 onPrepare(listener: (event: IStreamEvent<'prepare'>) => void): void;
 // show-more
-/**
- * Generic interface for stream events.
- */
 interface IStreamEvent<T extends StreamEventType> {
-    /**
-     * Type of the event.
-     * @see {@link StreamEventType}
-     */
     type: T;
-    /**
-     * Additional stream properties that are relevant to the event.
-     * If there is more than one stream active, this will contain the properties of the stream that emitted the event.
-     */
     srcArguments: IStreamEventProperties;
 }
 
-/**
- * List of all possible stream event types.
- */
 type StreamEventType = 'connected' | 'disconnected' | 'error' | 'stop' | 'play' | 'prepare' | 'pause' | 'resume' | 'tracks_changed';
 
-/**
- * Returned properties of stream events that occur on stream events:
- * connected, disconnected, error, stop, tracks_changed
- */
 interface IStreamEventProperties {
     uri: string;
     x: number;
@@ -953,88 +557,39 @@ interface IStreamEventProperties {
     width: number;
     height: number;
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * @deprecated Events should not return options objects. Instead, they should return protocol {@link protocol}
-     */
     options?: IStreamOptions | IStreamPrepareOptions;
 }
 
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
-/**
- * Available options for stream function `prepare()`.
- */
 interface IStreamPrepareOptions extends IStreamOptions {
-    /**
-     * Track selection for subtitles, audio, and video.
-     */
     trackSelection?: {
-        /** Maximum number of audio channels to play */
         maxAudioChannelCount?: number;
-        /** Minimum video size to play */
         minVideoSize?: {
             width: number;
             height: number;
         };
-        /** Maximum video size to play */
         maxVideoSize?: {
             width: number;
             height: number;
         };
-        /** Preferred audio languages to play */
         preferredAudioLanguages?: string[];
-        /** Preferred text languages to play */
         preferredTextLanguages?: string[];
     };
-    /**
-     * DRM (Digital Rights Management) options for the stream.
-     */
     drm?: {
         scheme: DrmScheme;
-        /**
-         * URI to the license server.
-         */
         licenseUri: string;
-        /**
-         * Additional headers to include in the license request.
-         */
         licenseRequestHeaders: {
             [key: string]: string;
         };
@@ -1076,31 +631,13 @@ The `onResume()` method sets up a listener, which is called whenever a stream is
 ```ts expandable
 onResume(listener: (event: IStreamEvent<'resume'>) => void): void;
 // show-more
-/**
- * Generic interface for stream events.
- */
 interface IStreamEvent<T extends StreamEventType> {
-    /**
-     * Type of the event.
-     * @see {@link StreamEventType}
-     */
     type: T;
-    /**
-     * Additional stream properties that are relevant to the event.
-     * If there is more than one stream active, this will contain the properties of the stream that emitted the event.
-     */
     srcArguments: IStreamEventProperties;
 }
 
-/**
- * List of all possible stream event types.
- */
 type StreamEventType = 'connected' | 'disconnected' | 'error' | 'stop' | 'play' | 'prepare' | 'pause' | 'resume' | 'tracks_changed';
 
-/**
- * Returned properties of stream events that occur on stream events:
- * connected, disconnected, error, stop, tracks_changed
- */
 interface IStreamEventProperties {
     uri: string;
     x: number;
@@ -1108,88 +645,39 @@ interface IStreamEventProperties {
     width: number;
     height: number;
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * @deprecated Events should not return options objects. Instead, they should return protocol {@link protocol}
-     */
     options?: IStreamOptions | IStreamPrepareOptions;
 }
 
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
-/**
- * Available options for stream function `prepare()`.
- */
 interface IStreamPrepareOptions extends IStreamOptions {
-    /**
-     * Track selection for subtitles, audio, and video.
-     */
     trackSelection?: {
-        /** Maximum number of audio channels to play */
         maxAudioChannelCount?: number;
-        /** Minimum video size to play */
         minVideoSize?: {
             width: number;
             height: number;
         };
-        /** Maximum video size to play */
         maxVideoSize?: {
             width: number;
             height: number;
         };
-        /** Preferred audio languages to play */
         preferredAudioLanguages?: string[];
-        /** Preferred text languages to play */
         preferredTextLanguages?: string[];
     };
-    /**
-     * DRM (Digital Rights Management) options for the stream.
-     */
     drm?: {
         scheme: DrmScheme;
-        /**
-         * URI to the license server.
-         */
         licenseUri: string;
-        /**
-         * Additional headers to include in the license request.
-         */
         licenseRequestHeaders: {
             [key: string]: string;
         };
@@ -1233,31 +721,13 @@ The `onStop()` method sets up a listener, which is called whenever a stream stop
 ```ts expandable
 onStop(listener: (event: IStreamEvent<'stop'>) => void): void;
 // show-more
-/**
- * Generic interface for stream events.
- */
 interface IStreamEvent<T extends StreamEventType> {
-    /**
-     * Type of the event.
-     * @see {@link StreamEventType}
-     */
     type: T;
-    /**
-     * Additional stream properties that are relevant to the event.
-     * If there is more than one stream active, this will contain the properties of the stream that emitted the event.
-     */
     srcArguments: IStreamEventProperties;
 }
 
-/**
- * List of all possible stream event types.
- */
 type StreamEventType = 'connected' | 'disconnected' | 'error' | 'stop' | 'play' | 'prepare' | 'pause' | 'resume' | 'tracks_changed';
 
-/**
- * Returned properties of stream events that occur on stream events:
- * connected, disconnected, error, stop, tracks_changed
- */
 interface IStreamEventProperties {
     uri: string;
     x: number;
@@ -1265,88 +735,39 @@ interface IStreamEventProperties {
     width: number;
     height: number;
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * @deprecated Events should not return options objects. Instead, they should return protocol {@link protocol}
-     */
     options?: IStreamOptions | IStreamPrepareOptions;
 }
 
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
-/**
- * Available options for stream function `prepare()`.
- */
 interface IStreamPrepareOptions extends IStreamOptions {
-    /**
-     * Track selection for subtitles, audio, and video.
-     */
     trackSelection?: {
-        /** Maximum number of audio channels to play */
         maxAudioChannelCount?: number;
-        /** Minimum video size to play */
         minVideoSize?: {
             width: number;
             height: number;
         };
-        /** Maximum video size to play */
         maxVideoSize?: {
             width: number;
             height: number;
         };
-        /** Preferred audio languages to play */
         preferredAudioLanguages?: string[];
-        /** Preferred text languages to play */
         preferredTextLanguages?: string[];
     };
-    /**
-     * DRM (Digital Rights Management) options for the stream.
-     */
     drm?: {
         scheme: DrmScheme;
-        /**
-         * URI to the license server.
-         */
         licenseUri: string;
-        /**
-         * Additional headers to include in the license request.
-         */
         licenseRequestHeaders: {
             [key: string]: string;
         };
@@ -1389,13 +810,7 @@ from functions `selectTrack()` or `resetTrack()`.
 ```ts expandable
 onTracksChanged(listener: (event: IStreamTracksChangedEvent) => void): void;
 // show-more
-/**
- * Stream Tracks Changed Event which is emitted when new track is selected or active track resets.
- */
 interface IStreamTracksChangedEvent extends IStreamEvent<'tracks_changed'> {
-    /**
-     * Additional info about the track which has occurred the event.
-     */
     tracks: ITrackInfo[] | undefined;
 }
 
@@ -1408,85 +823,33 @@ interface ITrackVideoInfo extends ITrack<'VIDEO'> {
     };
 }
 
-/**
- * Interface representing stream track information.
- */
 interface ITrack<T extends TrackType> {
-    /**
-     * Type of the track, e.g., "VIDEO", "AUDIO", "TEXT".
-     */
     trackType: T;
-    /**
-     * MIME type of the track, e.g., "video/mp4", "audio/mp3", "text/vtt".
-     */
     mimeType: string;
-    /**
-     * Unique identifier for the track group.
-     * This is used to group tracks of the same type (e.g., multiple audio tracks).
-     */
     groupId: string;
-    /**
-     * Unique identifier for the track.
-     */
     trackIndex: number;
-    /**
-     * If the track is selected for playback.
-     */
     selected: boolean;
-    /**
-     * Selected language of subtitles or captions.
-     */
     language: string | null;
-    /**
-     * If the track is supported by the device.
-     */
     supported: boolean;
 }
 
-/**
- * Available track types for media streams.
- */
 type TrackType = 'TEXT' | 'AUDIO' | 'VIDEO';
 
 interface ITrackAudioInfo extends ITrack<'AUDIO'> {
-    /**
-     * Number of audio channels.
-     */
     channelCount: number;
 }
 
 interface ITrackTextInfo extends ITrack<'TEXT'> {
-    /**
-     * Selected subtitles or captions.
-     */
     selection: string[];
 }
 
-/**
- * Generic interface for stream events.
- */
 interface IStreamEvent<T extends StreamEventType> {
-    /**
-     * Type of the event.
-     * @see {@link StreamEventType}
-     */
     type: T;
-    /**
-     * Additional stream properties that are relevant to the event.
-     * If there is more than one stream active, this will contain the properties of the stream that emitted the event.
-     */
     srcArguments: IStreamEventProperties;
 }
 
-/**
- * List of all possible stream event types.
- */
 type StreamEventType = 'connected' | 'disconnected' | 'error' | 'stop' | 'play' | 'prepare' | 'pause' | 'resume' | 'tracks_changed';
 
-/**
- * Returned properties of stream events that occur on stream events:
- * connected, disconnected, error, stop, tracks_changed
- */
 interface IStreamEventProperties {
     uri: string;
     x: number;
@@ -1494,88 +857,39 @@ interface IStreamEventProperties {
     width: number;
     height: number;
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * @deprecated Events should not return options objects. Instead, they should return protocol {@link protocol}
-     */
     options?: IStreamOptions | IStreamPrepareOptions;
 }
 
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
-/**
- * Available options for stream function `prepare()`.
- */
 interface IStreamPrepareOptions extends IStreamOptions {
-    /**
-     * Track selection for subtitles, audio, and video.
-     */
     trackSelection?: {
-        /** Maximum number of audio channels to play */
         maxAudioChannelCount?: number;
-        /** Minimum video size to play */
         minVideoSize?: {
             width: number;
             height: number;
         };
-        /** Maximum video size to play */
         maxVideoSize?: {
             width: number;
             height: number;
         };
-        /** Preferred audio languages to play */
         preferredAudioLanguages?: string[];
-        /** Preferred text languages to play */
         preferredTextLanguages?: string[];
     };
-    /**
-     * DRM (Digital Rights Management) options for the stream.
-     */
     drm?: {
         scheme: DrmScheme;
-        /**
-         * URI to the license server.
-         */
         licenseUri: string;
-        /**
-         * Additional headers to include in the license request.
-         */
         licenseRequestHeaders: {
             [key: string]: string;
         };
@@ -1672,42 +986,16 @@ This method use same functionality, instead of URL (for stream), specify a URI o
 ```ts expandable
 play(uri: string, x: number, y: number, width: number, height: number, options?: IStreamOptions | keyof typeof StreamProtocol): Promise<void>;
 // show-more
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
@@ -1768,43 +1056,23 @@ If you want to play a video stream in full screen mode, use x = y = 0 and width
 ```ts expandable
 prepare(uri: string, x: number, y: number, width: number, height: number, options?: IStreamPrepareOptions | keyof typeof StreamProtocol): Promise<void>;
 // show-more
-/**
- * Available options for stream function `prepare()`.
- */
 interface IStreamPrepareOptions extends IStreamOptions {
-    /**
-     * Track selection for subtitles, audio, and video.
-     */
     trackSelection?: {
-        /** Maximum number of audio channels to play */
         maxAudioChannelCount?: number;
-        /** Minimum video size to play */
         minVideoSize?: {
             width: number;
             height: number;
         };
-        /** Maximum video size to play */
         maxVideoSize?: {
             width: number;
             height: number;
         };
-        /** Preferred audio languages to play */
         preferredAudioLanguages?: string[];
-        /** Preferred text languages to play */
         preferredTextLanguages?: string[];
     };
-    /**
-     * DRM (Digital Rights Management) options for the stream.
-     */
     drm?: {
         scheme: DrmScheme;
-        /**
-         * URI to the license server.
-         */
         licenseUri: string;
-        /**
-         * Additional headers to include in the license request.
-         */
         licenseRequestHeaders: {
             [key: string]: string;
         };
@@ -1815,42 +1083,16 @@ type DrmScheme = 'CommonPSSH' | 'ClearKey' | 'Widevine' | 'PlayReady' | AnyStrin
 
 type AnyString = string & {};
 
-/**
- * Available options for stream function `play()`.
- */
 interface IStreamOptions extends IOptions {
-    /**
-     * Protocol that the stream is using.
-     *
-     * Note: Not all protocols are supported by all devices.
-     *
-     * Allowed values are: HLS, RTP, HTTP, UDP, RTMP, RTSP
-     */
     protocol?: keyof typeof StreamProtocol | string;
-    /**
-     * Automatically reconnect stream when it disconnects.
-     * @default false
-     */
     autoReconnect?: boolean;
-    /**
-     * Interval in milliseconds between reconnect attempts.
-     * @default 30000
-     */
     autoReconnectInterval?: number;
+    lowLatency?: boolean;
 }
 
 interface IOptions {
-    /** @deprecated */
     '4k'?: boolean;
-    /**
-     * Prepare stream or video in background.
-     * @default false
-     */
     background?: boolean;
-    /**
-     * Initial volume value of the stream.
-     * @default 100
-     */
     volume?: number;
 }
 
@@ -1916,9 +1158,6 @@ The `resetTrack()` method resets a selected track of a stream.
 ```ts expandable
 resetTrack(videoId: IVideoProperties, trackType: TrackType, groupId?: string): Promise<void>;
 // show-more
-/**
- * Video properties interface for defining the properties of a played video.
- */
 interface IVideoProperties {
     uri: string;
     x: number;
@@ -1927,9 +1166,6 @@ interface IVideoProperties {
     height: number;
 }
 
-/**
- * Available track types for media streams.
- */
 type TrackType = 'TEXT' | 'AUDIO' | 'VIDEO';
 
 ```
@@ -2006,9 +1242,6 @@ The `selectTrack()` method selects a text (subtitles), video or audio track of a
 ```ts expandable
 selectTrack(videoId: IVideoProperties, trackType: TrackType, groupId: string, trackIndex: number): Promise<void>;
 // show-more
-/**
- * Video properties interface for defining the properties of a played video.
- */
 interface IVideoProperties {
     uri: string;
     x: number;
@@ -2017,9 +1250,6 @@ interface IVideoProperties {
     height: number;
 }
 
-/**
- * Available track types for media streams.
- */
 type TrackType = 'TEXT' | 'AUDIO' | 'VIDEO';
 
 ```