{ "generatedDate": "2025-10-10T15:16:43.437Z", "nodes": { "animation": { "description": "Extends [**AnimationBase**](https://developer.roku.com/docs/references/scenegraph/abstract-nodes/animationbase.md\n\nThe Animation node class provides animations of renderable nodes, by applying interpolator functions to the values in specified renderable node fields. For an animation to take effect, an Animation node definition must include a child field interpolator node ([FloatFieldInterpolator](https://developer.roku.com/docs/references/scenegraph/animation-nodes/floatfieldinterpolator.md\"FloatFieldInterpolator\"), [Vector2DFieldInterpolator](https://developer.roku.com/docs/references/scenegraph/animation-nodes/vector2dfieldinterpolator.md\"Vector2DFieldInterpolator\"), [ColorFieldInterpolator](https://developer.roku.com/docs/references/scenegraph/animation-nodes/colorfieldinterpolator.md\"ColorFieldInterpolator\")) definition for each renderable node field that is animated.\n\nThe Animation node class provides a simple linear interpolator function, where the animation takes place smoothly and simply from beginning to end. The Animation node class also provides several more complex interpolator functions to allow custom animation effects. For example, you can move a graphic image around the screen at differing speeds and curved trajectories at different times in the animation by specifying the appropriate function in the easeFunction field (quadratic and exponential are two examples of functions that can be specified). The interpolator functions are divided into two parts: the beginning of the animation (ease-in), and the end of the animation (ease-out). You can apply a specified interpolator function to either or both ease-in and ease-out, or specify no function for either or both (which is the linear function). You can also change the portion of the animation that is ease-in and ease-out to arbitrary fractional values for a quadratic interpolator function applied to both ease-in and ease-out.", "events": [], "extends": { "name": "AnimationBase", "url": "https://developer.roku.com/docs/references/scenegraph/abstract-nodes/animationbase.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "0", "description": "Sets the duration of the animation in seconds", "name": "duration", "type": "Time" }, { "accessPermission": "READ_WRITE", "default": "\"outCubic\"", "description": "Specifies the interpolator function to be used for the animation:\n\n| Value | Ease-In/Ease-Out Function |\n| --- | --- |\n| linear | No ease-in or ease-out |\n| inQuad | Quadratic ease-in function, no ease-out |\n| inCubic | Cubic ease-in function, no ease-out |\n| inQuartic | Quartic ease-in function, no ease-out |\n| inQuintic | Quintic ease-in function, no ease-out |\n| inExpo | Exponential ease-in function, no ease-out |\n| outQuad | Quadratic ease-out function, no ease-in |\n| outCubic | Cubic ease-out function, no ease-in |\n| outQuartic | Quartic ease-out function, no ease-in |\n| outQuintic | Quintic ease-out function, no ease-in |\n| outExpo | Exponential ease-out function, no ease-in |\n| inOutQuad | Quadratic ease-in and ease-out function |\n| inOutCubic | Cubic ease-in and ease-out function |\n| inOutQuartic | Quartic ease-in and ease-out function |\n| inOutQuintic | Quintic ease-in and ease-out function |\n| inOutExpo | Exponential ease-in and ease-out function |\n| piecewise | Quadratic ease-in and ease-out function with extra control over the percentage of the duration during which ease-in and ease-out occurs. The extra control is specified using the `easeInPercent` and `easeOutPercent` fields. |", "name": "easeFunction", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "0.5", "description": "If easeFunction is set to piecewise, easeInPercent sets the percentage of the animation duration during which ease-in is applied. Note that the values of easeInPercent plus easeOutPercent must be less than or equal to 1. For all other values of easeFunction, easeInPercent is ignored", "name": "easeInPercent", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "0.5", "description": "If easeFunction is set to piecewise, easeOutPercent sets the percentage of the animation duration during which ease-out is applied. Note that the values of easeInPercent plus easeOutPercent must be less than or equal to 1. For all other values of easeFunction, easeOutPercent is ignored", "name": "easeOutPercent", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Set to true to skip animations on lower performing Roku devices. See \\[Roku Devices\\](/docs/specs/hardware.md#current-models \"Roku Devices\") for model numbers and code names. When an Animation has optional set to true, setting the control field to start will cause the state field to change to running and immediately change again to finished. These state changes allow any logic tied to state field observers that run at the start and end of the Animation to be properly called", "name": "optional", "type": "boolean" }, { "accessPermission": "READ_ONLY", "default": "false", "description": "Indicates whether the animation runs or jumps to the end (effectively skipping the animation and rendering it in its final state).", "name": "willBeSkipped", "type": "boolean" } ], "interfaces": [], "name": "Animation", "url": "https://developer.roku.com/docs/references/scenegraph/animation-nodes/animation.md" }, "animationbase": { "description": "Extends [**Node**](https://developer.roku.com/docs/references/scenegraph/node.md\"**Node**\")\n\nAnimationBase is an abstract node class that contains the fields common to the [Animation](https://developer.roku.com/docs/references/scenegraph/animation-nodes/animation.md\"Animation\"), [SequentialAnimation](https://developer.roku.com/docs/references/scenegraph/animation-nodes/sequentialanimation.md\"SequentialAnimation\"), and [ParallelAnimation](https://developer.roku.com/docs/references/scenegraph/animation-nodes/parallelanimation.md\"ParallelAnimation\") nodes. The purpose of the AnimationBase node class is to provide the basic functionality needed to animate screen elements, such as moving them across the display screen, fading them in and out of view, or changing their color. All node classes extended from AnimationBase require the use of the interpolator node classes [FloatFieldInterpolator](https://developer.roku.com/docs/references/scenegraph/animation-nodes/floatfieldinterpolator.md\"FloatFieldInterpolator\"), [Vector2DFieldInterpolator](https://developer.roku.com/docs/references/scenegraph/animation-nodes/vector2dfieldinterpolator.md\"Vector2DFieldInterpolator\"), and [ColorFieldInterpolator](https://developer.roku.com/docs/references/scenegraph/animation-nodes/colorfieldinterpolator.md\"ColorFieldInterpolator\") as child nodes to achieve a specific animation effect.\n\n> AnimationBase is not meant to be instantiated directly by app code", "events": [], "extends": { "name": "Node", "url": "https://developer.roku.com/docs/references/scenegraph/node.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "none", "description": "Controls the animation. Supported options include:\n\n| Option | Effect |\n| --- | --- |\n| none | Initial state with no associated action |\n| start | Always plays the animation from the beginning |\n| stop | Stops the animation in its current state |\n| pause | Pauses the animation in its current state |\n| resume | If paused, resumes the animation from its current state. If the animation is not paused, plays the animation from the beginning. |\n| finish | Jumps to the end of the animation, then stops. All animated fields will be immediately set to their final values as if the animation had completed. |", "name": "control", "type": "option string" }, { "accessPermission": "READ_WRITE", "default": "0", "description": "Delays the start of the animation by the specified number of seconds", "name": "delay", "type": "time" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Controls whether the animation stops when it finishes (false) or repeats from the beginning (true)", "name": "repeat", "type": "Boolean" }, { "accessPermission": "READ_ONLY", "default": "stopped", "description": "Indicates the state of the animation. Values include:\n\n| Value | Meaning |\n| --- | --- |\n| running | Indicates that the animation is in progress |\n| paused | Indicates that the animation has been paused |\n| stopped | Indicates that the animation has either run to completion or has been explicitly stopped |", "name": "state", "type": "value string" } ], "interfaces": [], "name": "AnimationBase", "url": "https://developer.roku.com/docs/references/scenegraph/abstract-nodes/animationbase.md" }, "arraygrid": { "description": "Extends [**Group**](https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md\"**Group**\")\n\nThe ArrayGrid node class is an abstract base class that provides functionality to the list and grid node classes that are extended from ArrayGrid. The field value settings and their effect in this abstract base class depend in many cases on whether a list, or a grid, node class is extended from ArrayGrid, and the specific type of list or grid.\n\nThe following node classes extended from ArrayGrid derive their basic functionality from the ArrayGrid abstract node class:\n\n* [LabelList](https://developer.roku.com/docs/references/scenegraph/list-and-grid-nodes/labellist.md\"LabelList\")\n* [MarkupList](https://developer.roku.com/docs/references/scenegraph/list-and-grid-nodes/markuplist.md\"MarkupList\")\n* [PosterGrid](https://developer.roku.com/docs/references/scenegraph/list-and-grid-nodes/postergrid.md\"PosterGrid\")\n* [MarkupGrid](https://developer.roku.com/docs/references/scenegraph/list-and-grid-nodes/markupgrid.md\"MarkupGrid\")\n* [RowList](https://developer.roku.com/docs/references/scenegraph/list-and-grid-nodes/rowlist.md\"RowList\")\n\n> ArrayGrid is not meant to be instantiated directly by app code", "events": [], "extends": { "name": "Group", "url": "https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md" }, "fields": [ { "accessPermission": "WRITE_ONLY", "default": "0", "description": "When set to a valid item index, causes the list or grid to quickly scroll so that the item at the specified index moves into focus, or focus moves to the item", "name": "animateToItem", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "[]", "description": "Specifies differing spaces between each grid column, to allow the spacing between columns to vary from column to column. This field is not used by lists. The specified values override the itemSpacing field vector2d X-value for each grid column corresponding to its position in the array, in left to right order. If the array contains fewer elements than the number of columns needed to display all the items in the grid, the itemSpacing field vector2d X-value is used for any unspecified columns", "name": "columnSpacings", "type": "array of floats" }, { "accessPermission": "READ_WRITE", "default": "[]", "description": "Specifies differing widths for each grid column, to allow the width of each column to vary from column to column. This field is not used by lists. The specified values override the itemSize field vector2d X-value for each grid column corresponding to its position in the array, in left to right order. If the array contains fewer elements than the number of columns needed to display all the items in the grid, the itemSize field vector2d X-value is used for any unspecified columns", "name": "columnWidths", "type": "array of floats" }, { "accessPermission": "READ_WRITE", "default": "none", "description": "Specifies the content meta-data for the list or grid. This field must be set with a ContentNode that specifies the content meta-data for the list or grid in order for the list or grid to be displayed. See the Data Bindings section of each list or grid reference description for details on the content meta-data that must be specified in the ContentNode", "name": "content", "type": "ContentNode" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "Gives access to which column of a grid is in the focus position as the items scrolling around. So, currFocusColumn = 3.7 would mean that item 3 occupies 30% of the focus position while item 4 occupies 70% of the focus position. To maximize performance, the field should be kept to a minimum, as these scripts will run once during each render", "name": "currFocusColumn", "type": "float" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "This field provides access to the current opacity of the focus feedback indicator. It can be used to have other items on the screen fade in/out when the focus feedback indicator fades in/out.", "name": "currFocusFeedbackOpacity", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "Gives access to which row of a grid is in the focus position as the items scrolling around. So, currFocusRow = 3.7 would mean that item 3 occupies 30% of the focus position while item 4 occupies 70% of the focus position. To maximize performance, the field should be kept to a minimum, as these scripts will run once during each render", "name": "currFocusRow", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "Gives access to which section of a grid is in the focus position as the items scrolling around. So, currFocusSection = 3.7 would mean that item 3 occupies 30% of the focus position while item 4 occupies 70% of the focus position. To maximize performance, the field should be kept to a minimum, as these scripts will run once during each render", "name": "currFocusSection", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "true", "description": "Causes a specified bitmap to be drawn on list or grid items to indicate focus has moved to that item", "name": "drawFocusFeedback", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "If the drawFocusFeedback field value is set to true, specifies whether the specified focus indicator bitmap is drawn on top of the focused list or grid items. The default value draws the specified focus indicator bitmap below the focused list or grid item", "name": "drawFocusFeedbackOnTop", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "When set to true, the focus feedback indicator will quickly fade out when scrolling multiple items and fade back in when the scrolling ends. The focus feedback indicator will also after in and out when using the FFW/Rewind keys to scroll a page at a time. Additionally, the focus behavior has been modified for situations where all the items in a RowList row are visible on screen at once. In the past, the focus would step once, then begin to scroll smoothly. Now, the focus steps one-by-one through each item.", "name": "fadeFocusFeedbackWhenAutoScrolling", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Specifies that a grid will have a layout of items of different widths configured by parameters included in a ContentNode for the grid. This field is not used by lists", "name": "fixedLayout", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "0xFFFFFFFF", "description": "Blend the graphic image specified by focusBitmapUri with the specified color. If set to the default, 0xFFFFFFFF, no color blending will occur. Set this field to show a focus indicator graphic image with a different color than the image specified by focusBitmapUri", "name": "focusBitmapBlendColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "", "description": "If the drawFocusFeedback field value is set to true, specifies a custom bitmap to be drawn on list or grid items to indicate the focus has moved to that item. Only set this field to use a bitmap with a different appearance than the system default. In most cases, you will want to use a 9-patch PNG bitmap with both expandable regions as well as margins to fit around the item, which is the type of bitmap used as the system default", "name": "focusBitmapUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "0", "description": "Specifies the column that will have fixed focus for grids if the horizFocusAnimationStyle field value is set to fixedFocusWrap. This field is not used for lists", "name": "focusColumn", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "", "description": "If the drawFocusFeedback field value is set to true, specifies a custom bitmap to be drawn on list or grid items to indicate focus on that item, when the list or grid itself does not have focus. Only set this field to use a bitmap with a different appearance than the system default. In most cases, you will want to use a 9-patch PNG bitmap with both expandable regions as well as margins to fit around the item, which is the type of bitmap used as the system default", "name": "focusFootprintBitmapUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "0xFFFFFFFF", "description": "Blend the graphic image specified by focusFootprintBitmapUri with the specified color. If set to the default, 0xFFFFFFFF, no color blending will occur. Set this field to show a focus footprint indicator graphic image with a different color than the image specified by focusFootprintBitmapUri", "name": "focusFootprintBlendColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "0", "description": "Specifies the row that will have fixed focus if the vertFocusAnimationStyle field value is set to fixedFocusWrap", "name": "focusRow", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "floatingFocus", "description": "Specifies the how the focus indicator moves in a row of grid items in response to the remote direction pad Left and Right key presses. This field is not used for lists. The possible values are:\n\n| Option | Effect |\n| --- | --- |\n| floatingFocus | Causes the focus indicator to float left or right until it reaches the end of the row, at which point the focus indicator will stay fixed on the first or last item in the row, and the items will scroll left or right if there were items that were not visible. |\n| fixedFocusWrap | Causes the row to wrap around when the focus indicator reaches the first or last item in the row, as long as the row contains enough items to fill the row. If the row does not contain enough items to fill the row, the focus indicator will float left and right. |", "name": "horizFocusAnimationStyle", "type": "option string" }, { "accessPermission": "READ_WRITE", "default": "[ 0.0, 0.0, 0.0, 0.0 ]", "description": "Specifies a clipping region for the list or grid items", "name": "itemClippingRect", "type": "rect2d" }, { "accessPermission": "READ_WRITE", "default": "0", "description": "This field provides access to the current opacity of the focus feedback indicator. It can be used to have other items on the screen fade in/out when the focus feedback indicator fades in/out. Additionally, the focus behavior has been modified for situations where all the items in a RowList row are visible on screen at once. In the past, the focus would step once, then begin to scroll smoothly. Now, the focus steps one-by-one through each item.", "name": "itemcurrFocusFeedbackOpacity", "type": "Float" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "When focus moves to a list or grid item, set to the index of the focused item", "name": "itemFocused", "type": "integer" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "When a list or grid item is selected, set to the index of the selected item", "name": "itemSelected", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "[0,0]", "description": "Specifies the width and height of each item in the list or grid. For list or grid items that are posters, itemSize is the value of a basePosterSize field and any sub-elements included with the poster", "name": "itemSize", "type": "vector2d" }, { "accessPermission": "READ_WRITE", "default": "[0,0]", "description": "Specifies the horizontal and vertical spacing between the list or grid items. For lists, the vector2d Y-value specifies the vertical spacing between items in the list, and the vector2d X-value is ignored", "name": "itemSpacing", "type": "vector2d" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "When focus moves away from a list or grid item, set to the index of the unfocused item", "name": "itemUnfocused", "type": "integer" }, { "accessPermission": "WRITE_ONLY", "default": "0", "description": "When set to a valid item index, causes the list or grid to immediately update so that the item at the specified index moves into focus, or focus moves to the item", "name": "jumpToItem", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "0", "description": "Specifies the number of columns in a grid. This field is not used for lists", "name": "numColumns", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "1", "description": "Specifies the number of rendering operations to display a complex list or grid. This allows you to achieve a performance increase by specifying that individual sub-elements of the list or grid items occur on sequential rendering operations, rather than all of the item sub-elements being rendered in one rendering operation, which is the default. If you set this field to a value greater than 1, you must specify the rendering operation number for each of the item sub-elements as the renderPass field value for that sub-element. No sub-element that has a renderPass field value of 0 (the default), or has a renderPass field value greater than the value of the numRenderPasses field, will render", "name": "numRenderPasses", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "0", "description": "Specifies the number of visible rows displayed. Note that the actual number of rows may be more or less than the number specified depending on the number of items in the list or grid content", "name": "numRows", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "[]", "description": "Specifies differing heights for each list or grid row, to allow the height of each row to vary from row to row. The specified values override the itemSize field vector2d Y-value for each list or grid row corresponding to its position in the array, in top to bottom order. If the array contains fewer elements than the number of rows needed to display all the items in the list or grid, the itemSize field vector2d Y-value is used for any unspecified rows", "name": "rowHeights", "type": "array of floats" }, { "accessPermission": "READ_WRITE", "default": "[]", "description": "Specifies differing spaces between each list or grid row, to allow the spacing between rows to vary from row to row. The specified values override the itemSpacing field vector2d Y-value for each list or grid row corresponding to its position in the array, in top to bottom order. If the array contains fewer elements than the number of rows needed to display all the items in the list or grid, the itemSpacing field vector2d Y-value is used for any unspecified rows", "name": "rowSpacings", "type": "array of floats" }, { "accessPermission": "READ_ONLY", "default": "false", "description": "When the list or grid is scrolling, is set to true (undocumented).", "name": "scrollingStatus", "type": "boolean" }, { "accessPermission": "READ_WRITE", "default": "", "description": "If the ContentNode specifies sections for a list or grid, specifies a custom bitmap to use as a visual divider between the sections of the list or grid. Only set this field to use a bitmap with a different appearance than the system default. For sections that do not include an icon or a title, the system default or custom bitmap specified as the wrapDividerBitmapUri field value is used for the section dividers. In most cases, you will want to use a 9-patch PNG bitmap with both expandable regions, which is the type of bitmap used as the system default", "name": "sectionDividerBitmapUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "system default", "description": "If the ContentNode specifies sections for a list or grid, specifies a custom font to use for the section title text. Only set this field to use a different font than the system default", "name": "sectionDividerFont", "type": "font" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "If the ContentNode specifies sections for a list or grid, specifies the height of the section divider bitmap", "name": "sectionDividerHeight", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "If the ContentNode specifies sections for a list or grid, specifies the left offset of the section divider from the list or grid", "name": "sectionDividerLeftOffset", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "If the ContentNode specifies sections for a list or grid, specifies the minimum width of the section divider bitmap", "name": "sectionDividerMinWidth", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "If the ContentNode specifies sections for a list or grid, and the section dividers are specified to include an icon and/or a label, specifies the spacing between the icon, label, and section divider bitmap", "name": "sectionDividerSpacing", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "system default", "description": "If the ContentNode specifies sections for a list or grid, specifies a custom color to use for the section title text. Only set this field to use a different text color than the system default", "name": "sectionDividerTextColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "If the ContentNode specifies sections for a list or grid, specifies the width of the section divider bitmap", "name": "sectionDividerWidth", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Specifies whether changes in the focus item should be animated. If this field is set to true, any scrolling or repositioning/scaling of the focus indicator occurs without an animation. This causes fields reflecting the focus status (itemFocused, currFocusRow, currFocusColumn) to be updated instantly and not transition smoothly between old and new values. For example, currFocusRow will go directly from 3.0 to 4.0 instead of taking on values between 3.0 and 4.0.", "name": "skipFocusAnimations", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "floatingFocus", "description": "Specifies the how the focus indicator moves in a list or a column of grid items in response to the remote direction pad Up and Down key presses. The possible values are:\n\n| Option | Effect |\n| --- | --- |\n| floatingFocus | Causes the focus indicator to float up or down until it reaches the end of the list or grid column, at which point the focus indicator will stay fixed on the first or last item in the list or grid column, and the items will scroll up or down if there are items that were not visible. Note that when this style is set, section dividers are not rendered. |\n| fixedFocusWrap | Causes the column to wrap around when the focus indicator reaches the first or last item in the list or grid column, as long as the list or grid column contains enough items to fill the list or grid column. If the list or grid column does not contain enough items to fill the list or grid column, the focus indicator will float up and down. |\n| fixedFocus | Causes the focus to stay fixed on the upper leftmost item. As the user scrolls down, the row containing the previously selected item scrolls up off screen. Scrolling continues until the last row is reached. |", "name": "vertFocusAnimationStyle", "type": "option string" }, { "accessPermission": "READ_WRITE", "default": "", "description": "If the vertFocusAnimationStyle field value is set to fixedFocusWrap, specifies a custom bitmap to use as a visual divider between the last and first list or grid items, when the list or grid wraps. Only set this field to use a bitmap with a different appearance than the system default. In most cases, you will want to use a 9-patch PNG bitmap with both expandable regions, which is the type of bitmap used as the system default", "name": "wrapDividerBitmapUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "36", "description": "If the vertFocusAnimationStyle field value is set to fixedFocusWrap, specifies the height of a bitmap used as a visual divider between the last and first list or grid items, when the list or grid wraps. Only set this field to use a value with a different appearance than the system default", "name": "wrapDividerHeight", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "0", "description": "Additionally, the focus behavior has been modified for situations where all the items in a RowList row are visible on screen at once. In the past, the focus would step once, then begin to scroll smoothly. Now, the focus steps one-by-one through each item.If the vertFocusAnimationStyle field value is set to fixedFocusWrap, specifies the width of a bitmap used as a visual divider between the last and first list or grid items when the list or grid wraps. Only set this field to use a value with a different appearance than the system default", "name": "wrapDividerWidth", "type": "float" } ], "interfaces": [], "name": "ArrayGrid", "url": "https://developer.roku.com/docs/references/scenegraph/abstract-nodes/arraygrid.md" }, "audio": { "description": "Extends [**Node**](https://developer.roku.com/docs/references/scenegraph/node.md\n\nThe Audio node class plays streaming audio.\n\nThe Audio node class has no built-in visual UI, but you can build your own UI for the node, including trick play, or showing an album cover or similar graphical image for each song selected by a user.", "events": [], "extends": { "name": "Node", "url": "https://developer.roku.com/docs/references/scenegraph/node.md" }, "fields": [ { "accessPermission": "READ_ONLY", "default": "", "description": "Contains the format of the currently playing audio.\n\n| Value | Meaning |\n| --- | --- |\n| \"\" | No stream playing |\n| aac | ISO/IEC 14496-3, Advanced Audio Coding |\n| aac\\_adif | ISO/IEC 14496-3, Advanced Audio Coding, ADIF container |\n| aac\\_adts | ISO/IEC 14496-3, Advanced Audio Coding, ADTS container |\n| aac\\_latm | ISO/IEC 14496-3, Advanced Audio Coding, LATM container |\n| ac3 | Dolby Digital |\n| alac | Apple Lossless |\n| dts | DTS Coherent Acoustics |\n| eac3 | Dolby Digital Plus |\n| flac | Free Lossless Audio Codec |\n| mp2 | ISO/IEC 11172-3, MPEG Audio Layer II |\n| mp3 | ISO/IEC 11172-3, MPEG Audio Layer III |\n| none | Stream contains no playable audio |\n| pcm | linear PCM |\n| unknown | Stream contains unknown audio |\n| vorbis | Ogg Vorbis |\n| wma _sunset as of Roku OS 12.5_ | Microsoft Windows Media Audio. As of Roku OS 10.5, the Roku platform no longer supports this audio format. As part of the Roku OS 12.5 release, this format was officially sunset. |\n| wmapro _sunset as of Roku OS 12.5_ | Microsoft Windows Media Pro Audio. As of Roku OS 10.5, the Roku platform no longer supports this audio format. As part of the Roku OS 12.5 release, this format was officially sunset. |", "name": "audioFormat", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "true", "description": "Enables audio content to automatically play after rebuffering. Setting this flag to false disables this default behavior.", "name": "autoplayAfterSeek", "type": "boolean" }, { "accessPermission": "READ_ONLY", "default": "invalid", "description": "Contains information about stream buffering progress and status. This field is valid only while buffering is in progress, both at stream startup or when re-buffering is required. Observers will be notified when any element of the array changes, and also when buffering is complete and the field itself becomes invalid. The array contains the following name - value pairs.\n\n| Value | Meaning |\n| --- | --- |\n| percentage | Percent buffering complete as an integer. |\n| isUnderrun | Boolean value indicating if a stream underrun occurred. |", "name": "bufferingStatus", "type": "associative array" }, { "accessPermission": "READ_WRITE", "default": "NULL", "description": "The ContentNode with the \\[Content Meta-Data\\](/docs/developer-program/getting-started/architecture/content-metadata.md) for the audio or audio playlist (a sequence of audios) to be played. If a audio playlist is to be played, the ContentNode must include complete child ContentNodes for each audio in the playlist, with all attributes required to play that audio.", "name": "content", "type": "ContentNode" }, { "accessPermission": "READ_ONLY", "default": "-1", "description": "The index of the audio in the audio playlist that is currently playing. Generally, you would only want to check this field if audio playlists are enabled (by setting the \\`contentIsPlaylist\\` field to true), but it is set to 0 when a single audio is playing and audio playlists are not enabled.", "name": "contentIndex", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "If set to true, enables audio playlists (a sequence of audios to be played). To enable audio playlists, the ContentNode set in the \\`content\\` field must have children ContentNodes for each audio in the playlist. When audio playback is started, all of the audios in the playlist will be played in sequence.", "name": "contentIsPlaylist", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "none", "description": "Sets the desired play state for the audio, such as starting or stopping the audio play. Getting the value of this field returns the most recent value set, or \\`none\\` if no value has been set. In order to dynamically monitor the actual state of the audio, see the \\`state\\` field.\n\n| Option | Effect |\n| --- | --- |\n| none | No play state set |\n| play | Start audio play |\n| start | Start audio play |\n| stop | Stop audio play |\n| pause | Pause audio play |\n| resume | Resume audio play after a pause |\n| replay | Replay audio |\n| prebuffer | Starts buffering the audio stream before the Audio node actually begins playback. Only one audio stream can be buffering in the application at any time. Setting the `control` field to `prebuffer` for another audio stream after setting `prebuffer` for a previous audio stream stops the buffering of the previous audio stream. |\n| skipcontent | Skip the currently-playing content, and begin playing the next content in the playlist. If the content is not a playlist, or if the current content is the end of the playlist, this will end playback. |", "name": "control", "type": "option string" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "The duration of the audio being played, specified in seconds. This becomes valid when playback begins and may change if the audio is dynamic content, such as a live event.", "name": "duration", "type": "time" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "The error code associated with the audio play error set in the \\`state\\` field", "name": "errorCode", "type": "integer" }, { "accessPermission": "READ_ONLY", "default": "", "description": "An error message describing the audio play error set in the \\`state\\` field.", "name": "errorMsg", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "N/A", "description": "When a node or one of its children gains or loses the keyboard focus, the focusedChild field will be set and call its observer functions. In the observer function, typically, you use \\[ifSGNodeFocus\\](https://developer.roku.com/docs/references/brightscript/interfaces/ifsgnodefocus.md functions to query whether this node or some other node has the key focus or is in the key focus chain. Accessing the value of the field will result in script errors.", "name": "focusedChild", "type": "N/A" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "If set to true, the audio or audio playlist (if the \\`contentIsPlaylist\\` field is set to true to enable audio playlists) will be restarted from the beginning after the end is reached.", "name": "loop", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Set to true to mute the audio currently playing in the Audio node. Set to false to restore audio.", "name": "mute", "type": "boolean" }, { "accessPermission": "READ_WRITE", "default": "-1", "description": "If the \\`contentIsPlaylist\\` field is set to true to enable audio playlists, sets the index of the next audio in the playlist to be played. Setting this field does not immediately change the audio being played, but takes effect when the current audio is completed or skipped. By default, this value is -1, which performs the default index increment operation. After the audio specified by the index in this field begins playing, the field is set to the default -1 again, so the next audio played will be set by the default index increment operation, unless the field is set again to a different index.", "name": "nextContentIndex", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "0.5", "description": "The interval between notifications to observers of the position field, specified as the number of seconds. If the value is 0, no notifications are delivered. This value may be read or modified at any time.", "name": "notificationInterval", "type": "time" }, { "accessPermission": "READ_ONLY", "default": "invalid", "description": "The current position in the audio play, as the number of seconds.", "name": "position", "type": "time" }, { "accessPermission": "WRITE_ONLY", "default": "invalid", "description": "Sets the current position in the audio. The value is the number seconds from the beginning of the stream, specified as a double.", "name": "seek", "type": "time" }, { "accessPermission": "READ_ONLY", "default": "none", "description": "Describes the current audio play state, such as if the audio play has been paused.\n\n| Value | Meaning |\n| --- | --- |\n| none | No current play state |\n| buffering | Audio stream is currently buffering |\n| playing | Audio is currently playing |\n| paused | Audio is currently paused |\n| stopped | Audio is currently stopped |\n| finished | Audio has completed play |\n| error | An error has occurred in the audio play. The error code and error message can be found in the `errorCode` and `errorMsg` fields respectively. |", "name": "state", "type": "value string" }, { "accessPermission": "READ_ONLY", "default": "invalid", "description": "Information about the audio stream that is currently playing or buffering.\n\n| Key | Type | Value |\n| --- | --- | --- |\n| isUnderrun | Boolean | If true, the stream was downloaded due to an underrun |\n| isResumed | Boolean | If true, playback was resumed after trickplay |\n| measuredBItrate | Integer | The measured bitrate (bps) of the network when the stream was selected |\n| streamBitrate | Integer | The bitrate of the stream |\n| streamUrl | URI | The URL of the stream |", "name": "streamInfo", "type": "associative array" }, { "accessPermission": "READ_ONLY", "default": "{ }", "description": "Information about the audio segment that is currently streaming. This is only meaningful for segmented audio transports, such as DASH and HLS. The associative array has the following entries:\n\n| Key | Type | Value |\n| --- | --- | --- |\n| segBitrateBps | integer | Bitrate of the segment in bits per second |\n| segSequence | integer | The sequence number of the segment in the audio |\n| segStart | time | The start time of the segment from the start of the audio, specified in seconds |\n| segUrl | string | URL of the segment |\n| segTypeStr | string | The type of data in the segment: \"unknown\", \"mux\", \"audio\", \"video\", or \"captions\". |\n| hdrModeStr | string | The HDR format of the content, which may be one of the following values: * \"invalid\" * \"unknown\" * \"none\" * \"hdr10\" * \"dolby\\_vision\" * \"hlg10\" * \"hdr10\" * \"sl-hdr2\" |", "name": "streamingSegment", "type": "associative array" }, { "accessPermission": "READ_ONLY", "default": "{ }", "description": "The most recent timed meta data that has been decoded from the audio stream. Only meta data with a key that matches an entry in timedMetaDataSelectionKeys will be set into this field. The value of this field is an associative array which contains arbitrary keys and values, as found in the audio stream. As of Roku OS 10.5, this field can be used to read ID3 tags embedded in an audio stream.", "name": "timedMetaData", "type": "associative array" }, { "accessPermission": "READ_WRITE", "default": "[ ]", "description": "If the audio stream contains timed meta data such as ID3 tags, any meta data with a key matching an entry in this array will be set into the timedMetaData field. If any entry in this array is \"\\\\\\*\", then all timed meta data will be selected.", "name": "timedMetaDataSelectionKeys", "type": "array of strings" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "The time in seconds from playback being started until the audio actually began playing. The minimum valid value is 1 millisecond, and this is only valid if the current value of the \\`state\\` field is \\`playing\\`. When the state field value is not \\`playing\\`, the value will be 0. This field is updated prior to the \\`state\\` field changing, so \\`state\\` field observer callback functions can assume this field is valid after the \\`state\\` field value changes to \\`playing\\`.", "name": "timeToStartStreaming", "type": "time" } ], "interfaces": [], "name": "Audio", "url": "https://developer.roku.com/docs/references/scenegraph/media-playback-nodes/audio.md" }, "bifdisplay": { "description": "Component that displays BIFs and allows navigation.", "events": [], "extends": { "name": "Node", "url": "https://developer.roku.com/docs/references/scenegraph/node.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "0xFFFFFFFF", "description": "A color to be blended with the image displayed behind individual BIF images displayed on the screen. The blending is performed by multiplying this value with each pixel in the image. If not changed from the default value, no blending will take place.", "name": "frameBgBlendColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "The URI of an image to be displayed behind individual frames on the screen. The actual frame image is displayed opaquely on top of this background, so only the outer edges of this image are visible. Because of that, this background image typically appears as a border around the video frame. If the frameBgBlendColor field is set to a value other than the default, that color will be blended with the background image.", "name": "frameBgImageUri", "type": "uri" }, { "accessPermission": "WRITE_ONLY", "default": "invalid", "description": "Requests the nearest BIF to the time specified. This would normally be an offset from the current playback position. The getNearestFrame request is passed to the BifCache which uses the getNearestFrame() method implemented on all BIF storage classes. Existing BifCache functionality is then used to retrieve the bitmap data and load it into the texture manager.", "name": "getNearestFrame", "type": "time" }, { "accessPermission": "READ_ONLY", "default": "invalid", "description": "Contains the URI of the requested BIF. The returned URIs will be of the form `memory://BIF%d%d`. These URIs can then be used directly in the `uri` field of a Poster SGN (or similar).", "name": "nearestFrame", "type": "string" } ], "interfaces": [], "name": "BifDisplay", "url": "https://developer.roku.com/en-ca/docs/references/scenegraph/media-playback-nodes/video.md#ui-fields" }, "busyspinner": { "description": "Extends [**Group**](https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md\n\nThe BusySpinner node class is a simple widget that displays a continuously rotating bitmap. Since the BusySpinner node class uses an internal Poster node instance, the busy spinner bitmap can be specified by setting the internal Poster node uri field.\n\n[SimpleBusySpinner](https://github.com/rokudev/samples/tree/master/ux%20components/widgets) is a sample app that demonstrates usage of the BusySpinner.\n\n> Not all Roku Player hardware versions support arbitrary rotations. In particular, some hardware versions only support 90 degree rotation increments. In those cases, the icon will step through 90 degree, 180 degree, 270 degree and back to 0 degree rotations, rather than spin smoothly.", "events": [], "extends": { "name": "Group", "url": "https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "true", "description": "Specifies whether the bitmap rotates in a clockwise or counterclockwise direction", "name": "clockwise", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "none", "description": "Sets the operational state of the busy spinner\n\n| Option | Effect |\n| --- | --- |\n| none | No operational state set. The busy spinner will run if not set to `\"stop\"`. |\n| start | Starts the busy spinner if not running |\n| stop | Stops the busy spinner if running |", "name": "control", "type": "option string" }, { "accessPermission": "READ_WRITE", "default": "internal instance default", "description": "Set the uri field of the Poster node to select the bitmap for the busy spinner", "name": "poster", "type": "Poster node" }, { "accessPermission": "READ_WRITE", "default": "2", "description": "The number of seconds to complete a 360-degree rotation of the spinner image. A value of 0 will cause the spinner to remain stationary and not spin", "name": "spinInterval", "type": "time" } ], "interfaces": [], "name": "BusySpinner", "url": "https://developer.roku.com/docs/references/scenegraph/widget-nodes/busyspinner.md" }, "button": { "description": "Extends [**Group**](https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md\"**Group**\")\n\nThe Button node is a simple widget that generates a buttonSelected event when the user selects it. The button can display a label and/or an icon, as well as a background image. Fields are provided to customize the label text and color depending on whether or not the button has the key focus. Similarly, the bitmaps used for the icon and background can be specified for both focused and unfocused button states.\n\nBy default, the background of the button is only shown when the button has the key focus. Buttons are typically used in a ButtonGroup node that manages which button in the group will have the key focus when the ButtonGroup node receives the focus. When the ButtonGroup node has the focus, the button in the group that has the focus will display the focusBitmapUri bitmap as its background. When the ButtonGroup node does not have the focus, it remembers which button in the group had the focus and sets that button showFocusFootprint field to true, causing it to a render a \"footprint\" bitmap as a visual indicator that it will be the focused button when the ButtonGroup node receives the focus again. All other buttons in the ButtonGroup node do not display a background image.\n\nWhen a Button node is created that is not a child of a ButtonGroup node, typically the showFootprintfield field should be set to true, so that the button always displays a background image.", "events": [], "extends": { "name": "Group", "url": "https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md" }, "fields": [ { "accessPermission": "READ_ONLY", "default": "N/A", "description": "The buttonSelected field is set whenever the button is selected. The field should be used to call observer callback functions when the button is selected", "name": "buttonSelected", "type": "Event" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies the button background bitmap file to display when the button has the key focus. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap", "name": "focusBitmapUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies a bitmap file for the button icon when the button has the key focus. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap. For a button with no icon, set this field to an empty string (iconUri=\"\")", "name": "focusedIconUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "0x262626ff", "description": "Specifies the color of the button label when the button has the key focus", "name": "focusedTextColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the font of the button label when the button has the key focus", "name": "focusedTextFont", "type": "Font" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies the button focus \"footprint\" bitmap file to display when the button does not have key focus. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap. By default the \"footprint\" bitmap is not displayed when the button does not have the key focus. To display the background when the button is unfocused, the showFocusFootprint field must be set to true", "name": "focusFootprintBitmapUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "64", "description": "Specifies the height of the button", "name": "height", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies a bitmap file for the button icon when the button does not have the key focus. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap. For a button with no icon, set this field to an empty string (iconUri=\"\")", "name": "iconUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "32767", "description": "Specifies the maximum width of the button. The maxWidth field must be greater than or equal to the minWidth field", "name": "maxWidth", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "0", "description": "Specifies the minimum width of the button. The minWidth field must be less than or equal to the maxWidth field", "name": "minWidth", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Enables auto-scrolling to ensure text that is larger than initially expected fits within the button (for example, when the text is translated to other languages).", "name": "scrollable", "type": "boolean" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Controls whether the focus \"footprint\" bitmap is displayed when the button does not have the key focus. Since the default value of the showFocusFootprint field is false, the \"footprint\" bitmap is not displayed by default", "name": "showFocusFootprint", "type": "boolean" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies the text to be displayed as the button label", "name": "text", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "0xddddddff", "description": "Specifies the color of the button label when the button does not have the key focus", "name": "textColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the font of the button label when the button does not have the key focus", "name": "textFont", "type": "Font" } ], "interfaces": [], "name": "Button", "url": "https://developer.roku.com/docs/references/scenegraph/widget-nodes/button.md" }, "buttongroup": { "description": "Extends [**LayoutGroup**](https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/layoutgroup.md\"**LayoutGroup**\")\n\nThe ButtonGroup node class manages the layout, visual attributes, and focus management of a vertical list of Button nodes. When the ButtonGroup node has focus, it sets the key focus on a single one of its child Button nodes.\n\n* The buttons can be easily created using default button appearances by setting the buttons field to an array of strings containing the labels for each button.\n* A single observer can watch for any of the Button nodes in the group to be selected by observing the buttonSelected field.\n* By default, Button nodes added to the group will have the default button appearance. Several fields exist that allow you to change an attribute of the appearance of all Button nodes in the group.", "events": [], "extends": { "name": "LayoutGroup", "url": "https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/layoutgroup.md" }, "fields": [ { "accessPermission": "READ_ONLY", "default": "0", "description": "Set to the index of the focused button whenever a button in the group receives the key focus", "name": "buttonFocused", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "0", "description": "Specifies the height of each Button node in the group. Only set to override the system default", "name": "buttonHeight", "type": "float" }, { "accessPermission": "WRITE_ONLY", "default": "[ ]", "description": "Allows a set of Button nodes to be easily created by providing an array of button labels. Each string in the array will result in a Button node to be added to the ButtonGroup node, using the string as the button label", "name": "buttons", "type": "array of strings" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "Set to the index of the selected button whenever the user selects a button in the group", "name": "buttonSelected", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the bitmap to be used as the background for the Button node that has focus. Only set to override the system default", "name": "focusBitmapUri", "type": "uri" }, { "accessPermission": "WRITE_ONLY", "default": "0", "description": "Causes the button with the specified index to receive the focus when the ButtonGroup node has the key focus. Note that if the ButtonGroup node does not have the key focus when the focusButton field is set, the specified button will display the focus \"footprint\" as its background", "name": "focusButton", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the bitmap for the focused button icon. Only set to override the system default", "name": "focusedIconUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "0xffffffff", "description": "Specifies the button label color for the Button node that has focus, if any. Only set to override the system default", "name": "focusedTextColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "system: MediumBoldSystemFont", "description": "Specifies the \\[Font\\](https://developer.roku.com/docs/references/scenegraph/typographic-nodes/font.md\"Font\") node for the Button node that has focus, if any. Only set to override the system default. See Font for a list of all system fonts available", "name": "focusedTextFont", "type": "Font" }, { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the bitmap to be used as the focus footprint background, when focus is not on the ButtonGroup node. The focus footprint is a visual indicator of the button that will take focus when focus moves back onto the ButtonGroup node. Only set to override the system default", "name": "focusFootprintBitmapUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the bitmap for the button icon for all unfocused Button nodes in the group. Only set to override the system default", "name": "iconUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "32767", "description": "When set, specifies the maximum width for the Button nodes in the group. The maxWidth field must be greater than or equal to the minWidth field", "name": "maxWidth", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "0", "description": "Specifies the minimum width for the Button nodes in the group. The minWidth field must be less than or equal to the maxWidth field. Only set to override the system default", "name": "minWidth", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Specifies whether the button labels and icons should be right- or left-justified. When right-justified and there is an icon, it appears to the right of the button label", "name": "rightJustify", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "0xffffffff", "description": "Specifies the button label color for all unfocused Button nodes in the group. Only set to override the system default", "name": "textColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "system: MediumSystemFont", "description": "Specifies the \\[Font\\](https://developer.roku.com/docs/references/scenegraph/typographic-nodes/font.md\"Font\") node for all unfocused Button nodes in the group. Only set to override the system default. See Font for a list of all system fonts available", "name": "textFont", "type": "Font" } ], "interfaces": [], "name": "ButtonGroup", "url": "https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/buttongroup.md" }, "channelstore": { "description": "Extends [**Node**](https://developer.roku.com/docs/references/scenegraph/node.md\n\nThe **ChannelStore** node class provides an interface to the Streaming Store. It provides functionality equivalent to the [roChannelStore](https://developer.roku.com/docs/references/brightscript/interfaces/ifchannelstore.md component. In general, the **ChannelStore** node class allows developers to issue one of several commands, which involves the following steps:\n\n1. Set the fields containing the data needed by the command (optional).\n2. Set up an observer of the result field associated with the command.\n3. Set the command field to the appropriate string to start the command execution.\n4. The field associated with the command is set to a **ContentNode** object containing the results of the command.\n\nEach of the commands starts a sequence of actions associated with the financial transaction that are handled by the Roku OS outside of control or monitoring by the app SceneGraph markup. The SceneGraph markup merely initiates the purchase and receives a final result.", "events": [], "extends": { "name": "Node", "url": "https://developer.roku.com/docs/references/scenegraph/node.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Contains the results of a \\[\\*\\*getCatalog\\*\\*\\](#getcatalog) command.", "name": "catalog", "type": "ContentNode" }, { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the command to be executed: \\* \\[getUserData\\](#getuserdata) \\* \\[getUserRegionData\\](#getuserregiondata) () \\* \\[getCatalog\\](#getcatalog) and \\[getStoreCatalog\\](#getstorecatalog) \\* \\[doOrder\\](#doorder) \\* \\[getPurchases\\](#getpurchases) and \\[getAllPurchases\\](#getallpurchases) \\* \\[storeChannelCredData\\](#storechannelcreddata) \\* \\[getChannelCred\\](#getchannelcred) \\* \\[getDeviceAttestationToken\\](#getdeviceattestationtoken) \\* \\[requestPartnerOrder\\](#requestpartnerorder) \\* \\[confirmPartnerOrder\\](#confirmpartnerorder)", "name": "command", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Confirms the product being ordered from a TVOD app. The order contains the following fields:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| orderId | string | The orderID returned by Roku in the [RequestPartnerOrderStatus](#requestpartnerorderstatus) content node. |\n| code | string | The product identifier. |\n| priceDisplay | string | The original price of the product. Do not include a currency symbol (for example, set this to \"3.99\" instead of \"$3.99\"). |\n| price | string | The final price of the product, including any discounts. Do not include a currency symbol (for example, set this to \"3.99\" instead of \"$3.99\"). |\n| title | string | The name of the product to be displayed on customers' invoices. |\n| couponCode | string | An alphanumeric string entered by the customer to receive a discounted price on the product. |\n| contentKey | string | The publisher-specific SKU (or other unique identifier) for the product. |", "name": "confirmPartnerOrder", "type": "ContentNode" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Contains the results of a \\[\\*\\*confirmPartnerOrder\\*\\*\\](#confirmpartnerorder) command.", "name": "confirmPartnerOrderStatus", "type": "ContentNode" }, { "accessPermission": "WRITE_ONLY", "default": "{}", "description": "Enables the \\[\\*\\*order\\*\\*\\](#order) field to be populated incrementally. Each time this field is set, the \\*\\*order\\*\\* field is modified. The \\*\\*deltaOrder\\*\\* associative array should contain a \"code\" string that identifies an available item, and a \"qty\" integer value to indicate how the children of the order field \\*\\*ContentNode\\*\\* should be modified. For example, if the order is invalid, setting the deltaOrder field to the following associative array:   \\`{ \"code\": \"Merchandise1\", \"qty\": 1 }\\` Would cause an order field to be set to a \\*\\*ContentNode\\*\\*, with one child \\*\\*ContentNode\\*\\* with a \"code\" field set to \"Merchandise1\", and a \"qty\" field set to 1. If the deltaOrder field was then set to:   \\`{ \"code\": \"MyItem2\", \"qty\": 1 }\\` The order field \\*\\*ContentNode\\*\\* would have a second \\*\\*ContentNode\\*\\* child appended to it, with the specified \"code\" and \"qty\" field values. The \"qty\" field can be set to a negative value to remove an item from an order. For example, if the order field was set as above, and the deltaOrder field was set to:   \\`{ \"code\" MyItem2\", \"qty\": -1 }\\` The order field \\*\\*ContentNode\\*\\* would have the second child \\*\\*ContentNode\\*\\* removed.", "name": "deltaOrder", "type": "associative array" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Enables a test mode for the \\*\\*ChannelStore\\*\\* node. The test mode disables communication by the ChannelStore node with the Streaming Store server, and it causes responses to asynchronous queries and operations to come from XML test configuration files rather than the server. To use this test method, create a \\*\\*csFake\\*\\* folder and add the following XML files to it in order to simulate web service request and response data: \\* \\*\\*csfake/GetCatalog.xml\\*\\*: Simulates the list of products available for purchase in the app. \\* \\*\\*csfake/GetPurchases.xml\\*\\*: Simulates the list of products already purchased by the user. \\* \\*\\*csfake/PlaceOrder.xml\\*\\*: Contains information about the product to be ordered. \\* \\*\\*csfake/CheckOrder.xml\\*\\*: Verifies the validity of the order placed. For example, if the \\*\\*order\\*\\* and \\*\\*id\\*\\* values in the PlaceOrder and CheckOrder XML files do not match, the fake server will report an error in the order processing. See the \\[SimpleChannelStore sample app\\](https://github.com/rokudev/samples/tree/master/roku%20pay/SimpleChannelStore/csfake) for how to use this testing method. The \\*\\*fakeServer\\*\\* field must be set to false in a published app to allow actual \\[In-App Product\\](/docs/developer-program/roku-pay/quickstart/in-channel-products.md) purchases by users. It is recommended that developers use \\[billing testing\\](/docs/developer-program/roku-pay/testing/billing-testing.md) instead of the fakeServer.", "name": "fakeServer", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Contains the order to be filled when the \\[\\*\\*doOrder\\*\\*\\](#doorder) command is executed. This ContentNode contains one child ContentNode for each of the items to be purchased. The child ContentNode must contain the following fields:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| code | string | Identifies the product to be purchased, as entered in the **Product Identifier** field on the [In-App Product page in the Developer Dashboard](https://developer.roku.com/products) when the product was created. See [Creating an order](#creating-an-order) for more information. |\n| qty | Integer | The quantity of the item to be purchased, which is typically 1 for most in-app products. This is only typically more than 1 if the product is a \"packet\" of identical items (such as game points, number of viewings permitted of some item of content, and so on). |\n\nTo clear an order, set the \\*\\*order\\*\\* field to \"invalid\". \\*\\*For upgrades/downgrades only\\*\\*. You need to include an \\*\\*action\\*\\* field to specify a subscription plan change.\n\n| Field | Type | Access Permission | Description |\n| --- | --- | --- | --- |\n| action | string | READ\\_WRITE | Set this to \"Upgrade\" or \"Downgrade\" to change the subscription plan from a previous purchase (for example, `myOrder.action = \"Upgrade\"`). The required values are case-sensitive; do not pass \"upgrade\" or \"downgrade\". See [On-device upgrade and downgrade](/docs/developer-program/roku-pay/implementation/on-device-upgrade-downgrade.md) for more information. |", "name": "order", "type": "ContentNode" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Contains the results of the \\[\\*\\*doOrder\\*\\*\\](#doorder) command.", "name": "orderStatus", "type": "ContentNode" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Contains the results of a \\[\\*\\*getPurchases\\*\\*\\](#getpurchases) or \\[\\*\\*getAllPurchases\\*\\*\\](#getallpurchases) command.", "name": "purchases", "type": "ContentNode" }, { "accessPermission": "READ_WRITE", "default": "all", "description": "Specifies the Roku customer account fields to be retrieved when the \\[\\*\\*getUserData\\*\\*\\](#getuserdata) command is executed. The default value is \"all\", which causes a ContentNode object to be returned from \\*\\*getUserData\\*\\* that includes all of the available Roku customer account information. To request specific Roku customer account information items (for example, an email address, first name, and last name) set this field to a string containing a comma-separated list of values (for example, \"email, firstname, lastname\"). The available values are as follows: \\* email \\* phone \\* firstname \\* lastname \\* street \\* city \\* state \\* zip \\* country \\* birth \\* gender In this case, the ContentNode object returned from the \\*\\*getUserData\\*\\* command includes the specified customer account information.", "name": "requestedUserData", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Specifies whether the RFI screen is used for customer sign-ups or sign-ins. This may be one of the following values:\n\n| Field | Type | Default | Description |\n| --- | --- | --- | --- |\n| context | string | \"signup\" | Specifies the context of the RFI screen, which may be one of the following values: * \"signup\": The RFI screen displays a \"Let's create your account\" title and lists the customer information specified in the [**requestedUserData** field](#requesteduserdata). The RFI screen uses the \"signup\" context by default. See [Sign-up requirements and best practices](/docs/developer-program/roku-pay/signup-best-practices.md) for more information on implementing the app sign-up UI. * \"signin: \"The RFI screen displays a \"Sign in\" title and lists only email or phone attributes, if specified in the [**requestedUserData** field](#requesteduserdata). Other attributes are ignored, even if specified. See the [Sign-in example](#sign-in-example) for how to use this field. See [Sign-in requirements and best practices](/docs/developer-program/roku-pay/signin-best-practices.md) for more information on implementing the app sign-in UI. |\n| forceShowData | Boolean | false | If true, the RFI signup screen displays the values of the requested customer information to be shared with the app (for example, Jone Doe, jon.doe@emailaddress.com). By default, this flag is set to false, which means that the default RFI screen for the region is used. For example, in the US, the RFI screen displays the type of customer information being requested (email address, name, and so on). This flag has no effect if the context field is set to \"signin\" (the RFI sign-in screen always displays the customer information values). **Example**: ``` store = CreateObject(\"roSGNode\", \"ChannelStore\") ' Doesn't show user data in dialog unless necessary in the user's region. store.requestedUserData = \"email,firstname,lastname,gender,birth\" store.command = \"getUserData\" ' Shows user data in dialog. info = CreateObject(\"roSGNode\", \"ContentNode\") info.addFields({forceShowData: true}) store.requestedUserDataInfo = info store.requestedUserData = \"email\" store.command = \"getUserData\" ``` |", "name": "requestedUserDataInfo", "type": "ContentNode" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Specifies the product to be ordered from a TVOD app. The order contains the following fields:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| code | string | Identifies the product to be purchased, as entered in the **Product Identifier** field on the [In-App Product page in the Developer Dashboard](https://developer.roku.com/products) when the product was created. For TVOD-exclusive apps, a single in-app product may be used for all orders. A TVOD-exclusive app only has transactional products such as movie rentals; it does not offer any subscription products. |\n| priceDisplay | string | The original price of the product. Do not include a currency symbol (for example, set this to \"3.99\" instead of \"$3.99\"). |\n| price | string | The final price of the product, including any discounts. Do not include a currency symbol (for example, set this to \"3.99\" instead of \"$3.99\"). |\n| title | string | A description of the product (for example, the name of a rental movie). |\n| couponCode | string | An alphanumeric string entered by the customer to receive a discounted price on the product. |\n| contentKey | string | The publisher-specific SKU (or other unique identifier) for the product. |", "name": "requestPartnerOrder", "type": "ContentNode" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Contains the results of a \\[\\*\\*requestPartnerOrder\\*\\*\\](#requestpartnerorder) command.", "name": "requestPartnerOrderStatus", "type": "ContentNode" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Contains the results of a \\[\\*\\*getStoreCatalog\\*\\*\\](#getstorecatalog) command.", "name": "storeCatalog", "type": "ContentNode" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "Contains the results of a \\[\\*\\*getUserData\\*\\*\\](#getuserdata) command. The value stored in this field depends on whether the user clicks \\*\\*Continue\\*\\* or \\*\\*Cancel\\*\\* in the Request for Information (RFI) screen. If the user clicks \\*\\*Continue\\*\\*, this field is populated with the Roku customer account information that was requested in the \\[\\*\\*requestedUserData\\*\\*\\](#requesteduserdata) field. If the user clicks \\*\\*Cancel\\*\\*, this field is set to \"invalid\".", "name": "userData", "type": "ContentNode" } ], "interfaces": [], "name": "ChannelStore", "url": "https://developer.roku.com/docs/references/scenegraph/control-nodes/channelstore.md" }, "checklist": { "description": "Extends [**LabelList**](https://developer.roku.com/docs/references/scenegraph/list-and-grid-nodes/labellist.md\n\nThe CheckList node class is a simple list class that displays a list of items, some of which include checkboxes that allow the user to select or unselect that item. Each item in the list displays a text string and an optional checkbox icon positioned to the left of the text string.\n\nIf the checkbox is displayed, it is shown as either:\n\n* an empty box,\n* or a box with a checkmark indicator inside indicating whether the item is in the checked or unchecked state.", "events": [], "extends": { "name": "LabelList", "url": "https://developer.roku.com/docs/references/scenegraph/list-and-grid-nodes/labellist.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the checkbox icon to use for list items that are in the checked state when that list item does not the key focus. Typically, the icon will include the outline of a box with a checkmark indicator inside. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap.", "name": "checkedIconUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "all false", "description": "Specifies the checked state of each item in the list. A value of true indicates the item is in the checked state. A value of false indicates that the item is in the unchecked state. When reading the value of the field, note that the field array will always include one value for each item in the list. When writing the value of the field, if the specified array includes fewer values than items in the list, the list items that are unspecified will remain in their current state. For example, if there are 10 items in the list and the field value is set to \\\\\\[ \\`true\\`, \\`true\\` \\\\\\], items 0 and 1 will have their checked state set to true, and the checked state of the remaining items (items 3 to 9) will be unchanged.", "name": "checkedState", "type": "array of Boolean" }, { "accessPermission": "READ_WRITE", "default": "true", "description": "Controls whether or not pressing the remote control OK key causes the checkedState field to automatically toggle the checked state of the currently focused list item. By default, field value is set to true, but there are use cases where other behavior may be desired. In those cases, it is up to the developer to manage the checked state of the list items by setting the \\`checkedState\\` field to the desired index.", "name": "checkOnSelect", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the checkbox icon to use for list items that are in the checked state when that list item has the key focus. Typically, the icon will include the outline of a box with a checkmark indicator inside. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap.", "name": "focusedCheckedIconUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the checkbox icon to use for list items that are in the unchecked state when that list item has the key focus. Typically, the icon will include the outline of an empty box. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap.", "name": "focusedUncheckedIconUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "", "description": "Specifies the checkbox icon to use for list items that are in the unchecked state when that list item does not have the key focus. Typically, the icon will include the outline of an empty box. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap.", "name": "uncheckedIconUri", "type": "uri" } ], "interfaces": [], "name": "CheckList", "url": "https://developer.roku.com/docs/references/scenegraph/list-and-grid-nodes/checklist.md" }, "colorfieldinterpolator": { "description": "Extends [**Node**](https://developer.roku.com/docs/references/scenegraph/node.md\n\nThe ColorFieldInterpolator node class specifies a keyframe animation sequence to be applied to the color field of a node (such as the color field of a Label node).\n\nAll field interpolators include a set of key/keyValue field pairs that define a keyframe of the animation. Field interpolators are generally used as children of an Animation node. As the animation progresses, it sets the fraction field of its field interpolators to a value between 0 and 1, indicating the fraction of the animation progress. The keyframe fields of the interpolator are key, the percentage where the keyframe should occur, and keyValue, the value that the field should have at that fraction of the animation.\n\nFor example, if a ColorFieldInterpolator node had three keyframes:\n\n* 0.0, 0xFF0000FF (red)\n* 0.4, 0x00FF00FF (green)\n* 1.0, 0x0000FFFF (blue)\n\nWhen the interpolator fraction field value was 0.0 (that is, 0%), the color field value would be set to red. When the fraction field value was 0.4 (that is, 40%), the color field value would be set to green. When the fraction field value was 1.0 (that is, 100%), the color field value would be set to blue.\n\nFor values of the fraction field between 0.0 and 0.4 (such as 0.2 or 20%), the field value is determined by linearly interpolating the keyValue field values for the first two keyframes. In this case, since the key of 0.2 is halfway between the key at 0.0 and the key at 0.4, the field would be set to a color halfway between red and green. Similarly, when the fraction field value is between the second and third keys (that is, between 0.4 and 1.0), the field value is determined by linearly interpolating the keyValue field values of the second and third keyframes.\n\nIf the first keyframe has a key field fraction value greater than zero, then the field value is equal to the keyValue field value of the first keyframe until the fraction field value reaches the first keyframe key field fraction value. Similarly, if the last keyframe has a key field fraction value less than one, the color field value is set to the keyValue field value of the last keyframe, from when the fraction field value equals the last keyframe key field fraction value percentage, and will not change as the fraction field value increases from that value to 1.0.\n\nThe ColorFieldInterpolator node class works in the HSV color space. Doing the interpolation in the HSV color space produces the most intuitive, visually pleasing results when animating color values.\n\n> While linear interpolation is used to compute the keyValue field values for fraction field values between successive keys, non-linear easing functions may be applied to the fraction field values computed by the Animation node, so the overall animation may vary in speed.", "events": [], "extends": { "name": "Node", "url": "https://developer.roku.com/docs/references/scenegraph/node.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies the field to interpolate. This generally refers to the field on a SceneGraph node that contains the color to animate, such as testRectangle.color field in the example below", "name": "fieldToInterp", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "Specifies the fraction to be used to compute a value for the field", "name": "fraction", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "[ ]", "description": "Specifies the key fractions for the interpolator keyframes. Each key fraction should be a unique value from 0 to 1 indicating the fraction of the animation where the keyValue field value should occur. Behavior is undefined if the number of values in the key field does not match the number of values in the keyValue field", "name": "key", "type": "array of floats" }, { "accessPermission": "READ_WRITE", "default": "[ ]", "description": "Specifies the key values for the interpolator keyframes. Each value in the keyValue field array corresponds to a value in the key field array. Behavior is undefined if the number of values in the key field does not match the number of values in the keyValue field", "name": "keyValue", "type": "array of colors" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Enables animation to be played in reverse", "name": "reverse", "type": "boolean" } ], "interfaces": [], "name": "ColorFieldInterpolator", "url": "https://developer.roku.com/docs/references/scenegraph/animation-nodes/colorfieldinterpolator.md" }, "componentlibrary": { "description": "Extends [**Node**](https://developer.roku.com/docs/references/scenegraph/node.md\n\nThe ComponentLibrary node class downloads a library of custom SceneGraph components to be used in an application. The ComponentLibrary node should be used in a Scene node, such as Scene or OverhangPanelSetScene. One way to ensure that the library downloads before the SceneGraph application begins to compile the components for the application, is to begin the download in the main.brs file that creates the Scene node, by adding an `` field to the Scene node that can be used to monitor the download, and starts the application when the download is complete.", "events": [], "extends": { "name": "Node", "url": "https://developer.roku.com/docs/references/scenegraph/node.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "no default", "description": "Set to a unique ID for the library for the application", "name": "id", "type": "string" }, { "accessPermission": "READ_ONLY", "default": "\"none\"", "description": "Indicates the progress of the library download. The possible values are:\n\n| Value | Meaning |\n| --- | --- |\n| none | The default if the library is not being downloaded |\n| loading | Library is downloading |\n| ready | Library has downloaded successfully |\n| failed | Download of the library has failed |", "name": "loadStatus", "type": "value string" }, { "accessPermission": "READ_WRITE", "default": "no default", "description": "The URL of the library to be downloaded", "name": "uri", "type": "uri" } ], "interfaces": [], "name": "ComponentLibrary", "url": "https://developer.roku.com/docs/references/scenegraph/control-nodes/componentlibrary.md" }, "contentnode": { "description": "Extends [**Node**](https://developer.roku.com/docs/references/scenegraph/node.md\n\nThe ContentNode class allows you to specify the data used to configure a node or component. Many nodes and components require a ContentNode as the specification of their content field in order to be properly configured. In general, lists, grids, and panels require a ContentNode for configuration. The data included in a ContentNode can be data such as the text for labels in the node or component, and the spacing between items in a list, grid, or panel, including data to create custom lists, grids, and panels. The reference information for every node or component that requires a ContentNode includes a section that details the requirements of the ContentNode for that node or component.\n\nContentNodes defined as the specification for a node or component content field are typically structured as one ContentNode parent node, with a hierarchy of child nodes that specify the actual data, and sections of data if needed. For example, a [LabelList](https://developer.roku.com/docs/references/scenegraph/list-and-grid-nodes/labellist.md\"LabelList\") node can have several sections that divide the entire list, each with their own section heading, and specific items in that section of the list. The ContentNode for that LabelList node should have two levels of child ContentNodes, one level for the data to configure the list sections, and then another level of child ContentNodes for the data for each item in that list section.\n\nA ContentNode can also be used to specify the data for custom components with defined interfaces, and for nodes and components that require [Content Meta-Data](/docs/developer-program/getting-started/architecture/content-metadata.md \" Content Meta-Data\"). Also, you should use a ContentNode for complex structures of data for your application rather than associative arrays. ContentNode objects are passed by reference in the application, while associative array objects are copied. For large complex data structures, passing ContentNode objects is much quicker than passing the equivalent associative array object. You can use associative arrays for simpler data structures with just a few fixed members.\n\n> All of the attributes listed in [Content Meta-Data](/docs/developer-program/getting-started/architecture/content-metadata.md \"Content Meta-Data\") can be set as fields in a Content node. However, when creating a Content node, the fields themselves are not created until the valid attributes are set as fields, using either assignment (=), or set using [setField()](https://developer.roku.com/docs/references/brightscript/interfaces/ifsgnodefield.mdsetfieldfieldname-as-string-value-as-object-as-boolean \"setField\") or [setFields()](https://developer.roku.com/docs/references/brightscript/interfaces/ifsgnodefield.mdsetfieldsfields-as-object-as-boolean. \"setFields()\")", "events": [], "extends": { "name": "Node", "url": "https://developer.roku.com/docs/references/scenegraph/node.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "", "description": "For upgrades/downgrades only. Set this to \"Upgrade\" or \"Downgrade\" to change the subscription plan from a previous purchase (for example, myOrder.action = \"Upgrade\"). The required values are case-sensitive; do not pass \"upgrade\" or \"downgrade\". See On-device upgrade and downgrade for more information.", "name": "action", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "List of Actor Names or Individual Actor Name", "name": "Actors", "type": "roArray or String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Maximum startup bitrate specified in kbps. Streaming will start with a variant less than or equal to this value. If this value is not set, it will default to 2500 kbps.", "name": "AdaptiveMaxStartBitrate", "type": "Integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Minimum startup bitrate specified in kbps. Streaming will start with a variant equal to or greater than this value. If this value is not set or if it's set to zero, any minimum start bitrate will be ignored.", "name": "AdaptiveMinStartBitrate", "type": "Integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roSpringboard audio style uses this to display the album", "name": "Album", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roSpringboard audio style uses to show artist", "name": "Artist", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Comma-separated list of audio tracks (based on ISO 639-1 or 639-2 language code) that may not be selected from the \\*\\*Audio track\\*\\* setting for the content. (Available since Roku OS 9.4) If a language is both blacklisted and whitelisted, the blacklisting takes precedence.", "name": "AudioBlacklist", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roSpringboardScreen: If set to \"dolby-digital\", will display a \"5.1 ))\" icon in the lower left of a movie style springboard screen", "name": "AudioFormat", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "\\*\\*This attribute was deprecated as of the Roku 9.2 OS release.\\*\\* Users can select their preferred audio language on-device in the \\*\\*Settings > Audio > Audio Preferred Language\\*\\* screen.", "name": "AudioLanguageSelected", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "\\*\\*This attribute is deprecated\\*\\* Users can select their preferred audio language on-device in the \\*\\*Settings > Audio > Audio Preferred Language\\*\\* screen.", "name": "AudioPIDPref", "type": "Integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Comma-separated list of audio tracks (based on ISO 639-1 or ISO 639-2 language code) that may be selected from the \\*\\*Audio track\\*\\* setting for the content.", "name": "AudioWhitelist", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Comma-separated list of captioning tracks (based on ISO 639-2 language code) that may not be selected from the \\*\\*Accessibility>Captioning track\\*\\* setting for the content. (Available since Roku OS 9.4) If a language is both blacklisted and whitelisted, the blacklisting takes precedence.", "name": "CaptionBlacklist", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Comma-separated list of captioning tracks (based on ISO 639-2 language code) that may be selected from the \\*\\*Accessibility>Captioning track\\*\\* setting for the content.", "name": "CaptionWhitelist", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "List of Category/Genre Names or Individual Category/Genre Name", "name": "Categories", "type": "roArray or String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "To use this field, create a child node and use a playlist (even though only one content item will be in the playlist). This field is updated only when \\*\\*contentIsPlayList\\*\\* is true. The \\*\\*URLFilter\\*\\*, \\*\\*Priority\\*\\*, and \\*\\*Weight\\*\\* attributes must be specified to apply these configurations.", "name": "cdnConfig", "type": "roArray of roAssociativeArrays" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "ClipEnd sets the clip end position. The unit of ClipEnd is seconds (Available since Roku OS 8.1).", "name": "ClipEnd", "type": "Float" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "ClipStart sets the clip start position of the playback. The unit of ClipStart is seconds (Available since Roku OS 8.1).", "name": "ClipStart", "type": "Float" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Boolean indicating if CC icon should be displayed", "name": "ClosedCaptions", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "\\* \" \" \\* \"action\" \\* \"animated\" \\* \"black+white\" (black and white) \\* \"comedy\" \\* \"drama\" \\* \"music\" \\* \"music:lyrics\" \\* \"nature\" \\* \"news\" \\* \"podcast\" (audio only) \\* \"reality\" \\* \"sports\"", "name": "contentClassifer", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "", "description": "The publisher-specific SKU (or other unique identifier) for the product.", "name": "contentKey", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Although ContentType accepts type String, the return value is of type \\[roInt\\](https://developer.roku.com/docs/references/brightscript/components/roint.md. See table below.\n\n| Content Type | Return Value |\n| --- | --- |\n| audio | 5 |\n| episode | 4 |\n| movie | 1 |\n| not set or not supported | 0 |\n| season | 3 |\n| series | 2 |", "name": "ContentType", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "", "description": "An alphanumeric string entered by the customer to receive a discounted price on the product.", "name": "couponCode", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Description of content", "name": "Description", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "List of Director Names", "name": "Directors", "type": "roArray" }, { "accessPermission": "READ_WRITE", "default": "invalid", "description": "The original price of the product. Do not include a currency symbol (for example, set this to \"3.99\" instead of \"$3.99\").", "name": "drmParams", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Specifies the PlayReady license acquisition URL, and additional custom request data, determined by the EncodingType attribute value specified: \\* when encodingType=\"PlayReadyLicenseAcquisitionUrl\", the EncodingKey attribute contains the PlayReady license acquisition URL", "name": "EncodingKey", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Specifies the encoding scheme for PlayReady DRM, by setting to one of the following values: \\* \"PlayReadyLicenseAcquisitionUrl\" \\* \"PlayReadyLicenseAcquisitionAndChallenge\" Note, this is the same value that used to be specified directly in Content Metadata structure", "name": "EncodingType", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Episode Number", "name": "EpisodeNumber", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "BIF URL for FHD trick mode", "name": "FHDBifUrl", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "YesterdayURL for FHD content artwork", "name": "FHDPosterUrl", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Filters out any video profile/codec level combinations that the specified hardware cannot play. The default value is false, in which case no filtering occurs. \\*\\*Note that this currently only works for DASH streams.\\*\\*", "name": "filterCodecProfiles", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Controls whether query string parameters from initial DASH stream manifest requests are forward to subsequent segment download requests. The default value is set to false for backwards compatibility.", "name": "ForwardDashQueryStringParams", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Controls whether query string parameters from initial HLS stream manifest requests are forward to subsequent segment download requests. The default value is set to true for backwards compatibility.", "name": "ForwardQueryStringParams", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roVideoPlayer or roVideoScreen: Specify the 1080p stream was encoded at 24 or 30 fps", "name": "FrameRate", "type": "Integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roVideoPlayer or roVideoScreen: Specify that this stream was encoded at 1080p resolution", "name": "FullHD", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Overrides the `caption1NumLines` field for this section of the grid, allowing different sections to display different caption layouts. If not specified, the value of the `caption1NumLines` field is used.", "name": "GridCaption1NumLines", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Overrides the `caption2NumLines` field for this section of the grid, allowing different sections to display different caption layouts. If not specified, the value of the `caption2NumLines` field is used.", "name": "GridCaption1NumLines", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "When the fixedLayout field is set to true, this specifies how many rows the grid item occupies. If not specified, the default value of 1 is used.\nFor example, if a grid item is to occupy the the third, fourth and fifth rows, Y would be set to 2 and H would be set to 3.", "name": "H", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roListScreen: URL for the HD background image", "name": "HDBackgroundImageUrl", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "BIF URL for HD trick mode", "name": "HDBifUrl", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Boolean indicating if HD branding should be displayed", "name": "HDBranded", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "The image file for the item poster when the screen resolution is set to HD. HDGRIDPOSTERURL is used if non-empty. HDPOSTERURL is used otherwise. See: PosterGrid", "name": "HDGridPosterUrl", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "The image file for the icon to be displayed to the left of the list item label when the list item is focused", "name": "HDListItemIconSelectedURL", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "The image file for the icon to be displayed to the left of the list item label when the list item is not focused", "name": "HDListItemIconURL", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "URL for HD content artwork", "name": "HDPosterUrl", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "The image file for the item poster when the screen resolution is set to HD. HDGRIDPOSTERURL is used if non-empty. HDPOSTERURL is used otherwise. See: PosterGrid", "name": "HDPosterUrl", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "The image file for the channel logo or for an icon that appears beside the program title. See: TimeGrid", "name": "HDSmallIconUrl", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "When set to true, the default, the list item displays the checkbox icon, reflecting the item's current selection state. When set to false, no checkbox icon is displayed, allowing the list to contain a mix of checkbox and regular list items.", "name": "HideIcon", "type": "boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "When set to true the media player will not stop playback when it runs into a streaming related error for this content. Instead, it will skip to the next item in the content list. If this was the last item in the content list the media player will send a regular completion event (like isFullResult). Apps are still notified of any errors via an isRequestFailed notification but a new attribute in the event’s GetInfo object tells the app the error was ignored. See the changes related to isRequestFailed for more information. The default value is false.", "name": "IgnoreStreamErrors", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Boolean indicating if content is HD", "name": "IsHD", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Movie Length in Seconds; Length zero displays at 0m, Length not set will not display", "name": "Length", "type": "Float" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Optional flag indicating video is live. Replaces time remaining in progress bar to display \"Live\". Default is false", "name": "Live", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Allows an app to customize Media Player behavior on live streams when playing in the earliest part of a DVR buffer. The stream remains paused even though it is playing in the earliest part of the buffer of a live stream when the value of the attribute is set to \"pause.\" This enables the Roku OS to distinguish between live streams and live streams that eventually transition to video on demand. The possible values of this attribute are \"resume\", \"stop\", \"pause\", with resume being the default value. \\*\\*Currently, this attribute will work only with Smooth and Dash streams.\\*\\* (Available since Roku OS 8.1)", "name": "LiveBoundsPauseBehavior", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roVideoPlayer or roVideoScreen: Will only select variant streams with a bandwidth less than this maximum bandwidth. Units are kbps", "name": "MaxBandwidth", "type": "Integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roVideoPlayer or roVideoScreen: Will only select variant streams with a bandwidth higher than this minimum bandwidth. Units are kbps. By default Wowza servers set streams to 64 kbs, so you might want to set this parameter to something smaller than 64 when first testing Wowza streams. You will eventually want to specify the Wowza bitrates with a smil file (Please see the encoding guide)", "name": "MinBandwidth", "type": "Integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Number of episodes for a \"season\" or \"series\" contentType", "name": "NumEpisodes", "type": "Integer" }, { "accessPermission": "READ_WRITE", "default": "", "description": "The orderID returned by Roku in the RequestPartnerOrderStatus content node.", "name": "orderId", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "PlayStart defines the start position of the content, in seconds. Starting from Roku OS 8.0, content metadata supports negative PlayStart values. This feature allows the media players to start playbacks distanced from the edge of the live stream", "name": "PlayStart", "type": "Float" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Specifies the audio codec that should be used during playback. The Media Player will select and report to the app only those audio renditions that are encoded with the specified codec. Renditions that are encoded with a different codec are ignored. Possible values of this attribute are \"aac\", \"ac3\" and \"eac3\".", "name": "PreferredAudioCodec", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "", "description": "The original price of the product. Do not include a currency symbol (for example, set this to \"3.99\" instead of \"$3.99\").", "name": "price", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "", "description": "The original price of the product. Do not include a currency symbol (for example, set this to \"3.99\" instead of \"$3.99\").", "name": "priceDisplay", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "An opaque, unique identifier for the content the app is playing. Each movie, episode, or other content in the app should have a different program ID value. This identifier is used to debug content-specific playback issues. Roku will reference this programID in playback error reports, allowing developers to identify the content that failed to play.", "name": "ProgramID", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Selects an icon to be displayed for the corresponding MPAA or TV rating, that is, the value will display as an icon artwork. See \\[Rating Attribute Icons\\](/docs/developer-program/getting-started/architecture/content-metadata.md#rating-attribute-icons) for a list of the acceptable values and the corresponding icon.", "name": "Rating", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Formatted Date String", "name": "ReleaseDate", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roListScreen: URL for the SD background image", "name": "SDBackgroundImageUrl", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "BIF URL for SD trick mode", "name": "SDBifUrl", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "The image file for the item poster when the screen resolution is set to HD. SDGRIDPOSTERURL is used if non-empty. SDPOSTERURL is used otherwise. See: PosterGrid", "name": "SDGridPosterUrl", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "URL for SD content artwork", "name": "SDPosterUrl", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "The image file for the item poster when the screen resolution is set to SD. SDGRIDPOSTERURL is used if non-empty. SDPOSTERURL is used otherwise. See: PosterGrid", "name": "SDPosterUrl", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "The image file for the item poster when the screen resolution is set to SD. SDGRIDPOSTERURL is used if non-empty. SDPOSTERURL is used otherwise. See: PosterGrid", "name": "SDPosterUrl", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Secondary title for the video content", "name": "SecondaryTitle", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Line 1 of Poster Screen Description", "name": "ShortDescriptionLine1", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "The text for the first grid item caption.", "name": "ShortDescriptionLine1", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Line 2 of Poster Screen Description", "name": "ShortDescriptionLine2", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "The text for the second grid item caption.", "name": "ShortDescriptionLine2", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Specifies the star rating to display as red star icon artwork, as a number from 1 to 100: \\* 20 displays one star \\* 40 displays two stars \\* 60 displays three stars \\* 80 displays four stars \\* 100 displays five stars Numbers not divisible by 20 are displayed as a fractional star (A number of 30 will display one and a half stars)", "name": "StarRating", "type": "Integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Supported by roVideoPlayer and roVideoScreen, but not the Roku Scene Graph Video node. For the Video node, use the top level url, streamformat, etc. attributes. The exception is cases where you don't have adaptive streams (typically MP4) and need to specify different bitrate variants separately. For this use case use the Streams attribute. roAssociativeArray that has parameters representing the stream settings that were set as individual roArrays in previous firmware revisions. The old method is still supported and descriptions of the parameters can be found under those content-meta data entries. For url please see StreamUrls, for quality it is now a Boolean that is true for HD quality.\n\n| Key | Type |\n| --- | --- |\n| url | String |\n| stickyredirects | Boolean |\n| quality | Boolean |\n| contentid | String |\n| bitrate | Integer |", "name": "Stream", "type": "roAssociativeArray" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Array of bitrates in kbps for content streams used. Setting stream bitrates using this value is recommended for non-adaptive video (such as MP4 progressive download) only. \\*\\*Must be used in conjunction with StreamUrls and StreamQualities\\*\\*", "name": "StreamBitrates", "type": "roArray" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "array of strings values logged in Roku logs to identify stream and bitrate played", "name": "StreamContentIDs", "type": "roArray" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Type of content \\* Type of content: \\* Default: H.264/AAC in .mp4 Container \\* Valid values: \\* \"mp4\" (mp4 will also accept .mov and .m4v files) \\* \"wma\" (deprecated) \\* \"mp3\" \\* \"hls\" -\"ism\" (smooth streaming) \\* \"dash\" (MPEG-DASH) \\* \"mkv\", \"mka\", \"mks\" \\* Deprecated: \\* \"wmv\"", "name": "StreamFormat", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Array of Strings quality indicators identifying a stream as \"SD\" or \"HD\". \\*\\*Must be used in conjunction with StreamBitrates and StreamUrls\\*\\*", "name": "StreamQualities", "type": "roArray" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Used by roVideoPlayer and roVideoScreen to specify the content metadata for a set of fixed bitrate streams. Each array item specifies the URL, bitrate, etc. for one stream variant. Setting stream content metadata using the Streams value is recommended for non-adaptive video (such as MP4 progressive download) only. For adaptive streaming, use the Stream metadata value.\n\n| Key | Type |\n| --- | --- |\n| url | String |\n| stickyredirects | Boolean |\n| quality | Boolean |\n| contentid | String |\n| bitrate | Integer |", "name": "Streams", "type": "roArray of roAssociativeArrays" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Optional. Default is 0. The offset into the stream which is considered the beginning of playback. Time in seconds.", "name": "StreamStartTimeOffset", "type": "Integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Array of Boolean values indicating if the HTTP endpoint should be sticky and not subject to change on subsequent requests. Default is false", "name": "StreamStickyHttpRedirects", "type": "roArray" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Array of URLs for content streams. Setting stream urls using this value is recommended for non-adaptive video (such as MP4 progressive download) only. \\*\\*Must be used in conjunction with StreamBitrates and StreamQualities\\*\\*", "name": "StreamUrls", "type": "roArray" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Theme metadata attribute that specifies the color to use when rendering subtitle text", "name": "SubtitleColor", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Specifies the caption settings for content playback. TrackName sets the name of the caption track to render. This string is a concatenation of the track source and track id, separated by a \"/\". Valid track sources are: \"ism\", \"mkv\", \"eia608\" and \"dvb\". The track id must match the track identifier in the smooth or mkvmanifest. For example, if an mkvfile has a caption track called “english1” the TrackName to select this track is “mkv/english1”. When the track source is \"dvb\", the track id is the three-letter language code, with \"\\\\\\_sdh\" appended for subtitles for the deaf and hard of hearing. For example, \"dvb/eng\\\\\\_sdh\" are English subtitles for the deaf and hard of hearing and \"dvb/nor\" are normal Norwegian subtitles. For sideloaded caption tracks, the TrackName is the url from where the caption track can be downloaded.Sideloaded caption formats can include srt,ttml, anddfxp. Specifying eia608/1 will trigger the Roku OS to search for embedded 608/708 captions in the stream. In the 8.0 Roku OS, automatic track selection based on a preferred caption language setting is introduced. Omit setting a URL here to avoid interfering with the automatic track selection. It is sufficient to add the URLs to SubtitleTracks", "name": "SubtitleConfig", "type": "roAssociativeArray" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "SubtitleTracks sets the list of available caption tracks available to the stream. This list is added to the track list in the closed caption configuration dialog that is displayed during video playback when the user presses the Roku remote control \\\\\\* button. The captions from the selected track are then displayed on the screen. Language specifies the ISO 639.2B 3 character language code. This string is used to match the proper caption track with the audio language. Description specifies the text that will be shown for the corresponding track in the closed caption configuration dialog. For sideloaded caption tracks the TrackName is the URL from where the caption track can be downloaded. Sideloaded caption formats can include srt, ttml, and dfxp. The SubtitleTracks metadata is generally only used for side loaded captions. the Roku OS detects in-stream captions and thus specifying SubtitleTracks in this case is not necessary", "name": "SubtitleTracks", "type": "roArray of roAssociativeArray" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Specifies the path to an SRT or TTML formatted file used to render subtitles or closed captions, respectively. This is supported on roVideoScreen only. See \\[Closed Caption Support\\](/docs/developer-program/media-playback/closed-caption.md) for additional details", "name": "SubtitleUrl", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roVideoPlayer or roVideoScreen. Specify different stream switching algorithms to be used in HLS adaptive streaming. Only has an effect on HLS streams. \"full-adaptation\" uses measured bandwidth and buffer fullness to determine when to switch. This strategy requires that segments align across variants as the HLS spec requires. This is the new default", "name": "SwitchingStrategy", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roSlideShow displays this string on the bottom part of slide", "name": "TextOverlayBody", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roSlideShow displays this string in Upper Left corner of slide", "name": "TextOverlayUL", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roSlideShow displays this string in Upper Right corner of slide", "name": "TextOverlayUR", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Content title: movie title for films; episode title for TV series", "name": "Title", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Season title for TV series", "name": "TitleSeason", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roVideoPlayer or roVideoScreen: Used in SmoothStreaming (StreamFormat = \"ISM\") to specify. Set the TrackIDAudio field to the desired track's StreamIndex.Name attribute from the manifest file", "name": "TrackIDAudio", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roVideoPlayer: Used to specify a closed caption track in a video stream that supports 608/708 captions", "name": "TrackIDSubtitle", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "roVideoPlayer or roVideoScreen: Used in SmoothStreaming (StreamFormat = \"ISM\") to specify. Set the TrackIDVideo field to the desired track's StreamIndex.Name attribute from the manifest file", "name": "TrackIDVideo", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Stream URL for Scene Graph Video node", "name": "Url", "type": "String" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Specifies the user star rating to display as yellow star icon artwork, as a number from 1 to 100: \\* 20 displays one star \\* 40 displays two stars \\* 60 displays three stars \\* 80 displays four stars \\* 100 displays five stars Does not display fractional stars for numbers not divisible by 20", "name": "UserStarRating", "type": "Integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "If set to true, hides the Scene Graph Video node trick play UI; If set to false (the default) shows the Scene Graph Video node trick play UI", "name": "VideoDisableUI", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "When the fixedLayout field is set to true, this specifies how many columns the grid item occupies. If not specified, the default value of 1 is used.\nFor example, if the numColumns field were set to 3 and a grid item is to occupy the rightmost two columns, X would be set to 1 and W would be set to 2.", "name": "W", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "Flag indicating if content has been watched", "name": "Watched", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "When the fixedLayout field is set to true, this specifies the first row of the grid occupied by this item, where 0 refers to the first row. Note that there can be more rows in the data than visible rows, where the number of visible rows is specified by the numRows field.\nFor example, if the data model contains enough data to fill 12 rows, X would be set to a value from 0 to 11.", "name": "X", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "not specified", "description": "When the fixedLayout field is set to true, this specifies the first column of the grid occupied by this item, where 0 refers to the first column. Note that the number of columns is always specified by the numColumns field, regardless of how many items are in the data model.\nFor example, if the numColumns field is set to 3, Y would be set to 0, 1 or 2.", "name": "Y", "type": "integer" } ], "interfaces": [], "name": "ContentNode", "url": "https://developer.roku.com/docs/references/scenegraph/control-nodes/contentnode.md" }, "dialog": { "description": "> Roku OS 10.0 introduced a new [StandardDialog node](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/standard-dialog.md\"**Standard Dialog**\"), which features updated graphics and color palette support. This enables developers to provide a consistent user experience across the dialogs in their app. Developers should replace the legacy Dialog nodes in their app with the new [StandardDialog nodes](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/standard-dialog.md\"**Standard Dialog**\").\n\nExtends [**Group**](https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md\"**Group**\")\n\nThe Dialog node class defines a modal pop-up dialog used to present the user with information requiring their immediate attention.\n\nSetting the dialog field of the current Scene node to a Dialog node causes the dialog to be displayed.\n\nThe Dialog node is configured to have up to five regions: the title, message, bullet text, graphic, and button regions. All of these are optional except for the title.\n\n* The title region consists of a an icon and a title label, along with a horizontal divider that visually separates the title from the rest of the dialog.\n \n* The message region consist of a string that is displayed below the title divider.\n \n* The bullet text region contains a set of zero or more bullet points. It is displayed below the message.\n \n* The graphic region consists of a single bitmap displayed center-aligned below the message and bullet text and above the button region.\n \n* The button region contains a ButtonGroup node that contains zero or more Button nodes, arranged vertically.\n \n\nDialogs are modal and intercept all key events except pressing the Home key. Dialogs are closed automatically when the user presses the Home key or the Back key. If the optionsDialog field is set to true, pressing the Options key also closes the dialog.\n\nOnly a single dialog may appear at any time. If a second dialog is shown, the previous dialog is closed automatically.", "events": [], "extends": { "name": "DialogBase", "url": "https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies the bitmap to be displayed as the dialog background. Usually this is a 9-patch image to support dynamic resizing. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap", "name": "backgroundUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "[ ]", "description": "An array of strings to be displayed as a list of bullet points", "name": "bulletText", "type": "array of strings" }, { "accessPermission": "READ_WRITE", "default": "N/A", "description": "When set, the color of the bullet point text", "name": "bulletTextColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "N/A", "description": "When set, the font of the bullet point text", "name": "bulletTextFont", "type": "Font" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "Set to the index of the focused button whenever a button in the group receives the key focus", "name": "buttonFocused", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "", "description": "The dialog internal ButtonGroup node. This allows the appearance attributes of all the Button nodes in the dialog to be easily modified. Since the ButtonGroup node class is derived from the LayoutGroup node class, additional non-Button node children can also be added", "name": "buttonGroup", "type": "ButtonGroup" }, { "accessPermission": "WRITE_ONLY", "default": "[ ]", "description": "Allows a set of Button nodes to be easily created by providing an array of Button labels. Each string in the array will result in a Button node to be added to the ButtonGroup, using the string as the Button label", "name": "buttons", "type": "array of strings" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "Set to the index of the selected button whenever the user selects a button in the group", "name": "buttonSelected", "type": "integer" }, { "accessPermission": "WRITE_ONLY", "default": "false", "description": "Causes the dialog to be dismissed. The dialog is dismissed whenever the close field is set, regardless of whether the field is set to true or false", "name": "close", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies a bitmap to be displayed as the divider between the title region and the remainder of the dialog. Usually this is a 9-patch image to support dynamic resizing. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap", "name": "dividerUri", "type": "uri" }, { "accessPermission": "WRITE_ONLY", "default": "0", "description": "Causes the button with the specified index to receive the focus when the ButtonGroup node has the key focus. Note that if the ButtonGroup node does not have the key focus when the focusButton field is set, the specified button will display the focus footprint as its background", "name": "focusButton", "type": "integer" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "Specifies the height of the bitmap graphic in local coordinates. If set to 0.0, the height of the bitmap from the image file is used. If set to a value greater than 0.0, the bitmap is scaled to that height. The graphicWidth and graphicHeight fields both must be set in order to be applied, and both fields must be set before the graphicURI field.", "name": "graphicHeight", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies a bitmap to be displayed in the dialog. The bitmap is displayed below the bullet text region and above the buttons. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap", "name": "graphicUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "Specifies the width of the bitmap graphic in local coordinates. If set to 0.0, the width of the bitmap from the image file is used. If set to a value greater than 0.0, the bitmap is scaled to that width. The graphicWidth and graphicHeight fields both must be set in order to be applied, and both fields must be set before the graphicURI field.", "name": "graphicWidth", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies a bitmap to be displayed as a small icon next to the dialog title. Only set this field to specify a custom bitmap that differs in appearance from the default bitmap", "name": "iconUri", "type": "uri" }, { "accessPermission": "READ_WRITE", "default": "-1.0", "description": "Sets the maximum height of the dialog. By default, the Dialog will scale the height based on the contents but never larger than the height of the display resolution. Setting maxHeight smaller than the contents will switch to a scrollable text region", "name": "maxHeight", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "The string to be displayed in the message region of the dialog. Newline and carriage return characters in the string result in the message being displayed as several lines of text. In BrightScript, to include a newline in a string, use chr(10). For example: \\`message = \"First line\" + chr(10) + \"Second line\"\\`", "name": "message", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "N/A", "description": "When set, the color of the message text", "name": "messageColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "N/A", "description": "When set, the font of the message text", "name": "messageFont", "type": "Font" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "If set to true, the bulletText will be displayed with numbers rather than bullets", "name": "numberedBullets", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "If set to true, the dialog is automatically dismissed when the Options key is pressed", "name": "optionsDialog", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Title of the dialog box", "name": "title", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "N/A", "description": "When set, the color of the title", "name": "titleColor", "type": "color" }, { "accessPermission": "READ_WRITE", "default": "N/A", "description": "When set, the font of the title", "name": "titleFont", "type": "Font" }, { "accessPermission": "READ_WRITE", "default": "N/A", "description": "Set when the dialog has been closed. The field is set when the dialog close field is set, when the Back or Home key has been pressed, when the Options key has been pressed if the optionsDialog field is set to true, and when the dialog is dismissed because another dialog was displayed", "name": "wasClosed", "type": "Event" }, { "accessPermission": "READ_WRITE", "default": "-1.0", "description": "Specifies the width of the dialog. By default, this value is pulled from the system theme", "name": "width", "type": "float" } ], "interfaces": [], "name": "Dialog", "url": "https://developer.roku.com/docs/references/scenegraph/dialog-nodes/dialog.md" }, "dialogbase": { "description": "The base dialog component.", "events": [], "extends": { "name": "Group", "url": "https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "true", "description": "When set to `true`, dialog will close on back button press", "name": "backExitsDialog", "type": "boolean" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "Indicates the index of the button that gained focus when the user moved the focus onto one of the buttons in the button area.", "name": "buttonFocused", "type": "int" }, { "accessPermission": "READ_ONLY", "default": "0", "description": "Indicates the index of the selected button when the user selects one of the buttons in the button area.", "name": "buttonSelected", "type": "int" }, { "accessPermission": "WRITE_ONLY", "default": "false", "description": "Dismisses the dialog. The dialog is dismissed whenever the close field is set, regardless of whether the field is set to true or false.", "name": "close", "type": "boolean" }, { "accessPermission": "READ_WRITE", "default": "true", "description": "When set to `true`, dialog will close on back button press", "name": "homeExitsDialog", "type": "boolean" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "If set to true, the dialog is automatically dismissed when the Options key is pressed", "name": "optionsDialog", "type": "Boolean" }, { "accessPermission": "READ_WRITE", "default": "not set", "description": "Sets the color palette for the dialog's background, text, buttons, and other elements. By default, no palette is specified; therefore, the dialog inherits the color palette from the nodes higher in the scene graph (typically, from the dialog's \\[Scene\\](https://developer.roku.com/docs/references/scenegraph/scene.md node, which has a \\*\\*palette\\*\\* field that can be used to consistently color the standard dialogs and keyboards in the app). The RSGPalette color values used by the StandardDialog node are as follows:\n\n| Palette Color Name | Usages |\n| --- | --- |\n| DialogBackgroundColor | Blend color for dialog's background bitmap. |\n| DialogItemColor | Blend color for the following items: * [StdDlgProgressItem's](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-progress-item.md spinner bitmap * [StdDlgDeterminateProgressItem's](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-determinate-progress-item.md graphic |\n| DialogTextColor | Color for the text in the following items: * [StdDlgTextItem](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-text-item.md and [StdDlgGraphicItem](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-graphic-item.md if the **namedTextStyle** field is set to \"normal\" or \"bold\". * All [content area items](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-item-base.md, except for [StdDlgTextItem](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-text-item.md and [StdDlgGraphicItem](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-graphic-item.md. * [Title area](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-title-area.mdfields). Unfocused button. |\n| DialogFocusColor | Blend color for the following: * The [button area](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-button-area.mdfields) focus bitmap. * The focused scrollbar thumb. |\n| DialogFocusItemColor | Color for the text of the focused button. |\n| DialogSecondaryTextColor | Color for the text of in the following items: * [StdDlgTextItem](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-text-item.md and [StdDlgGraphicItem](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-graphic-item.md if the **namedTextStyle** field is set to \"secondary\". * Disabled button. |\n| DialogSecondaryItemColor | Color for the following items: * The divider displayed below the title area. * The unfilled portion of the [StdDlgDeterminateProgressItem's](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-determinate-progress-item.md graphic. |\n| DialogInputFieldColor | The blend color for the text edit box background bitmap for keyboards used inside dialogs. |\n| DialogKeyboardColor | The blend color for the keyboard background bitmap for keyboards used inside dialogs |\n| DialogFootprintColor | The blend color for the following items: * The button focus footprint bitmap that is displayed when the [button area](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/std-dlg-button-area.mdfields) does not have focus. * Unfocused scrollbar thumb and scrollbar track. |", "name": "palette", "type": "RSGPalette node" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "The title to be displayed at the top of the dialog.", "name": "title", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "N/A", "description": "Set when the dialog has been closed. The field is set when the dialog close field is set, when the Back or Home key has been pressed, when the Options key has been pressed if the optionsDialog field is set to true, and when the dialog is dismissed because another dialog was displayed", "name": "wasClosed", "type": "Event" }, { "accessPermission": "READ_WRITE", "default": "-1.0", "description": "Specifies the width of the dialog. By default, this value is pulled from the system theme", "name": "width", "type": "float" } ], "interfaces": [], "name": "DialogBase" }, "dynamiccustomkeyboard": { "description": "Extends [DynamicKeyboardBase](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md\"DynamicKeyboardBase\")\n\nThe **DynamicCustomKeyboard** node enables developers to create a voice-enabled keyboard that has a custom layout. As specified in its parent [DynamicKeyboardBase](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md\"DynamicKeyboardBase\") class, the **DynamicCustomKeyboard** node has a built-in [**VoiceTextEditBox**](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/voice-text-edit-box.md node for displaying the string of characters provided via text or voice entry, and it has a [**DynamicKeyGrid**](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-key-grid.md node that provides keyboard functionality.\n\nThe layout of the keyboard is customized based on a JSON-formatted Key Definition File. In the Key Definition File, the developer labels the individual keys and groups them into sections and rows. The key labels support the characters in the Basic Latin, Latin 1 Supplement, Latin Extended-A, and Latin Extended-B blocks. This provides support for most Western European languages, including English, French, German, Italian, Portuguese, and Spanish.\n\n![roku815px - address-keyboard-voice](https://image.roku.com/ZHZscHItMTc2/address-keyboard-voice.jpg)", "events": [], "extends": { "name": "DynamicKeyboardBase", "url": "https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md" }, "fields": [ { "accessPermission": "READ", "default": "The DynamicKeyGrid node associated with the keyboard", "description": "Provides access to the internal \\*\\*DynamicKeyGrid\\*\\* node of this \\*\\*DynamicKeyboardBase\\*\\* component. Do not set this field to null or to a different DynamicKeyGrid node; this field should be used only to access the fields of this component's internal DynamicKeyGrid node. > The \\*\\*DynamicKeyGrid\\*\\*.\\*\\*keyDefinitionUri\\*\\* field must be set to the custom Key Definition File that defines the keyboard's layout.", "name": "keyGrid", "type": "DynamicKeyGrid node" } ], "interfaces": [], "name": "DynamicCustomKeyboard", "url": "https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-custom-keyboard.md" }, "dynamickeyboard": { "description": "Extends [DynamicKeyboardBase](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md\"**DynamicKeyboardBase**\")\n\nThe **DynamicKeyboard** node is similar to the [legacy **Keyboard** node](https://developer.roku.com/docs/references/scenegraph/widget-nodes/keyboard.md, but with additional voice entry functionality. It enables text entry of alphanumeric and Latin characters, and voice entry of alphanumeric characters. It is typically used for entering email addresses or passwords.\n\nThe key layout is fixed based on the node's pre-built Key Definition File.\n\n![roku815px - dynamic-keyboard-voice](https://image.roku.com/ZHZscHItMTc2/dynamic-keyboard-voice.jpg)", "events": [], "extends": { "name": "DynamicKeyboardBase", "url": "https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md" }, "fields": [], "interfaces": [], "name": "DynamicKeyboard", "url": "https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard.md" }, "dynamickeyboardbase": { "description": "Extends [**Group**](https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md\"**Group**\")\n\n> Apps must use Roku voice keyboards for [email](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard.md, [PIN](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-pinpad.md, [password](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard.md entry to pass [certification](/docs/developer-program/certification/certification.md#4-channel-operation).\n\nThe DynamicKeyboardBase is an abstract class that provides the functionality for dynamic voice-enabled keyboards. It combines [**DynamicKeyGrid**](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-key-grid.md and [**VoiceTextEditBox**](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/voice-text-edit-box.md nodes to provide a single node that supports text entry in multiple languages and voice entry in English and Spanish.\n\n* The [**DynamicKeyGrid**](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-key-grid.md provides keyboard functionality. The layout of the keyboard is based on a JSON-formatted Key Definition File.\n \n The classes derived from DynamicKeyboardBase (DynamicKeyboard, DynamicPinPad, and DynamicMiniKeyboard) have built-in Key Definition Files. For example, the DynamicKeyboard node uses a Key Definition File that matches the key layout of the [legacy Keyboard node](https://developer.roku.com/docs/references/scenegraph/widget-nodes/keyboard.md.\n \n The [**DynamicCustomKeyboard** node](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-custom-keyboard.md enables developers to define a custom Key Definition File in order to configure the key layout. In the Key Definition File, the developer specifies the keys in each section and row of the keyboard. The keys support the characters in the Basic Latin, Latin 1 Supplement, Latin Extended-A, and Latin Extended-B blocks. This provides support for most Western European languages, including English, French, German, Italian, Portuguese, and Spanish.\n \n\n* The [**VoiceTextEditBox**](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/voice-text-edit-box.md displays the text that has been entered or spoken. This node supports multiple voice entry modes for entering email addresses, passwords, street addresses, and PINs. This node currently supports voice entry in English and Spanish.\n\n> Developers should upgrade the [legacy keyboards](https://developer.roku.com/docs/references/scenegraph/widget-nodes/keyboard.md in their apps to dynamic voice-enabled keyboards in order to leverage the following benefits:\n> \n> * **Faster on-device sign-ups and sign-ins.** Enable customers to use voice entry to provide their information when subscribing to apps and logging in.\n> \n> * **Localized in-app search**: Enable customers to search for content in their native language.\n> \n> * **Localized customer information entry**: Enable customers to enter their personal information in their native language.\n>", "events": [], "extends": { "name": "Group", "url": "https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "\"generic\"", "description": "The keyboard mode, which may be one of the following: \\* \"email\": letter-by-letter dictation for emails. \\* \"numeric\": letter-by-letter dictation for PIN codes, zip codes, and other numeric input. \\* \"alphanumeric\": letter-by-letter dication for street addresses or other sequences of numbers and letters. \\* \"generic\": Full word input for search queries or other sequences of numbers, letters and symbols. \\* \"password\": letter-by-letter dication for passwords. The domain may be used to: \\* Set options for the speech recognition system. \\* Identify when a complete string has been entered (for example, an email address). \\* Specify whether the entered string is displayed as a single string or a discrete sequence of characters (for example, a PIN code). \\* Enable key suggestions (for example, a pop-up for the ampersand key (&) to provide common email choices).", "name": "domain", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Hides the keyboard's internal \\*\\*VoiceTextEditBox\\*\\*, and renders the keyboard's \\*\\*DynamicKeyGrid\\*\\* at the top of the node.", "name": "hideTextBox", "type": "boolean" }, { "accessPermission": "READ", "default": "The DynamicKeyGrid associated with the keyboard", "description": "The internal \\[DynamicKeyGrid node\\](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-key-grid.md used by this DynamicKeyboardBase node. Do not set this field to null or to a different DynamicKeyGrid node; this field should be only used to access the fields of this node's internal DynamicKeyGrid node, such as the mode or horizWrapping fields.", "name": "keyGrid", "type": "**[DynamicKeyGrid node](/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-key-grid.md)**" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Contains the string of characters that has been entered. The text written to this field may also be displayed in the VoiceTextEditBox.", "name": "text", "type": "string" }, { "accessPermission": "READ", "default": "The VoiceTextEditBox associated with the keyboard", "description": "The internal \\[VoiceTextEditBox node\\](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/voice-text-edit-box.md used by this DynamicKeyboardBase node. Do not set this field to null or to a different VoiceTextEditBox node; this field should be used only to access the fields of this node's internal VoiceTextEditBox node.", "name": "textEditBox", "type": "[**VoiceTextEditBox** node](/docs/references/scenegraph/dynamic-voice-keyboard-nodes/voice-text-edit-box.md)" } ], "interfaces": [], "name": "DynamicKeyboardBase", "url": "https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md" }, "dynamickeygrid": { "description": "Extends [**Group**](https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md\"**Group**\")\n\nThe **DynamicKeyGrid** node implements a grid of keys that are defined and organized in a [Key Definition File](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/key-definition-file.md. It is typically used in a subclass of the [DynamicKeyboardBase](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md node (DynamicKeyboard, DynamicPinPad, and DynamicMiniKeyboard) to display the string of characters entered via text or voice entry. It may also be used as an individual node.", "events": [], "extends": { "name": "Group", "url": "https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md" }, "fields": [ { "accessPermission": "WRITE-ONLY", "default": "\"\"", "description": "Draws the key's label or icon with a disabled appearance and prevents the key from gaining focus. If the key has focus when it becomes disabled, the focus is automatically moved to an adjacent key that is not disabled (the key above the disabled key is checked first, then the key below, to the right, and then to the left). To disable/enable a key, set the respective field to the key's \\*\\*label\\*\\* or \\*\\*StrOut\\*\\* value as defined in the Key Definition File. For example, to disable the \"backspace\" key, which typically has a delete icon displayed on the keyboard, enter the following: m.keyboard.keyGrid.disableKey = \"backspace\". Multiple keys may be disabled at any time by setting the write-only \\*\\*disableKey\\*\\* field once for each key to be disabled.", "name": "disableKey", "type": "string" }, { "accessPermission": "WRITE-ONLY", "default": "\"\"", "description": "Draws the key's label or icon with an enabled appearance and allows the key to gain focus. To disable/enable a key, set the respective field to the key's \\*\\*label\\*\\* or \\*\\*StrOut\\*\\* value as defined in the KDF file. For example, to enable the \"backspace\" key, which typically has a delete icon displayed on the keyboard, enter the following: m.keyboard.keyGrid.enableKey = \"backspace\". Multiple disabled keys may be re-enabled at any time by setting the write-only \\*\\*enableKey\\*\\* field once for each key to be enabled.", "name": "enableKey", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "true", "description": "Enables the grid's focus indicator to be hidden. This option is typically used in PinPads to hide the entered characters.", "name": "focusVisible", "type": "boolean" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Specifies whether the key grid uses horizontal wrapping. \\* \\*\\*true\\*\\*: A horizontal arrow keypress causes the focus to wrap from the key at the left (or right) edge of the grid to the key at the right (or left) edge. \\* \\*\\*false\\*\\*: The horizontal arrow keypress is not handled by the DynamicKeyGrid node; it is propagated up the scene graph so that it can be handled by one of its ancestor nodes.", "name": "horizWrap", "type": "boolean" }, { "accessPermission": "WRITE", "default": "N/A", "description": "Jumps the grid to the key to the coordinates specified in the provided array. The array must contain a valid section, row and key index for the current keyboard mode. If the array specifies an invalid key, no jump occurs.", "name": "jumpToKey", "type": "array of integers" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies the \\[Key Definition File\\](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/key-definition-file.md to use to define the key layout metadata.", "name": "keyDefinitionUri", "type": "uri" }, { "accessPermission": "READ", "default": "\"\"", "description": "Specifies the appearance of a key when it receives focus, based on the key's \\*\\*strOut\\*\\* value. \\* If the key's \\*\\*strOut\\*\\* value (as specified in the Key Definition File) is non-empty, this field is set to the \\*\\*strOut\\*\\* value. \\* If \\*\\*strOut\\*\\* is an empty string, this field is set to the key's label string.", "name": "keyFocused", "type": "string" }, { "accessPermission": "READ", "default": "\"\"", "description": "Specifies the appearance of a key when it is selected, based on the key's \\*\\*strOut\\*\\* value. \\* If the key's \\*\\*strOut\\*\\* value (as specified in the Key Definition File) is non-empty, this field is set to the \\*\\*strOut\\*\\* value. \\* If \\*\\*strOut\\*\\* is an empty string, this field is set to the key's label string.", "name": "keySelected", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies the keyboard mode. When set, the value is used to select which Grid of each Section is used, based on the grid's mode as specified in the Key Definition File.", "name": "mode", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "not set", "description": "The \\[RSGPalette node\\](https://developer.roku.com/docs/references/scenegraph/scene.md contains the set of color values used by this DynamicKeyGrid node. By default, no RSGPalette is specified; therefore, the RSGPalette colors are inherited from the ancestor nodes in the scene graph. If the DynamicKeyboardBase node is used within a StandardDialog node, the following rules determine the color palette used by the keyboard: \\* If the \\*\\*palette\\*\\* field is set, the key grid uses it. \\* If the \\*\\*palette\\*\\* field is not set, the key grid looks up the scene graph until it finds a \\*\\*PaletteGroup\\*\\* node with its \\*\\*palette\\*\\* field set. This may be found in a \\*\\*DynamicKeyboard\\*\\* node, a \\*\\*StandardDialog\\*\\* node, or the \\*\\*Scene\\*\\* itself. \\* If no node has its \\*\\*palette\\*\\* field set, the key grid uses the default palette (gray background/white text). The RSGPalette color values used by the DynamicKeyboardBase are as follows:\n\n| Palette Color Name | Usages |\n| --- | --- |\n| KeyboardColor | Blend color for key background bitmap. |\n| PrimaryTextColor | Text color used for non-focused keys. Blend color for the icons of non-focused keys. Text color for the label of focused key suggestion items. |\n| SecondaryItemColor | Text color for disabled keys. Blend color for the icons of disabled keys. |\n| FocusColor | Blend color for the focus indicator. Blend color for the background of key suggestion pop-us. |\n| FocusItemColor | Text color for the label of the focused key. Blend color for the icons of the focused key and the focus indicator in key suggestion pop-ups. Text color for the labels of non-focused key suggestion items. |", "name": "palette", "type": "RSGPalette node" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Specifies whether the key grid uses vertical wrapping. \\* \\*\\*true\\*\\*: A vertical arrow keypress causes the focus to wrap from the key at the top (or bottom) edge of the grid to the key at the bottom (or top) edge. \\* \\*\\*false\\*\\*: The vertical arrow key press is not be handled by the DynamicKeyGrid node; it is propagated up the scene graph so that it can be handled by one of its ancestor nodes.", "name": "vertWrap", "type": "boolean" } ], "interfaces": [], "name": "DynamicKeyGrid", "url": "https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-key-grid.md" }, "dynamicminikeyboard": { "description": "Extends [DynamicKeyboardBase](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md\"**DynamicKeyboardBase**\")\n\nThe **DynamicMiniKeyboard** node is similar to the [legacy **MiniKeyboard** node](https://developer.roku.com/docs/references/scenegraph/widget-nodes/minikeyboard.md, but with additional voice entry functionality. It enables text and voice entry of letters A-Z and digits 0-9. It is typically used for entering a search query.\n\nThe key layout is fixed based on the node's pre-built Key Definition File.\n\n![roku815px - dynamic-mini-keyboard](https://image.roku.com/ZHZscHItMTc2/dynamic-mini-keyboard.jpg)", "events": [], "extends": { "name": "DynamicKeyboardBase", "url": "https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md" }, "fields": [], "interfaces": [], "name": "DynamicMiniKeyboard", "url": "https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-mini-keyboard.md" }, "dynamicpinpad": { "description": "Extends [DynamicKeyboardBase](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md\"**DynamicKeyboardBase**\")\n\nThe **DynamicPinPad** node is similar to the [legacy **PinPad** node](https://developer.roku.com/docs/references/scenegraph/widget-nodes/pinpad.md, but with additional voice entry functionality. It enables text and voice entry of numeric characters. It is typically used for entering short numeric PIN codes.\n\nThe key layout is fixed based on the node's pre-built Key Definition File.\n\n![roku815px - dynamic-pinpad-voice](https://image.roku.com/ZHZscHItMTc2/dynamic-pinpad-voice.jpg)", "events": [], "extends": { "name": "DynamicKeyboardBase", "url": "https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md" }, "fields": [], "interfaces": [], "name": "DynamicPinPad", "url": "https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-pinpad.md" }, "floatfieldinterpolator": { "description": "Extends [**Node**](https://developer.roku.com/docs/references/scenegraph/node.md\n\nThe FloatFieldInterpolator node class specifies a keyframe animation sequence to be applied to a floating point field of a node (such as, an opacity, width or height value.)\n\nAll field interpolators include a set of key/keyValue pairs that define a keyframe of the animation. Field interpolators are generally used as children of an Animation node. As the animation progresses, it sets the fraction field of its field interpolators to a value between 0 and 1, indicating the percentage of the Animation's progress. The keyframes of the interpolator include a \"key\", the percentage where the keyframe should occur, and a \"keyValue\", the value that the field should have at that percentage.\n\nFor example, if a FloatFieldInterpolator had three keyframes, (0.0, 10.0), (0.4, 200.0) and (1.0, 87.0), then when the interpolator's fraction field was 0.0 (i.e. 0%), the field would be set to 10.0. When fraction was 0.4 (i.e. 40%), the field would be set to 200.0. When fraction was 1.0 (i.e. 100%), the field would be set to 87.0.\n\nFor values of fraction between 0.0 and 0.4 (e.g. 0.2 or 20%), the field value is determined by linearly interpolating the keyValues for the first two keyframes. In this case, since the key of 0.2 is halfway between the key at 0.0 and the key at 0.4, the field would be set to 10.0 + 0.5 \\* (10.0 + 200.0) = 105.0. Similarly, when fraction is between the second and third keys (i.e. between 0.4 and 1.0), the field value is determined by linearly interpolating the keyValues of the second and third keyframes.\n\nIf the first keyframe has a key percentage greater than zero, then the field value will be equal to the keyValue of the first keyframe until fraction reaches the first keyframe's key percentage. Similarly, if the last keyframe has a key percentage less than one, the field value will be set to the keyValue of the last keyframe from when fraction equals the the last keyframe's key percentage and will not change as fraction increases from that value to 1.0.\n\n> While linearly interpolation is used to compute the keyValue's for fraction values between successive keys, non-linear easing functions may be applied to the fraction values computed by the Animation node, so the overall animation may vary in speed.", "events": [], "extends": { "name": "Node", "url": "https://developer.roku.com/docs/references/scenegraph/node.md" }, "fields": [ { "accessPermission": "READ_WRITE", "default": "\"\"", "description": "Specifies the field to interpolate. The string should contain the ID of a node in the scene and the name of a field of that node, separated by a dot \".\". For example, \"title.width\" would indicate that the interpolator should be applied to the width field of a node whose id field was \"title\". The specified field must be of type float", "name": "fieldToInterp", "type": "string" }, { "accessPermission": "READ_WRITE", "default": "0.0", "description": "Specifies the percentage to be used to compute a value for the field", "name": "fraction", "type": "float" }, { "accessPermission": "READ_WRITE", "default": "[ ]", "description": "Specifies the key percentages for the interpolator's keyframes. Each key percentage should be a unique value from 0 to 1 indicating the percentage of the animation where the keyValue should occur. Behavior is undefined if the number of values in the key field does not match the number of values in the keyValue field", "name": "key", "type": "array of floats" }, { "accessPermission": "READ_WRITE", "default": "[ ]", "description": "Specifies the key values or the interpolator's keyframes. Each value in the keyValue array corresponds to a value in the key field's array. The interpolator's behavior is undefined if the number of values in the key field does not match the number of values in the keyValue field", "name": "keyValue", "type": "array of floats" }, { "accessPermission": "READ_WRITE", "default": "false", "description": "Enables animation to be played in reverse.", "name": "reverse", "type": "boolean" } ], "interfaces": [], "name": "FloatFieldInterpolator", "url": "https://developer.roku.com/docs/references/scenegraph/animation-nodes/floatfieldinterpolator.md" }, "font": { "description": "Extends [**Node**](https://developer.roku.com/docs/references/scenegraph/node.md\n\nThe Font node class specifies the font to be used by a Label node, or any other nodes that render text.\n\nNodes that use fonts include a field that stores a Font node. The font to use is specified by creating a Font node, and setting its uri and size fields.\n\nThe uri field can be set to any TrueType/OpenType font file. For example, to specify a font in XML markup:\n\n```\n\n```\n\nA default system font can also be specified, such as in the following:\n\n```\n