@vindral/web-sdk 3.0.8 → 3.2.0

package/index.d.ts

@@ -597,11 +597,36 @@ interface SyncModuleStatistics {
 	timeshiftDriftAdjustmentCount: number;
 	seekTime: number;
 }
-interface UserAgentInformation {
-	userAgent: string;
-	locationOrigin: string;
-	locationPath: string;
-	ancestorOrigins?: string[];
+declare class UserAgentInformation {
+	private highEntropyValues?;
+	constructor();
+	getUserAgentInformation(): {
+		userAgentLegacy: string;
+		ua: {
+			browser: {
+				brands: string[];
+				fullVersionBrands: string[];
+				majorVersions: string[];
+			};
+			device: string;
+			os: {
+				family: string;
+				version: string;
+				major_version: number;
+			};
+		};
+		locationOrigin: string;
+		locationPath: string;
+		ancestorOrigins: string[] | undefined;
+		userAgent?: undefined;
+	} | {
+		userAgent: string;
+		locationOrigin: string;
+		locationPath: string;
+		ancestorOrigins: string[] | undefined;
+		userAgentLegacy?: undefined;
+		ua?: undefined;
+	};
 }
 declare type ModuleStatistics = AdaptivityStatistics & BufferTimeStatistics & ConnectionStatistics & ConstraintCapStatistics & DecoderStatistics & DocumentStateModulesStatistics & IncomingDataModuleStatistics & MseModuleStatistics & PlaybackModuleStatistics & QualityOfServiceModuleStatistics & RenditionsModuleStatistics & SyncModuleStatistics & TelemetryModuleStatistics & VideoPlayerStatistics;
 /**
@@ -612,7 +637,7 @@ declare type ModuleStatistics = AdaptivityStatistics & BufferTimeStatistics & Co
  *
  * @interface
  */
-export declare type Statistics = ModuleStatistics & UserAgentInformation & {
+export declare type Statistics = ModuleStatistics & ReturnType<UserAgentInformation["getUserAgentInformation"]> & {
 	/**
 	 * Version of the @vindral/web-sdk being used.
 	 */
@@ -737,6 +762,7 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	private cachedEdges;
 	private shiftedEdges;
 	private pool;
+	private userAgentInformation;
 	private sampleProcessingSesssions;
 	private sizes;
 	private isSuspended;
@@ -753,6 +779,13 @@ export declare class Vindral extends Emitter<PublicVindralEvents> {
 	 * Set the current volume.
 	 * Setting this to 0 is not equivalent to muting the audio.
 	 * Setting this to >0 is not equivalent to unmuting the audio.
+	 *
+	 * Note that setting volume is not allowed on iPadOS and iOS devices.
+	 * This is an OS/browser limitation on the video element.
+	 *
+	 * [Read more about it on Apple docs](https://developer.apple.com/library/archive/documentation/AudioVideo/Conceptual/Using_HTML5_Audio_Video/Device-SpecificConsiderations/Device-SpecificConsiderations.html)
+	 * for iOS-Specific Considerations. The following section is the important part:
+	 * ```On iOS devices, the audio level is always under the user's physical control. The volume property is not settable in JavaScript. Reading the volume property always returns 1.```
 	 */
 	set volume(volume: number);
 	/**