Experimental

Observe Playback (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
timeoutFirstFrame	duration	Maximum time to wait until seeing the first frame. If the first frame is not seen within this time, the step will fail.	Yes	No
timeout	duration	Maximum playing time to check if the playback has any issues. If no issues are detected within this time, the step will pass.	Yes	No
qoeID	text	The QoE ID to use for the playback observer.	Yes	Yes
threshold	number	Distance threshold for frame comparison.	Yes	No
distance	enum	Select distance metric to use.	Yes	No

Outputs

Name	Type	Description
default	boolean	Is the playback successful?
videoInitialBufferTime	number	The initial buffer time of the video (in milliseconds).
videoStartTime	number	The starting time of the video
firstFrame	frame	The first frame when the measurement started.

HTTP Client (experimental)

Restrictions: "none"

Makes HTTP requests

Inputs

Name	Type	Description	Required	Dynamic
method	enum	The HTTP method to use for the request	Yes	No
url	text	The URL to send the request to	Yes	No
headers	code	A Lua table of HTTP headers to include in the request	No	No
body	code	The body of the request (for POST, PUT, etc.). Maximum size is 10 MB.	No	No
auth	code	Authentication details. Use { type = "basic", username = "user", password = "pass" } for Basic Auth, or { type = "bearer", token = "my-token" } for Bearer Token	No	No
params	code	A Lua table of query parameters to include in the URL	No	No
timeout	number	Request timeout in milliseconds	No	No
teleport	boolean	Enables teleport for the request. If enabled the request is made from the teleport location of the device.	Yes	No

Outputs

Name	Type	Description
default	code	The full response object or JQ transformed result
status	number	The HTTP status code of the response
body	code	The body of the response
error	string	Error message, if any

Detect Playback (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
timeout	duration	Fail if playback is not detected within this time.	Yes	No
detectMethod	enum	Select the method to use for detecting playback.	Yes	No
threshold	number	Distance threshold for frame comparison when detecting with Frame Distance method. Motion detection will use this value as the minimum percentage (0-100) of the motion area.	Yes	No
thresholdType	enum	Accumulated will sum the total distance from the first frame and compare it to the threshold value, while Single will only use the distance between current frame and the first frame. Only valid when using the Frame Distance detection method	Yes	No
distanceType	enum	Type of distance to use when comparing frames. Only valid when using the Frame Distance detection method	Yes	No
motionMetric	enum	Type of metric to use when comparing frames. Only valid when using the Video Motion detection method	Yes	No
stableFrames	number	Number of stable frames to wait for before detecting playback.	Yes	No
mode	enum	Detection mode to use when checking for playback. When audio is used for detecting, you can customize it with the audio level parameter.	Yes	No
mask	region	Specify an optional region to focus on when detecting video playback. If not specified, the entire screen will be used.	No	No
invertMask	boolean	When enabled, the content within the selected region will be ignored.	Yes	No
audioLevel	number	The minimum audio level (dB) to consider playback when checking audio.	Yes	No
audioPresent	boolean	Fail if audio is not detected.	Yes	No

Outputs

Name	Type	Description
default	boolean	Whether the playback was detected or not
time	number	The actual wait time (ms) until the first playback frame was detected
frame	image	Screen capture when playback was detected (or timed out)
distance	number	Accmulated distance when Threshold Type is set to Accmulated or the maximum single frame distance when Threshold Type is set to Single.
maxAudioLevel	number	The maximum audio level (dB) detected during playback