SplashScreenViewProvider


class SplashScreenViewProvider


Contains a copy of the splash screen used to create a custom animation from the splash screen to the application.

The splashscreen is accessible using SplashScreenViewProvider.view and the view containing the icon using SplashScreenViewProvider.iconView.

This class also contains time information about the animated icon (for API 31+).

The application always needs to call SplashScreenViewProvider.remove once it's done with it.

Summary

Public functions

Unit

Remove the SplashScreen's view from the view hierarchy.

Public properties

Long

Duration of the icon animation as provided in [R.attr.

Long

Start time of the icon animation.

View

The view containing the splashscreen icon as defined by R.attr.windowSplashScreenAnimatedIcon

View

The splash screen view, copied into this application process.

Public functions

remove

Added in 1.0.0
fun remove(): Unit

Remove the SplashScreen's view from the view hierarchy.

This always needs to be called when an androidx.core.splashscreen.SplashScreen.OnExitAnimationListener is set.

Public properties

iconAnimationDurationMillis

Added in 1.0.0
val iconAnimationDurationMillisLong

Duration of the icon animation as provided in [R.attr.

iconAnimationStartMillis

Added in 1.0.0
val iconAnimationStartMillisLong

Start time of the icon animation.

On API 31+, returns the number of millisecond since the Epoch time (1970-1-1T00:00:00Z)

Below API 31, returns 0 because the icon cannot be animated.

iconView

Added in 1.0.0
val iconViewView

The view containing the splashscreen icon as defined by R.attr.windowSplashScreenAnimatedIcon

view

Added in 1.0.0
val viewView

The splash screen view, copied into this application process.

This view can be used to create custom animation from the splash screen to the application