Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

AttributeTypeDescriptionSample manifest entry
supports_input_launch
integer

8.0 release: The Roku mobile app (previously using roInputEvent) was changed recently to always use 'launch' events rather than 'input' events.
That means that Deep Link launches should always work, and with this attribute, the launch will no longer force exiting and restarting the app if it was already running roInputEvent is used to check whether a deep link has been passed into the application while your channel is running. This enables your application to deep link into content without re-launching your channel. This attribute must be added to the channel manifest for this functionality to work.

supports_input_launch=1
requires_audiometadataintegerThe roAudioMetadata component requires the use of a dynamically loaded library that is not part of the initially booted image. Therefore, an entry must be added to the manifest of any applications that use the roAudioMetadata component so that it can be loaded when the channel is launched.requires_audiometadata=1
requires_gaming_remoteintegerSpecifies that a gaming remote must be linked to the Roku Player to launch the application. If not, a dialog box is presented to the user.requires_gaming_remote=1
requires_mkvintegerPlaying MKV files requires the use of a dynamically loaded library that is not part of the initially booted image. Therefore, an entry must be added to the manifest of any applications that require MKV support so that support is enabled when the channel is launched.requires_mkv=1
network_not_requiredintegerSet to 1 to specify the application does not require the network (such as the USB Media Player). This lets the user launch an application even if there is no network connection.network_not_required=1
bs_libs_requiredstringSpecifies the BrightScript libraries required for the application.bs_libs_required=roku_ads_lib
usb_media_handlerintegerSet to 1 to specify if the channel can be auto-launched when a USB device is inserted.usb_media_handler=1

...

AttributeTypeDescriptionSample manifest entry
hiddenintegerThe hidden property tells the firmware to not display the app on the home screen. Hidden apps can still be launched over the network via the External Control API.hidden=1
playonly_awareintegerAttribute to specify the application responds to the Play Only remote control button event. If not set, the application will receive the Play event instead when the user selects the button.playonly_aware=1
rsg_versionvalue

Sets the SceneGraph observer callback model.

If using firmware v9 or above, please use rsg_version=1.2. This enables a new internal mechanism for processing component <script> tags that optimizes the resulting compiled script code resulting in a reduced initial startup time and lesser memory usage while preserving compatibility.

Note that evalEval() is not supported for "rsg_version=1.2". deprecated. Eval() is deprecatedcannot be used with rsg_version.

The manifest entry defaults to 1.1 as of firmware v7.5 if it's not specified in the manifest. 

Note

Please note that support for the “rsg_version=1.0” manifest flag is deprecated as of Roku OS 8. This deprecation means that the 1.0 features continue to work in Roku OS 8, but will no longer be supported (and thus should not be expected to work) starting with the next major firmware release. All channels will have to adopt the current observer callback model in successive firmware updates.

rsg_version=1.0
automatic_audio_guide_disabledintegerSet to 1 to disable Audio Guide within a channel.automatic_audio_guide_disabled=1
bs_prof_enabledbooleanEnable BrightScript profilingbs_prof_enabled=true
confirm_partner_buttoninteger

Available since firmware version 7.7

This new feature has been added that launches a confirmation dialogue before launching a channel when the user presses one of the four channel-specific buttons on the Roku remote. This minimizes the number of unintended channel launches after accidentally hitting a button while fast forwarding or rewinding content in a different channel.

When this manifest flag is set to “1” (confirm_partner_button=1), the OS will display a confirmation HUD (Head Up Display) any time the user presses a partner channel button while in that app. By default, the OS will always display this confirmation HUD when a partner button is pressed during video playback, regardless of if the manifest flag has been set.

confirm_partner_button=1  
suppress_unconnected_hud
integer

Available since firmware version 7.7

Manifest entry for overriding network connectivity HUD.

This attribute is used to override the system level display that indicates when media playback is interrupted due to network connection failures.

 

For more information on the connectivity HUD, please read the related support article

suppress_unconnected_hud=[1|0]

1 suppresses, 0 enables.

gameinteger

Available since firmware version 9 

All game channels must add the game manifest entry to their manifest file. This flag prevents the channel from having audio/sound effects delays in the game.

game=1

...