Roku Developer Program

Developers and content creators—a complete solution for growing an audience directly.
cancel
Showing results for 
Search instead for 
Did you mean: 
EnTerr
Level 8

SDK documentation: links to fix, missing/broken/etc

Starting this thread to enumerate issues in the docs that have to be fixed. There is a bunch of these suckers, which is annoyance but more importantly stops in their tracks novices, who are not used to such quirks (example). So let's list them here so they will be fixed... "inshallah".

I'll start with

  • much rejoicing: Screensaver documentation is apparently M.I.A., needs to be added to wiki. See viewtopic.php?f=34&t=69276#p439457


  • fixed: roChannelStore, ifGetMessagePort/ifSetMessagePort links are broken


  • fixed roTextureManager does not list "Supported Events" (compare). It has associated port (if?etMessagePort) and should point to what it may get. There is at least one event it gets, roTextureRequestEvent - it should be linked from that page.


  • ifMessageDialog fails to mention which methods are not available in fw3. For details, see viewtopic.php?f=34&t=69825#p441250 [Would be nice if the documentation mentioned this but Firmware 3.x is deprecated so probably this will not happen - RokuJoel]


  • Does roTextureManager really maintain LRU cache of resources, flushing the old ones as not to run out of memory (if so should be documented!) - or is it an urban legend? See viewtopic.php?f=34&t=69730#p441106


  • fixed Nov'14 roOneLineDialogEvent info seems to mislead on support for buttons, see viewtopic.php?f=34&t=69839


  • ifListScreen apparently does not support SetBreadcrumbText() in fw3, document it; viewtopic.php?f=34&t=69948
    [Again, unlikely that we will address this as fw 3.x is deprecated - RokuJoel]

Please add further your discoveries.
0 Kudos
118 Replies
EnTerr
Level 8

Re: SDK Docs: links to fix, missing/broken/etc

0 Kudos
EnTerr
Level 8

Re: SDK Docs: links to fix, missing/broken/etc

0 Kudos
belltown
Level 7

Re: SDK Docs: links to fix, missing/broken/etc

IsButtonPressed() documentation is missing from roImageCanvasEvent, http://sdkdocs.roku.com/display/sdkdoc/roImageCanvasEvent.
https://github.com/belltown/
0 Kudos
belltown
Level 7

Re: SDK Docs: links to fix, missing/broken/etc

In the Component Reference under roAppManager, http://sdkdocs.roku.com/display/sdkdoc/roAppManager, SpringboardDirectorLabel, should read SpringboardDirectorText.
https://github.com/belltown/
0 Kudos
belltown
Level 7

Re: SDK Docs: links to fix, missing/broken/etc

In the Component Reference, under roAudioPlayerEvent, the following events are not documented:

- IsStreamStarted () [Type=20]
- IsFormatDetected () [Type=33]
https://github.com/belltown/
0 Kudos
belltown
Level 7

Re: SDK Docs: links to fix, missing/broken/etc

Fixed: In the Component Reference, the ifVideoScreen documentation for SetPreviewMode() does not describe that the effect of SetPreviewMode (true) is to disable the FF and REW keys.

See also http://forums.roku.com/viewtopic.php?f=34&t=46771&start=0&sid=f1b26fed7d6f1316bf8d45bcce0fcdb1#p3177...
https://github.com/belltown/
0 Kudos
belltown
Level 7

Re: SDK Docs: links to fix, missing/broken/etc

Fixed: In the Component Reference, the roSearchScreen component has no Supported Events section and no link to the roSearchScreenEvent.
https://github.com/belltown/
0 Kudos
Komag
Level 9

Re: SDK Docs: links to fix, missing/broken/etc

Fixed:
On docs page:
http://sdkdocs.roku.com/display/sdkdoc/roFont
In the example
h = font.GetOneLineHeight(text)

crashes brightscript with error "Member function not found in BrightScript Component or interface"
correct code is:
h = font.GetOneLineHeight()
0 Kudos
belltown
Level 7

Re: SDK Docs: links to fix, missing/broken/etc

roDouble is not documented in the Component Reference.

Fixed: Also, in the BrightScript Language Reference, in Section 3.3 Literals (Constants), there is an example of a Double literal containing two decimal points: .2.3#
I know it's a "Double" , but I didn't think that meant it had double the number of decimal points.
https://github.com/belltown/
0 Kudos