Skip to end of metadata
Go to start of metadata

APIs that have been deprecated should not be used. If you use an API after it is deprecated, your channel may not pass certification.

Table of Contents


By removing these components from your channel proactively, you will ensure your channel is unaffected by the deprecation process. The Roku OS Release Notes document which APIs are being deprecated with each release.

Deprecation schedules

For some APIs there is a two-year deprecation schedule to give developers time to transition:

  • July 1, 2017: All new channels must use SceneGraph or Direct Publisher
  • January 1, 2018: All channel updates must use SceneGraph or Direct Publisher

 

Below is a list of the legacy visual screen and associated event components that are deprecated according to this schedule. 

 

Deprecated runtime function Eval()

Eval() 

Eval() is deprecated effective immediately. All use of Eval() should be removed from BrightScript usage.

As described in Roku Channel Manifest:

  • In Roku OS 9 with rsg_version=1.2, use of the runtime function Eval() will result in a compile time error.
  • In Roku OS 9 other usage of Eval() is not thread-safe and may result in runtime errors.

Deprecated fields, methods and attributes

Fields, methods or attributes can be deprecated for a component that is itself not deprecated. 

ifDeviceInfo

Several properties of ifDeviceInfo have been deprecated and will be removed from the firmware in the Spring 2019 OS update.

These methods of ifDeviceInfo have been replaced with similar methods as of Roku OS 8.1.

Deprecated method

Replacement method

GetDrmInfo()

GetDrmInfoEx()

GetAdvertisingId()

GetRIDA()

IsAdIdTrackingDisabled()

IsRIDADisabled()

GetClientTrackingId()

GetChannelClientId()

GetDeviceUniqueId()

GetChannelClientId()

ifUrlTransfer 

One method is deprecated UrlEncode(url as String).  

roAudioPlayerEvent 

Several fields have been deprecated. 

Deprecated components

 

ifCaptionRenderer

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifCodeRegistrationScreen

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifFontMetrics

This interface is deprecated. Developers should use the roFont methods (GetOneLineHeight and GetOneLineWidth). 

ifGridScreen 

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifImageCanvas

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifKeyboardScreen

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifListScreen

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifMessageDialog

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifOneLineDialog 

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifParagraphScreen

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifPinEntryDialog 

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifPosterScreen

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifSearchHistory

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifSearchScreen

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifSlideShow

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifSpringboardScreen 

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifTextScreen

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

ifVideoScreen

This interface is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roCaptionRenderer

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roCaptionRendererEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roCodeRegistrationScreen

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roCodeRegistrationScreenEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roFontMetrics

This component is deprecated. Developers should use roFont methods (GetOneLineHeight and GetOneLineWidth). 

roGridScreen

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roGridScreenEvent 

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roImageCanvas

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roImageCanvasEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roKeyboardScreen

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roKeyboardScreenEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roListScreen 

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roListScreenEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roMessageDialog

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roMessageDialogEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roOneLineDialog

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roOneLineDialogEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roParagraphScreen

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roParagraphScreenEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roPinEntryDialog

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roPinEntryDialogEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roPosterScreen

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roPosterScreenEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roSearchHistory

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roSearchScreen 

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roSearchScreenEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roSlideShow

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roSlideShowEvent 

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roSpringboardScreen

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roSpringboardScreenEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roTextScreen

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roTextScreenEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roVideoScreen

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

roVideoScreenEvent

This component is deprecated. Beginning July 1st, 2017, any new channels using this component will be rejected during certification.

 

  • No labels