Configuration¶

The following parameters are available for the quality tests in their respective builders.

Android¶

Please refer to the documentation in docs (in the downloaded SDK files) for more details on the Java APIs.

Parameter	Type	Default Value	Description
`manifestUri`	String	None	The manifest URL to be tested (required)
`maxPlaybackDuration`	Integer	30000	Maximum playback duration in milliseconds
`maxTestDuration`	Integer	60000	Maximum test duration in milliseconds
`maxAnalysisDuration`	Integer	10000	Maximum analysis duration in milliseconds
`progressInterval`	Integer	1000	Progress interval in milliseconds

Parameter	Type	Default Value	Description
`url`	String	None	The URL to be tested (required)
`subject`	String	None	The subject to be tested (required)
`maxPlaybackDuration`	Integer	30000	Maximum playback duration in milliseconds
`maxTestDuration`	Integer	60000	Maximum test duration in milliseconds
`userAgent`	String	None	Override the WebView user agent (default agent if not set)

Parameter	Type	Default Value	Description
`url`	String	None	The URL to be tested (required)
`timeout`	Integer	30000	The timeout for the test in milliseconds
`userAgent`	String	None	Override the WebView user agent (default agent if not set)

Parameter	Type	Default Value	Description
`manifest`	URL	None	The manifest URL to be tested (required, passed to the builder's initializer)
`maxPlaybackDurationMs`	Int64	30000	Maximum playback duration in milliseconds
`maxTestDurationMs`	Int64	45000	Maximum test duration in milliseconds, must be at least `maxPlaybackDurationMs`
`maxAnalysisDurationMs`	Int64	10000	Maximum analysis duration in milliseconds
`progressIntervalMs`	Int	1000	Progress interval in milliseconds
`calculationSettings`	`[String: AnyHashable]`	Empty	P.1203 calculation settings, e.g. the `pv` and `pq` model names
`externalPlayer`	`AVPlayer`	None	Use an externally created `AVPlayer` instead of the internal one (not supported yet)
`attachToView`	`UIView`	None	Attach the player to a view so playback is visible during the test
`reportedDisplaySize`	Int, Int	1920x1080	Display size reported to P.1203, in device pixels
`metadata`	`[String: AnyHashable]`	Empty	Arbitrary key-value pairs stored alongside the measurement

externalPlayer and attachToView are mutually exclusive; setting both makes build() throw.

Parameter	Type	Default Value	Description
`url`	URL	None	The URL to be tested (required, passed to the builder's initializer)
`timeoutMs`	Int64	30000	The timeout for the test in milliseconds
`containerView`	`UIView`	None	The view the web view is added to, required for paint metrics
`metadata`	`[String: AnyHashable]`	Empty	Arbitrary key-value pairs stored alongside the measurement