EnTerr
Roku Guru
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
05-06-2014
10:10 AM
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
Please add further your discoveries.
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.
119 REPLIES 119
EnTerr
Roku Guru
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
06-11-2014
01:08 PM
Re: SDK Docs: links to fix, missing/broken/etc
- Fixed:
roRegistry, broken outbound link for "developer ID" - Fixed:
roRegistrySection is case-sensitive re both key and section names, document it (first mention @squirreltown) - roScreen (perhaps) - explain how video vs graphics planes overlay, see viewtopic.php?f=34&t=70763#p445279
- Channel Packaging And Publishing - the link https://owner.roku.com/Developer/Home/ is broken
- fixed:
Section "2.5 Entry Points" (RunUserInterface() et al) from legacy PDFs is missing in web docs, needs to be added. See viewtopic.php?f=34&t=71418 - fixed:
Need to document MoveFile(), see here viewtopic.php?f=34&t=71419 - Fixed:
roListScreen does not show getMessagePort()/setMessagePort() as supported methods.
EnTerr
Roku Guru
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
07-02-2014
12:44 AM
Re: SDK Docs: links to fix, missing/broken/etc
- roListScreen does not list which content attributes it supports, see viewtopic.php?f=34&t=62522#p447839
- roTextScreen page needs screenshot/mockup shown, like the other screens
- global function tr() is undocumented, see viewtopic.php?f=34&t=69524#p440133
- ifSpringboardScreen.SetDisplayMode() has the wrong explanation, see viewtopic.php?f=34&t=71657#p448009
belltown
Roku Guru
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
07-30-2014
04:07 PM
Re: SDK Docs: links to fix, missing/broken/etc
belltown
Roku Guru
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-20-2014
07:07 PM
Re: SDK Docs: links to fix, missing/broken/etc
belltown
Roku Guru
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-20-2014
11:36 PM
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]
- IsStreamStarted () [Type=20]
- IsFormatDetected () [Type=33]
belltown
Roku Guru
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-25-2014
02:51 PM
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...
See also http://forums.roku.com/viewtopic.php?f=34&t=46771&start=0&sid=f1b26fed7d6f1316bf8d45bcce0fcdb1#p3177...
belltown
Roku Guru
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-25-2014
04:08 PM
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.

Komag
Roku Guru
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-26-2014
03:50 AM
Re: SDK Docs: links to fix, missing/broken/etc
Fixed:
On docs page:
http://sdkdocs.roku.com/display/sdkdoc/roFont
In the example
crashes brightscript with error "Member function not found in BrightScript Component or interface"
correct code is:
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()
belltown
Roku Guru
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
09-07-2014
07:57 PM
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.
Fixed:
I know it's a "Double" , but I didn't think that meant it had double the number of decimal points.