progress

abstract fun progress(payload: ByteArray, elapsedTime: Duration, macroContext: MacroContext?): ByteArray

Fires any quartile / progress tracking URLs whose threshold has been reached at elapsedTime.

Intended to be called periodically while the ad is playing. The engine uses elapsedTime to determine which progress events (firstQuartile, midpoint, thirdQuartile, complete, custom progress offsets) should be fired this tick.

Return

an updated payload reflecting the tracking state after the call.

Parameters

payload

serialized ad payload.

elapsedTime

time elapsed since the ad started playing.

macroContext

optional context used to expand tracking-URL macros.

Throws


abstract fun progress(payload: ByteArray, elapsedTime: Duration, macroContext: MacroContext?): ByteArray

Java-friendly overload of progress accepting a java.time.Duration.

See also