Roku SDK Documentation : ifSlideShow

Implemented By

• roSlideShow

Supported Methods

Description of Methods

SetContentList(contentList as Object) as Void

Set the content to be played by the slide show. The caller passes an roArray of roAssociativeArrays (Content Meta-Data objects) representing the information for each title to be displayed on screen. 

AddContent(contentItem as Object) as Void

Add a new Content Meta-Data item to the content list for the slide show. New items are added to the end of the list.

ClearContent() as Void

Clear all content from the content list.

CountButtons() as Integer

Returns the count of all buttons added to the slide show screen

SetNext(item as Integer, isImmediate as Boolean) as Void

Tells the SlideShow object to queue a particular slide up as the next slide. item is the zero-based index of the item in the content list.  If isImmediate is true it forces an immediate update.

SetPeriod(seconds as Integer) as Void

Defines the number of seconds that each slide is displayed.

SetTextOverlayHoldTime(Integer milliSeconds) as Void

Defines the number of milliseconds to display the text overlay for each slide. If set to zero, the overlay is off.

Pause() as Boolean

Put the slide show into pause mode.

It is an error to Pause if player is not in play mode.

Resume() as Boolean

Put slide show into play mode starting from the pause point.

It is an error to Resume from any other mode than Pause.

SetTextOverlayIsVisible(IsVisible as Boolean) as Void

If IsVisible is true, display the overlay. If IsVisible is false do not display the overlay. Note that it is OR'd with the overlay hold time. So even if IsVisible is false, during the slide's overlay hold time the overlay is displayed.

AddButton(id as Integer, title as String) as Boolean

Adds a button to the screen identified by the title and ID provided. The buttons are displayed in a standard location on the screen and appear in the order added. The ID is defined by the developer and used to uniquely identify the button instance. When the button is pressed, the script will receive an event from the application containing the ID of the button pressed.

AddRatingButton(id as Integer, rating as Integer) as Boolean

Adds a star rating button to the screen. The rating is specified as a String that's value is an integer 1-100 which indicates the number of stars (1 to 5) to be displayed. Think of this as a percentage value <20% = 1 star, This button is displayed in a standard location on the screen and appear in the order added.

ClearButtons() as Void

Clears all of the buttons from the screen and resets the array of buttons back to default with no buttons set.

SetUnderscan(percentage as Float) as Void

Set the percentage to reduce the image size by to compensate for monitor overscan. E.g. 2.5 for 2.5%

SetDisplayMode(displayMode as String) as Void

Sets the mode for displaying slideshow images. This allows images to be either scaled to completely fill the screen (scale-to-fill) or scaled to fit inside the screen (scale-to-fit) while maintaining aspect ratio. Valid display modes are:

• scale-to-fill – scale image to completely fill the rectangle of the bounding frame (Default)
• scale-to-fit – scale image to fit horizontally or vertically as appropriate while still maintaining aspect ratio. Note that scale-to-fit may result in pillar-box or letter-box display of images.
• zoom-to-fill – scales and crops image to maintain aspect ratio and completely fill the rectangle of the bounding frame.
• photo-fit – Uses several methods to fit the image with a different aspect ratio to the screen. First, it will asymmetrically scale up to a maximum of 5%. Second, for landscape images, if vertical cropping is necessary, it will remove two lines off the bottom for every one line off the top up to a maximum of 30% of the image. For all images, if horizontal cropping is necessary it will crop an equal amount from both sides.

SetMaxUpscale(maxUpscale as Float) as Void

Set the maximum scale factor for scale-to-fill, zoom-to-fill, and photo-fit modes.

GetMaxUpscale() as Float

Get the maximum scale factor.]

Show() as Boolean

Display or refresh the screen after creation or state changes.

Close() as Void

Close the screen and delete the associated object. Useful for avoiding screen flicker when the display order of your screens does not resemble a stack.

SetBorderColor(color as String) as Void

Set the border color used as background around slide to passed color string containing the HTML Hex color value.  

SetLoop(loop as Boolean) as Void

If loop is set to true, the slide show will loop through all the slides.