Your Digital Media Has Never Looked So Good

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

Bugs in Roku SDK Documentation

Mon Jan 16, 2012 5:43 pm

PS. decided just to rename this topic from "Mislabeled PDFs in SDK" to "bugs in documentation", so we can throw there discrepancies noticed instead of opening new threads silly.
--------

Noticed today some of the RokuSDK/documents/*.PDF have wrong titles as Adobe Reader is concerned.

When using "Search" to get all files containing term, I noticed same document names showed more than once in the result pane. Which is weird because hits are grouped together by PDF file. I saw that before but chalked it to be Adobe bug; today i investigated. To reproduce, select Search "All PDF documents in ... folder" and ask it to seach "Roku". Observe there are repeating document names, for example 3 "Roku Digital Video Player Getting Started"

It's a case of confused identity where the PDF has wrong Title/Subject inside (try File / Properties in Adobe to see that). No doubt happened because one document was copied and edited to make another doc but the metadata was not changed. Here is list of the offenders:
  • DeveloperGuide.pdf - thinks it is "Roku Digital Video Player Getting Started"
  • DesignGuidelines.pdf - "Roku Digital Video Player Getting Started"
  • EncodingGuide.pdf - "Roku Digital Video Player Getting Started"
  • ExternalControlGuide.pdf - "The BIF Archive Format Specification"
  • Roku Channel Developer Agreement and Program Requirements.pdf - "Roku® Digital Video Player"
  • ChannelPackagingAndPublishing.pdf - "Roku Digital Player Component Reference"
Roku*, please fix.

PS. Moot, since around 2013-05 there are no documentation PDFs, only confluence wiki
Last edited by EnTerr on Fri Jun 05, 2015 6:33 pm, edited 8 times in total.
 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

ifFunction.GetSub() return type [fixed 2014-03]

Thu Jan 19, 2012 9:41 pm

BS Reference manual, 10.11 claims that ifFunction.GetSub() returns String.

I spotted discrepancy between the types in GetSub and SetSub and tried to see. It does not - it returns "Function" (bsTypedValue).
Last edited by EnTerr on Fri Jun 05, 2015 6:18 pm, edited 1 time in total.
 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

Eval(codeStr) return type [fixed 2014-09]

Fri Jan 20, 2012 2:36 am

BSRef 6.6 says Eval() returns integer, "the same error codes are returned by GetLastRunTuntimeError()".

Except if there is problem parsing the snippet, then it seems to return GetLastRunCompileError() as roList of roAssociativeArrays. So the return type is "dynamic" at best
Last edited by EnTerr on Fri Jun 05, 2015 6:24 pm, edited 1 time in total.
 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

"roBrSub" type [moot since 2013-04]

Wed Jan 25, 2012 3:05 am

BSCompRef 3.0 mentions among core components one class "roBrSub" which is not explained anywhere nor is creatable by createobject().
wassat?!
Last edited by EnTerr on Fri Jun 05, 2015 6:25 pm, edited 1 time in total.
 
User avatar
gonzotek
** Valued Community Member **
Posts: 2206
Joined: Thu May 06, 2010 12:40 pm
Contact:

Re: "roBrSub" type

Wed Jan 25, 2012 7:08 am

EnTerr wrote:
BSCompRef 3.0 mentions among core components one class "roBrSub" which is not explained anywhere nor is creatable by createobject().
wassat?!
Confirmed, no mention in anywhere else in the pdfs or examples.
Remoku.tv - A free web app for Roku Remote Control!
Want to control your Roku from nearly any phone, computer or tablet? Get started at http://help.remoku.tv
by Apps4TV - Applications for television and beyond: http://www.apps4tv.com
 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

Re: "roBrSub" type

Wed Jan 25, 2012 12:32 pm

gonzotek wrote:
EnTerr wrote:
CompRef 3.0 mentions among core components one class "roBrSub" which is not explained anywhere nor is creatable by createobject().
wassat?!
Confirmed, no mention in anywhere else in the pdfs or examples.

maybe someone meant roFunction? roFunction is mentioned three times in BSRef and we know that "sub xxx" is shortcut for "function xxx as void"
BrightScript Debugger> ? box(function(): end function)
<Component: roFunction>
 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

None such "isStorageDeviceInserted()" [fixed 2015-06]

Mon Jan 30, 2012 8:21 pm

CompRef under "2.4 Event Loops", "Since Firmware version 2.6" mentions
Boolean isStorageDeviceInserted(Void)
but there is no such animal. CompRef 5.7, "roFileSystemEvent" describes instead
isStorageDeviceAdded()

- which exists.
Last edited by EnTerr on Fri Jun 05, 2015 6:28 pm, edited 1 time in total.
 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

WriteAsciiFile() description wrong [fixed 2013-11]

Tue Jan 31, 2012 7:43 pm

BSRef
7.8 WriteAsciiFile(filepath As String, buffer As String) As Boolean
This function reads the specified file and returns it as a string.
i'd venture guessing this writes instead but does it return something?
Last edited by EnTerr on Fri Jun 05, 2015 6:30 pm, edited 1 time in total.
 
ghartwig
Posts: 3
Joined: Tue Feb 28, 2012 9:11 pm

SpringboardDirectorLabel attribute

Mon May 07, 2012 2:02 am

Component Reference 4.1, section 4.2

SpringboardDirectorLabel — Does not work
SpringboardDirectorText — This seems to be the correct attribute name
 
rjdjohnston
Posts: 20
Joined: Sat May 30, 2015 6:24 pm
Contact:

Re: SpringboardDirectorLabel attribute

Tue Jun 02, 2015 9:59 pm

ghartwig wrote:
Component Reference 4.1, section 4.2

SpringboardDirectorLabel — Does not work
SpringboardDirectorText — This seems to be the correct attribute name


You're absolutely correct! How ridiculous is it that the documentation hasn't been updated after you reported back in 2012!!!!

Really sad how much of an after thought the programming side is for Roku. I don't expect iOS like documentation and features, but really.. can't afford someone to stay on-top of documentation and bug fixes?

Sad.
My channels: Amiri King, Donnie Baker, Worldview Weekend - Twitter @rjdjohnston
 
sjb64
Posts: 108
Joined: Thu Apr 16, 2015 1:13 pm
Location: Memphis, TN

Re: Bugs in Roku SDK Documentation

Wed Jun 03, 2015 7:42 am

Are the PDF's mentioned in Enterr's original post
RokuSDK/documents/*.PDF
still available somewhere for download so we have something to access when with the proxy server errors start acting up?
FlixRaider channel
 
User avatar
RokuKC
Posts: 315
Joined: Wed Sep 10, 2014 10:44 am
Location: Roku HQ

Re: Bugs in Roku SDK Documentation

Fri Jun 05, 2015 6:11 pm

Thanks for the feedback. Bug reports are always appreciated. :)

The roAppManager documentation has been updated to list "SpringboardDirectorText" as the key for overriding the "director" label on roSpringboardScreen, as opposed to the obsolete/non-functional key "SpringboardDirectorLabel".

I think the other documentation issues listed on this page have also been at least nominally addressed, most in the past, but please continue to point out issues.
 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

Re: Bugs in Roku SDK Documentation

Fri Jun 05, 2015 6:53 pm

RokuKC wrote:
Thanks for the feedback. Bug reports are always appreciated. :)
...
I think the other documentation issues listed on this page have also been at least nominally addressed, most in the past, but please continue to point out issues.

Image I checked and all items in current thread have been fixed! I marked fix in the [subject]. Took on average 2 years to address after report, which is not great timing but strangely i feel some satisfaction that some progress is being made.

Re other documentation issues, see this thread viewtopic.php?f=34&t=69731
 
EnTerr
** Valued Community Member **
Topic Author
Posts: 3834
Joined: Sun Jan 02, 2011 2:41 am

Re: Bugs in Roku SDK Documentation

Fri Jun 05, 2015 7:08 pm

sjb64 wrote:
Are the PDF's mentioned in Enterr's original post still available somewhere for download so we have something to access when with the proxy server errors start acting up?

No, such PDFs have not been published since 2013, when RokuCo switched to a "living document" model, which i think is for the better because documentation can be updated almost in real time (if there is a person to do it) instead of waiting for new SDK release.

It is a good question though, considering the documentation server sometimes kicks the bucket.
Luckily the Confluence wiki they use allows to export a snapshot of the documentation to a PDF!
 
sjb64
Posts: 108
Joined: Thu Apr 16, 2015 1:13 pm
Location: Memphis, TN

Re: Bugs in Roku SDK Documentation

Mon Jun 08, 2015 5:23 am

Never noticed that option, will defiantly take a look it at, just a nice backup doc to have.

Thanks
FlixRaider channel

Who is online

Users browsing this forum: No registered users and 9 guests