Roku Developer Program

Join our online forum to talk to Roku developers and fellow channel creators. Ask questions, share tips with the community, and find helpful resources.
cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
joetesta
Roku Guru

Documentation & roListScreen

Forgive me if this has already been addressed.
In the currently available SDK http://wwwimg.roku.com/static/sdk/RokuSDK.zip, the documents folder no longer contains the Component Reference (or much of anything other than iphone docs...?).
In earlier versions of the SDK I downloaded, the component reference document is from 2011 and has no mention of roListScreen.
I found this online documentation: http://sdkdocs.roku.com/pages/viewpage. ... Id=3114132

Is there a downloadable document that describes the roListScreen; or is it time to abandon any downloaded documentation and refer to the online docs only?

tyvmia,
Joe
aspiring
0 Kudos
12 REPLIES 12
joetesta
Roku Guru

Re: Documentation & roListScreen

P.S. I'm currently looking at the "amazon instant video" home screen and wondering; how do they have the large image on the right, is it just using HDBackgroundImageUrl & SDBackgroundImageUrl set to the same image for each selection?
Will experiment but thanks in advance for any guidance.
aspiring
0 Kudos
RokuJoel
Binge Watcher

Re: Documentation & roListScreen

Hi, the online documentation at sdkdocs.roku.com is the documentation you should refer to. HDBackgroundImageUrl & SDBackgroundImageUrl are the correct parameters for the large images to display on the List Screen, and note they are justified to the upper right-hand corner of the screen.

- Joel
0 Kudos
malloys
Visitor

Re: Documentation & roListScreen

"joetesta" wrote:


Is there a downloadable document that describes the roListScreen; or is it time to abandon any downloaded documentation and refer to the online docs only?


If too many people do this too often, I'd imagine it may cause problems, but...
If you really need to download an offline copy, go here and click one of the export options in the left side panel: http://sdkdocs.roku.com/spaces/viewspacesummary.action?key=sdkdoc

cheers
0 Kudos
EnTerr
Roku Guru

Re: Documentation & roListScreen

"joetesta" wrote:
Is there a downloadable document that describes the roListScreen; or is it time to abandon any downloaded documentation and refer to the online docs only?

I recommend you stick to the online documentation (also known as "the wiki" or "the confluence one"), it is being updated on-the-fly and is the most current one. Since a year ago or more, no formal PDFs are being cut on releases but even if they were, they'd age fast. So the wiki is a good thing.

Note i can't say "throw away the old PDFs", since not everything has been transferred faithfully - recent examples, list of language reserved words and screensaver doc were/are missing. But those are rare exceptions, your first stop for docs should be http://sdkdocs.roku.com/ and only after that consult more obscure sources (this forum included by the way - some things can be learnt only here, shhht).
0 Kudos
joetesta
Roku Guru

Re: Documentation & roListScreen

Thanks!

It seems like the user can't go anywhere from the top of the list; would be nice if it took them out of the screen or back to the bottom of the list. Is there anything for the ListScreen that gives "Developer control of the Up button behavior on the top row" similar to what we have with the Grid Screen?
aspiring
0 Kudos
RokuJoel
Binge Watcher

Re: Documentation & roListScreen

Yes, same thing as with roGridScreen: screen.setupBehaviorAtTopRow("exit")

Since 5.3 (I think) and latest 3.1 firmware release a few months ago.

- Joel
0 Kudos
EnTerr
Roku Guru

Re: Documentation & roListScreen

ifListScreen.setupBehaviorAtTopRow() is documented in the RTFM, circa Oct'2013. Credit goes to RokuRobB
0 Kudos
joetesta
Roku Guru

Re: Documentation & roListScreen

For some reason the "ifListScreen" link on this page that I'd found earlier doesn't go anywhere, http://sdkdocs.roku.com/pages/viewpage. ... Id=3114132
So I didn't find this before, this helps a lot - thanks guys!
aspiring
0 Kudos
EnTerr
Roku Guru

Re: Documentation & roListScreen

"joetesta" wrote:
For some reason the "ifListScreen" link on this page that I'd found earlier doesn't go anywhere, http://sdkdocs.roku.com/pages/viewpage. ... Id=3114132
So I didn't find this before, this helps a lot - thanks guys!

Yeah, that one is a broken link. Hopefully Roku* will fix it on account of your wasted time.

Couple of tips if future problems: you can start typing "ifLis"... in the upper-right corner of the doco wiki and it will suggest topics - or just google "ifListScreen" and it pops.
0 Kudos