Amazon Developer

as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
Ring
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support
Native
Skip to main content
SplashScreenManager allows you to override control of the app’s native splash screen lifecycle, so you can force it to remain visible until it is explicitly hidden. Splash screens can be either static or animated. Both cases are achieved with .png images.

Assets

Splash screen assets are picked up by the native animation service on app launch. In order to configure them to be picked up, splash screen frame(s) need to be compressed into a .zip file along with a descriptor file.

Images

Mandatory Naming Conventions All splash screen images must follow this exact naming format:
  • Format: loopXXXXX.png
    • Where XXXXX is a 5-digit number starting from 00000
    • Numbers must be zero-padded
Example sequence: loop00000.png, loop00001.png, loop00002.png, etc.

Common mistakes to avoid

  • image0.png (incorrect naming)
  • loop1.png (missing zero padding)
  • loop_00001.png (incorrect underscore)
  • LOOP00001.png (incorrect capitalization)
If your application targets multiple devices, please ensure that the resolution of your splash screen images are appropriate for the target that demands the highest resolution.
  • Use .png image(s)
    • Single .png image for a static splash screen
    • Multiple .png images for an animated splash screen
    • Imag naming must follow the specified naming convention
  • Put your image(s) in a folder named _loop
    • Even if you only have one image, it needs to be put into _loop
    • To play the animation once and then hold on its final frame, split the frames across two folders instead. See Play once and hold the last frame.
  • Supported image resolutions
    • Multimodal profile: 960x480
    • TV profile: 1920x1080
Note: 4K resolution assets are not supported.

Example

Descriptor file

A descriptor file is needed to give the animation service some information about the native splash screen. Data such as image dimensions, fps, and settings for the splash screen can be specified here. This descriptor file will be compressed with your image folder or folders into a .zip for the animation service to pick up. To create a descriptor file, create a new .txt file and follow the instructions below:
  • Name your descriptor file desc.txt
  • First line should be image width, image height and desired fps separated by spaces
  • Each line after the first describes one part of the animation, in the form TYPE COUNT PAUSE FOLDER:
    • TYPE: c keeps the assets after it is done looping. p plays the part once and then continues to the next part.
    • COUNT: for a c part, 0 loops infinitely until terminated. See the following warning before using any other value.
    • PAUSE: fps delay until next command (not relevant for splash screen)
    • FOLDER: name of the folder holding that part’s images
A descriptor can describe more than one part. Use a single part to loop one folder of frames continuously, or two parts to play an animation once and then hold on a still frame.

Loop continuously

The following example sets the width to 480, the height to 128, and the fps to 30. The single c 0 0 _loop part loops the frames in _loop until the splash screen is dismissed.

Play once and hold the last frame

To play the animation exactly once and then hold on its final frame, split your images across two folders and give the descriptor two parts:
  • _anim holds the animation frames
  • _hold holds a single image, which is a copy of the final frame of _anim
  • p 1 0 _anim plays the frames in _anim once, then continues to the next part
  • c 0 0 _hold displays the single frame in _hold and holds it
The splash screen stays on that frame until your app dismisses it. Use usePreventHideSplashScreen() and useHideSplashScreenCallback() to control when that happens, as shown in Usage. Use the same image naming convention inside both folders. The following example shows the folder layout.

SplashScreenImages.zip

  • From your Terminal, navigate to the directory where your image folder or folders and desc.txt are located
  • Run zip SplashScreenImages.zip _loop/* desc.txt to create SplashScreenImages.zip
NOTE: on Mac, right-click and “Compress” can lead to an extra outer folder being created which will cause issues when the native service tries to locate the assets. Please use zip from the command line on the two individual items to avoid this issue.

Example

Example: play once and hold the last frame

For the two-part descriptor, list the folders in playback order so that _anim is added to the archive before _hold:

Placement in Package

  • If it does not exist, create directory:
  • Place SplashScreenImages.zip inside

Example

Usage

The following example shows the typical usage of the splash screen manager. The code uses KitchenSinkApp as a place holder component name. When implementing your splash screen, replace this with the appropriate component name.

Reference

Methods

preventAutoHideAsync()

Replaced by the usePreventHideSplashScreen() hook.
Override the automatic splash screen lifecycle which dismisses the splash screen when the first contentful frame is ready to render (at the end of the first set of mounting instructions). Invoking this API will prevent the splash screen for the module from being dismissed until hideAsync(moduleName) is explicitly invoked. For Vega SDK app developers, the moduleName parameter maps to the name field in your app’s app.json file. Users of this API are recommended to call it in global scope. Calling this in a React component or hook could lead to bugs if it causes this API to be called after the splash screen is already dismissed.

hideAsync()

Replaced by the useHideSplashScreenCallback() hook.
Hide the splash screen immediately. To avoid any flicker, be sure that your app content is ready to be displayed before invoking this method. For KeplerSDK app developers, the moduleName parameter maps to the name field in your app’s app.json file.

usePreventHideSplashScreen()

Overrides the automatic splash screen lifecycle which dismisses the splash screen when the first full content frame is ready to render (at the end of the first set of mounting instructions). Invoking this custom hook prevents the splash screen for the module from being dismissed. Note: Call this hook called in the root component of your application. Make sure to also obey the Rules of Hooks, when calling this hook.

useHideSplashScreenCallback()

Invoking this custom hook returns a callback function that, when invoked, hides the splash screen. Invoking the hook itself does not dismiss the splash screen. Call this hook in the root component of your application. Make sure to also obey the Rules of Hooks when calling this hook. While it is safe to invoke the callback multiple times, subsequent calls will lead to the app trying to dismiss a splash screen that is already dismissed. This will show up as error logs. To avoid this, ensure the callback returned from the hook is executed only once for your app. You can do this by adding the callback invocation inside of a useEffect hook.
Last modified on November 13, 2026