Site Logo

Screensaver

The basic screensaver policy of webOS TV is:

  • If there is no user action for a certain period of time, the screensaver starts.
  • One exception is that while video is being played in full screen, the screensaver does not appear.
Note

For how to make your app to play video in full screen, see FAQ.

On OLED TVs, the screensaver timeout is just a few minutes, meaning the screensaver starts shortly after the last user action, and it may harm the usability of some apps. To resolve this, webOS TV provides alternative options for such apps of extending the timeout at the cost of the lowered brightness.

The following sections will guide you to select the proper screensaver for your app and explain how to implement it.

Caution

Before submitting your app, read the following sections carefully and check if your app's screensaver configuration is properly set. If it is not, your app may not be published, as it greatly impacts your app's usability.

How to Determine Which Type to Use

Here's the guide on how to determine which type to use in your app.

  • If your app displays on-screen displays (OSD) or UI components while playing video, use the Type 2 screensaver.

    • A music app with the lyrics window
    • A singing (Karaoke) app
    • A video streaming app with a chat window
    • A fitness app that plays fitness video with control buttons on it

  • If your app displays images or still frames so there is almost no change to pixels on the screen, use the Type 3 screensaver.

    • A gallery app

  • If you app does not fall into the previous two categories, you do not need to add any screensaver property settings. By default, the basic screensaver policy will apply.

Note

Type 2 and Type 3 screensavers apply only to OLED TVs with webOS TV 5.0 or higher.

Type 2 Screensaver

The Type 2 screensaver lowers the brightness of the OSD area, where usually UI elements, such as lyrics and chatting windows, are displayed, and extends the screensaver timeout to 30 minutes. This lowering of the brightness applies only to the OSD area but not to the area where video is being played.

To use the Type 2 screensaver, you need to add the following line in the appinfo.json file.

      
       "screenSaverProperties": {"preferredType": 2},

The result will be:

  • The app enters foreground, and the brightness of the OSD area decreases gradually.
  • The brightness of the area where video is being played does not change.
  • If 30 minutes elapses without any user action, the screensaver starts.
  • If video is being played in full screen, the screensaver does not appear. But the brightness of the OSD area decreases gradually for 30 minutes and stays at that level.
  • If any user action, such as a key input, is detected while the brightness is decreasing, the brightness turns back to the initial state and the timeout count is reset.

Type 3 Screensaver

The Type 3 screensaver lowers the brightness of the entire area and extends the screensaver timeout to 30 minutes.

To use the Type 3 screensaver, you need to add the following lines in the appinfo.json file.


        "screenSaverProperties": {"preferredType": 3},
        "useGalleryMode": true,

The result will be:

  • The app enters foreground, and the brightness of the entire screen decreases gradually.
  • The screensaver starts after 30 mins. Even if any user action is detected while the brightness is decreasing, the brightness does not turn back to the initial state and the timeout count continues.
  • If video is being played in full screen, the screensaver does not appear. But the brightness of the entire area decreases gradually for 30 minutes and stays at that level.
  • The picture setting is automatically changed to the Gallery mode.
No Headings