Your Digital Media Has Never Looked So Good

 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

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

Tue May 06, 2014 10:10 am

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.
Last edited by EnTerr on Wed Jul 27, 2016 10:18 am, edited 6 times in total.
 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

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

Wed Jun 11, 2014 1:08 pm

 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

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

Wed Jul 02, 2014 12:44 am

 
belltown
Posts: 1422
Joined: Thu Dec 09, 2010 1:43 pm
Contact:

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

Wed Jul 30, 2014 4:07 pm

IsButtonPressed() documentation is missing from roImageCanvasEvent, http://sdkdocs.roku.com/display/sdkdoc/roImageCanvasEvent.
https://github.com/belltown/
 
belltown
Posts: 1422
Joined: Thu Dec 09, 2010 1:43 pm
Contact:

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

Wed Aug 20, 2014 7:07 pm

In the Component Reference under roAppManager, http://sdkdocs.roku.com/display/sdkdoc/roAppManager, SpringboardDirectorLabel, should read SpringboardDirectorText.
https://github.com/belltown/
 
belltown
Posts: 1422
Joined: Thu Dec 09, 2010 1:43 pm
Contact:

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

Wed Aug 20, 2014 11:36 pm

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

- IsStreamStarted () [Type=20]
- IsFormatDetected () [Type=33]
https://github.com/belltown/
 
belltown
Posts: 1422
Joined: Thu Dec 09, 2010 1:43 pm
Contact:

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

Mon Aug 25, 2014 2:51 pm

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#p317734
https://github.com/belltown/
 
belltown
Posts: 1422
Joined: Thu Dec 09, 2010 1:43 pm
Contact:

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

Mon Aug 25, 2014 4:08 pm

Fixed: In the Component Reference, the roSearchScreen component has no Supported Events section and no link to the roSearchScreenEvent.
https://github.com/belltown/
 
User avatar
Komag
Posts: 649
Joined: Fri Aug 22, 2014 3:42 am

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

Tue Aug 26, 2014 3:50 am

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()
 
belltown
Posts: 1422
Joined: Thu Dec 09, 2010 1:43 pm
Contact:

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

Sun Sep 07, 2014 7:57 pm

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/
 
belltown
Posts: 1422
Joined: Thu Dec 09, 2010 1:43 pm
Contact:

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

Fri Sep 12, 2014 1:23 pm

In the Component Reference, ifPosterScreen.SetListStyle() lists the "rounded-rect-16x9-generic" poster style, which is not implemented for the roPosterScreen component, only on the roSpringboard.

See http://forums.roku.com/viewtopic.php?p=250840
https://github.com/belltown/
 
 
belltown
Posts: 1422
Joined: Thu Dec 09, 2010 1:43 pm
Contact:

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

Sun Sep 21, 2014 10:23 am

In the BrightScript Language Reference, section 4.12 Script Libraries, the line:
bslCore = ReadAsciiFile("common:/LibCore/1.0/bslCore.brs")

should read:
bslCore = ReadAsciiFile("common:/LibCore/v30/bslCore.brs")
https://github.com/belltown/
 
belltown
Posts: 1422
Joined: Thu Dec 09, 2010 1:43 pm
Contact:

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

Wed Sep 24, 2014 12:04 am

In the Component Reference, isRemoteKeyPressed is missing from the roListScreenEvent documentation.
https://github.com/belltown/
 
User avatar
Komag
Posts: 649
Joined: Fri Aug 22, 2014 3:42 am

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

Tue Jan 20, 2015 2:29 pm

FIXED
In Brightscript Language Reference, section FOR EACH, brackets are used instead of parentheses:
http://sdkdocs.roku.com/display/sdkdoc/ ... emINobject

In the Example, for deleting a key is says:
aa.delete[n]
should be
aa.delete(n)

Who is online

Users browsing this forum: No registered users and 3 guests