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.

Legacy component to deprecate	Associated event component to deprecate
roCaptionRenderer	roCaptionRendererEvent
roCodeRegistrationScreen	roCodeRegistrationScreenEvent
roGridScreen	roGridScreenEvent
roKeyboardScreen	roKeyboardScreenEvent
roImageCanvas	roImageCanvasEvent
roListScreen	roListScreenEvent
roMessageDialog	roMessageDialogEvent
roOneLineDialog	roOneLineDialogEvent
roParagraphScreen	roParagraphScreenEvent
roPinEntryDialog	roPinEntryDialogEvent
roPosterScreen	roPosterScreenEvent
roSearchHistory
roSearchScreen	roSearchScreenEvent
roSlideShow	roSlideShowEvent
roSpringboardScreen	roSpringboardScreenEvent
roTextScreen	roTextScreenEvent
roVideoScreen	roVideoScreenEvent

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.

For Content Meta-Data several attributes have been deprecated.
For Roku Channel Manifest several attributes have been 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.

Roku SDK Documentation : Deprecated APIs

Deprecation schedules

Deprecated runtime function Eval()

Deprecated fields, methods and attributes

Deprecated components