StartOffset

public value class StartOffset private constructor(internal val value: Long)

This class defines a start offset for repeatable and infiniteRepeatable. There are two types of start offsets: StartOffsetType.Delay and StartOffsetType.FastForward. StartOffsetType.Delay delays the start of the animation, whereas StartOffsetType.FastForward fast forwards the animation to a given play time and starts it right away.

Secondary Constructors

public constructor(
    offsetMillis: Int,
    offsetType: StartOffsetType = StartOffsetType.Delay,
) : this((offsetMillis * offsetType.value).toLong())

This creates a start offset for repeatable and infiniteRepeatable. offsetType can be either of the following: StartOffsetType.Delay and StartOffsetType.FastForward. offsetType defaults to StartOffsetType.Delay.

StartOffsetType.Delay delays the start of the animation by offsetMillis, whereas StartOffsetType.FastForward starts the animation right away from offsetMillis in the animation.

Properties

offsetMillis

public val offsetMillis: Int

Returns the number of milliseconds to offset the start of the animation.

offsetType

public val offsetType: StartOffsetType

Returns the offset type of the provided StartOffset.