Skip to content

Latest commit

 

History

History
58 lines (51 loc) · 3.94 KB

limitations.md

File metadata and controls

58 lines (51 loc) · 3.94 KB
Raw

BrightScript Engine Current Limitations

There are several features from the BrightScript language and components that are still not supported, or just partially supported, some are planned to be implemented, others will stay as mock objects (for compatibility), and some are considered out of scope of this project. Below is the current list of those limitations:

In Scope (to be developed/fixed in future releases)

  • RSG (Roku SceneGraph) SDK components are not currently supported.
  • The following components are also not implemented yet:
    • roCECStatus
    • roAudioGuide
    • roDataGramSocket
    • roDSA
    • roHdmiStatus
    • roHttpAgent
    • roMicrophone
    • roRemoteInfo
    • roRSA
    • roSocketAddress
    • roStreamSocket
    • roSystemLog
    • roTextToSpeech
    • roTextureManager
    • roTextureRequest
  • Audio playback via roAudioResources and roAudioPlayer is implemented, but with some limitations:
    • Only one instance of roAudioPlayer is supported, if more are created those will share the content playlist.
    • If the roAudioPlayer instance is destroyed the audio keeps playing, make sure to call .stop() before discarding the object.
    • No Timed Metadata support.
  • The component roAudioMetadata only supports MP3 (for now) and the manifest entry requires_audiometadata=1 needs to be used.
  • The component roImageMetadata only supports JPEG images (for now).
  • Video playback via roVideoPlayer is implemented, but with some limitations:
    • If the roVideoPlayer instance is destroyed the video keeps playing, make sure to call .stop() before discarding the object.
    • The following methods are not supported, implemented as mock: setCGMS, setMaxVideoDecodeResolution, setTimedMetadataForKeys, getCaptionRenderer
    • Check what formats (container and codec) can be used on each browser, using roDeviceInfo.canDecodeVideo(), to make sure your video can be played.
    • DASH streams are not yet supported.
  • The component roUrlTransfer is implemented with basic functionality but has some limitations:
    • To make a web app access urls from domains other than the one it is hosted, requires the server called to respond with the header Access-Control-Allow-Origin, read more.
    • The async methods are actually synchronous and evaluated when WaitMessage or GetMessage are called.
    • If using async methods make sure to use a roMessagePort instance per roUrlTransfer, do not share.
    • Custom/Self-Signed SSL certificates are not supported, the engine will use default browser client certificate database.
    • As custom certificates are not supported these methods are just mocked and do nothing: EnablePeerVerification, EnableHostVerification, SetCertificatesDepth.
    • Cookies are only partially supported, if EnableCookies is called and EnableFreshConnection is set to false, then Cookies from previous calls will be preserved.
    • The other Cookies related methods are just mocked and do nothing: GetCookies, AddCookies, ClearCookies.
    • The following methods are also only mocked but do nothing: EnableResume, SetHttpVersion and SetMinimumTransferRate.
    • The method GetTargetIpAddress from roUrlEvent always returns an empty string.
  • Reserved words like Mod cannot be used as function parameters (Roku devices allows that).
  • SDK 1.0 deprecated components are not supported, but will be implemented in the future as a legacy apps preservation initiative.

In Scope (mocked)

  • RAF (Roku Ads Framework) object Roku_Ads is mocked with the most common methods available.
  • Channel Store components (roChannelStore and roChannelStoreEvent) are mocked (a fake server feature will be implemented in the future).
  • The component roAppManager is mocked with the exception of method GetUptime that returns a roTimeSpan as Roku does.

Out of Scope

  • Roku OS User Interface.
  • Roku Channel Store features.
  • Video playback with Ads.