LottieOverlay.Builder

Kotlin |Java

class LottieOverlay.Builder

A builder for LottieOverlay instances.

Summary

Public constructors
`Builder(lottieProvider: LottieOverlay.LottieProvider!)`

Public functions
`LottieOverlay!`	`build()`
`LottieOverlay.Builder!`	`@CanIgnoreReturnValue setLottieDrawable(lottieDrawable: LottieDrawable!)` Sets a specific `LottieDrawable` instance for the overlay.
`LottieOverlay.Builder!`	`@CanIgnoreReturnValue setOverlaySettings(overlaySettings: StaticOverlaySettings!)` Sets the `StaticOverlaySettings` to configure the overlay's visual properties.
`LottieOverlay.Builder!`	`@CanIgnoreReturnValue setSpeed(speed: Float)` Sets the animation playback speed multiplier.

Builder(lottieProvider: LottieOverlay.LottieProvider!)

fun build(): LottieOverlay!

@CanIgnoreReturnValue
fun setLottieDrawable(lottieDrawable: LottieDrawable!): LottieOverlay.Builder!

Sets a specific LottieDrawable instance for the overlay.

By default, an instance of LottieDrawable is created when build is called.

Parameters
`lottieDrawable: LottieDrawable!`	The specific `LottieDrawable` to use.

Returns
`LottieOverlay.Builder!`	This builder, for chaining.

@CanIgnoreReturnValue
fun setOverlaySettings(overlaySettings: StaticOverlaySettings!): LottieOverlay.Builder!

Sets the StaticOverlaySettings to configure the overlay's visual properties.

By default, an instance of build is used. This can be overwritten for the default settings like scale and position.

Parameters
`overlaySettings: StaticOverlaySettings!`	The settings object defining the overlay's static properties.

Returns
`LottieOverlay.Builder!`	This builder, for chaining.

@CanIgnoreReturnValue
fun setSpeed(speed: Float): LottieOverlay.Builder!

Sets the animation playback speed multiplier.

By default, the speed will be set to 1.0f (frames will be synced based on the lottie and playback framerate).

Parameters
`speed: Float`	The playback speed. Must be non-negative.

Returns
`LottieOverlay.Builder!`	This builder.