brighterscript 0.66.0-alpha.6 → 0.66.0-alpha.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +88 -10
- package/README.md +16 -0
- package/bsconfig.schema.json +15 -0
- package/dist/ActionPipeline.d.ts +10 -0
- package/dist/ActionPipeline.js +40 -0
- package/dist/ActionPipeline.js.map +1 -0
- package/dist/AstValidationSegmenter.d.ts +25 -0
- package/dist/AstValidationSegmenter.js +150 -0
- package/dist/AstValidationSegmenter.js.map +1 -0
- package/dist/BsConfig.d.ts +15 -1
- package/dist/CommentFlagProcessor.d.ts +4 -3
- package/dist/CommentFlagProcessor.js.map +1 -1
- package/dist/DiagnosticMessages.d.ts +8 -1
- package/dist/DiagnosticMessages.js +30 -13
- package/dist/DiagnosticMessages.js.map +1 -1
- package/dist/LanguageServer.js +7 -1
- package/dist/LanguageServer.js.map +1 -1
- package/dist/PluginInterface.d.ts +11 -2
- package/dist/PluginInterface.js +69 -10
- package/dist/PluginInterface.js.map +1 -1
- package/dist/Program.d.ts +107 -38
- package/dist/Program.js +502 -270
- package/dist/Program.js.map +1 -1
- package/dist/ProgramBuilder.d.ts +10 -4
- package/dist/ProgramBuilder.js +44 -54
- package/dist/ProgramBuilder.js.map +1 -1
- package/dist/Scope.d.ts +26 -38
- package/dist/Scope.js +153 -174
- package/dist/Scope.js.map +1 -1
- package/dist/SymbolTable.d.ts +4 -1
- package/dist/SymbolTable.js +19 -7
- package/dist/SymbolTable.js.map +1 -1
- package/dist/XmlScope.d.ts +5 -4
- package/dist/XmlScope.js +16 -14
- package/dist/XmlScope.js.map +1 -1
- package/dist/astUtils/{AstEditor.d.ts → Editor.d.ts} +6 -1
- package/dist/astUtils/{AstEditor.js → Editor.js} +9 -3
- package/dist/astUtils/Editor.js.map +1 -0
- package/dist/astUtils/{AstEditor.spec.js → Editor.spec.js} +10 -6
- package/dist/astUtils/Editor.spec.js.map +1 -0
- package/dist/astUtils/reflection.d.ts +9 -4
- package/dist/astUtils/reflection.js +23 -7
- package/dist/astUtils/reflection.js.map +1 -1
- package/dist/astUtils/reflection.spec.js +2 -2
- package/dist/astUtils/reflection.spec.js.map +1 -1
- package/dist/astUtils/visitors.d.ts +14 -3
- package/dist/astUtils/visitors.js +22 -2
- package/dist/astUtils/visitors.js.map +1 -1
- package/dist/astUtils/visitors.spec.js +58 -7
- package/dist/astUtils/visitors.spec.js.map +1 -1
- package/dist/bscPlugin/BscPlugin.d.ts +10 -2
- package/dist/bscPlugin/BscPlugin.js +24 -4
- package/dist/bscPlugin/BscPlugin.js.map +1 -1
- package/dist/bscPlugin/FileWriter.d.ts +6 -0
- package/dist/bscPlugin/FileWriter.js +24 -0
- package/dist/bscPlugin/FileWriter.js.map +1 -0
- package/dist/bscPlugin/codeActions/CodeActionsProcessor.js +8 -8
- package/dist/bscPlugin/codeActions/CodeActionsProcessor.js.map +1 -1
- package/dist/bscPlugin/codeActions/CodeActionsProcessor.spec.js.map +1 -1
- package/dist/bscPlugin/completions/CompletionsProcessor.d.ts +7 -2
- package/dist/bscPlugin/completions/CompletionsProcessor.js +112 -44
- package/dist/bscPlugin/completions/CompletionsProcessor.js.map +1 -1
- package/dist/bscPlugin/completions/CompletionsProcessor.spec.js +212 -6
- package/dist/bscPlugin/completions/CompletionsProcessor.spec.js.map +1 -1
- package/dist/bscPlugin/fileProviders/FileProvider.d.ts +9 -0
- package/dist/bscPlugin/fileProviders/FileProvider.js +51 -0
- package/dist/bscPlugin/fileProviders/FileProvider.js.map +1 -0
- package/dist/bscPlugin/hover/HoverProcessor.d.ts +1 -7
- package/dist/bscPlugin/hover/HoverProcessor.js +10 -8
- package/dist/bscPlugin/hover/HoverProcessor.js.map +1 -1
- package/dist/bscPlugin/semanticTokens/BrsFileSemanticTokensProcessor.d.ts +1 -0
- package/dist/bscPlugin/semanticTokens/BrsFileSemanticTokensProcessor.js +43 -0
- package/dist/bscPlugin/semanticTokens/BrsFileSemanticTokensProcessor.js.map +1 -1
- package/dist/bscPlugin/semanticTokens/BrsFileSemanticTokensProcessor.spec.js +22 -0
- package/dist/bscPlugin/semanticTokens/BrsFileSemanticTokensProcessor.spec.js.map +1 -1
- package/dist/bscPlugin/serialize/BslibInjector.spec.js +19 -0
- package/dist/bscPlugin/serialize/BslibInjector.spec.js.map +1 -0
- package/dist/bscPlugin/serialize/BslibManager.d.ts +9 -0
- package/dist/bscPlugin/serialize/BslibManager.js +40 -0
- package/dist/bscPlugin/serialize/BslibManager.js.map +1 -0
- package/dist/bscPlugin/serialize/FileSerializer.d.ts +9 -0
- package/dist/bscPlugin/serialize/FileSerializer.js +72 -0
- package/dist/bscPlugin/serialize/FileSerializer.js.map +1 -0
- package/dist/bscPlugin/transpile/{BrsFilePreTranspileProcessor.d.ts → BrsFileTranspileProcessor.d.ts} +4 -2
- package/dist/bscPlugin/transpile/{BrsFilePreTranspileProcessor.js → BrsFileTranspileProcessor.js} +29 -5
- package/dist/bscPlugin/transpile/BrsFileTranspileProcessor.js.map +1 -0
- package/dist/bscPlugin/transpile/BrsFileTranspileProcessor.spec.d.ts +1 -0
- package/dist/bscPlugin/transpile/BrsFileTranspileProcessor.spec.js +41 -0
- package/dist/bscPlugin/transpile/BrsFileTranspileProcessor.spec.js.map +1 -0
- package/dist/bscPlugin/transpile/XmlFilePreTranspileProcessor.d.ts +2 -2
- package/dist/bscPlugin/transpile/XmlFilePreTranspileProcessor.js.map +1 -1
- package/dist/bscPlugin/validation/BrsFileValidator.js +8 -3
- package/dist/bscPlugin/validation/BrsFileValidator.js.map +1 -1
- package/dist/bscPlugin/validation/BrsFileValidator.spec.js +1 -1
- package/dist/bscPlugin/validation/BrsFileValidator.spec.js.map +1 -1
- package/dist/bscPlugin/validation/ScopeValidator.d.ts +5 -9
- package/dist/bscPlugin/validation/ScopeValidator.js +214 -222
- package/dist/bscPlugin/validation/ScopeValidator.js.map +1 -1
- package/dist/bscPlugin/validation/ScopeValidator.spec.js +669 -0
- package/dist/bscPlugin/validation/ScopeValidator.spec.js.map +1 -1
- package/dist/bscPlugin/validation/XmlFileValidator.js +2 -2
- package/dist/bscPlugin/validation/XmlFileValidator.js.map +1 -1
- package/dist/cli.js +1 -0
- package/dist/cli.js.map +1 -1
- package/dist/deferred.d.ts +2 -2
- package/dist/deferred.js.map +1 -1
- package/dist/diagnosticUtils.d.ts +1 -0
- package/dist/diagnosticUtils.js +4 -3
- package/dist/diagnosticUtils.js.map +1 -1
- package/dist/examples/plugins/removePrint.js +1 -1
- package/dist/examples/plugins/removePrint.js.map +1 -1
- package/dist/files/AssetFile.d.ts +26 -0
- package/dist/files/AssetFile.js +26 -0
- package/dist/files/AssetFile.js.map +1 -0
- package/dist/files/BrsFile.Class.spec.js +241 -40
- package/dist/files/BrsFile.Class.spec.js.map +1 -1
- package/dist/files/BrsFile.d.ts +66 -16
- package/dist/files/BrsFile.js +330 -80
- package/dist/files/BrsFile.js.map +1 -1
- package/dist/files/BrsFile.spec.js +1134 -167
- package/dist/files/BrsFile.spec.js.map +1 -1
- package/dist/files/Factory.d.ts +25 -0
- package/dist/files/Factory.js +22 -0
- package/dist/files/Factory.js.map +1 -0
- package/dist/files/File.d.ts +106 -0
- package/dist/files/File.js +16 -0
- package/dist/files/File.js.map +1 -0
- package/dist/files/LazyFileData.d.ts +20 -0
- package/dist/files/LazyFileData.js +54 -0
- package/dist/files/LazyFileData.js.map +1 -0
- package/dist/files/LazyFileData.spec.d.ts +1 -0
- package/dist/files/LazyFileData.spec.js +27 -0
- package/dist/files/LazyFileData.spec.js.map +1 -0
- package/dist/files/XmlFile.d.ts +55 -17
- package/dist/files/XmlFile.js +88 -47
- package/dist/files/XmlFile.js.map +1 -1
- package/dist/files/XmlFile.spec.js +64 -57
- package/dist/files/XmlFile.spec.js.map +1 -1
- package/dist/files/tests/imports.spec.js +21 -8
- package/dist/files/tests/imports.spec.js.map +1 -1
- package/dist/files/tests/optionalChaning.spec.js +14 -14
- package/dist/files/tests/optionalChaning.spec.js.map +1 -1
- package/dist/globalCallables.js +1 -1
- package/dist/globalCallables.js.map +1 -1
- package/dist/index.d.ts +6 -1
- package/dist/index.js +6 -1
- package/dist/index.js.map +1 -1
- package/dist/interfaces.d.ts +357 -89
- package/dist/interfaces.js +10 -2
- package/dist/interfaces.js.map +1 -1
- package/dist/lexer/Lexer.js +1 -1
- package/dist/lexer/TokenKind.d.ts +1 -0
- package/dist/lexer/TokenKind.js +4 -1
- package/dist/lexer/TokenKind.js.map +1 -1
- package/dist/parser/AstNode.d.ts +2 -2
- package/dist/parser/AstNode.js +1 -1
- package/dist/parser/AstNode.js.map +1 -1
- package/dist/parser/BrsTranspileState.d.ts +3 -2
- package/dist/parser/BrsTranspileState.js +3 -2
- package/dist/parser/BrsTranspileState.js.map +1 -1
- package/dist/parser/Expression.d.ts +2 -2
- package/dist/parser/Expression.js +23 -19
- package/dist/parser/Expression.js.map +1 -1
- package/dist/parser/Parser.Class.spec.js +103 -0
- package/dist/parser/Parser.Class.spec.js.map +1 -1
- package/dist/parser/Parser.js +61 -13
- package/dist/parser/Parser.js.map +1 -1
- package/dist/parser/Parser.spec.js +227 -1
- package/dist/parser/Parser.spec.js.map +1 -1
- package/dist/parser/SGParser.d.ts +2 -2
- package/dist/parser/SGParser.js +3 -3
- package/dist/parser/SGParser.js.map +1 -1
- package/dist/parser/SGParser.spec.js +2 -2
- package/dist/parser/SGParser.spec.js.map +1 -1
- package/dist/parser/SGTypes.d.ts +1 -1
- package/dist/parser/Statement.d.ts +12 -5
- package/dist/parser/Statement.js +56 -26
- package/dist/parser/Statement.js.map +1 -1
- package/dist/parser/tests/expression/NullCoalescenceExpression.spec.js +16 -16
- package/dist/parser/tests/expression/NullCoalescenceExpression.spec.js.map +1 -1
- package/dist/parser/tests/expression/RegexLiteralExpression.spec.js +10 -10
- package/dist/parser/tests/expression/RegexLiteralExpression.spec.js.map +1 -1
- package/dist/parser/tests/expression/SourceLiteralExpression.spec.js +24 -24
- package/dist/parser/tests/expression/SourceLiteralExpression.spec.js.map +1 -1
- package/dist/parser/tests/expression/TemplateStringExpression.spec.js +64 -36
- package/dist/parser/tests/expression/TemplateStringExpression.spec.js.map +1 -1
- package/dist/parser/tests/expression/TernaryExpression.spec.js +34 -34
- package/dist/parser/tests/expression/TernaryExpression.spec.js.map +1 -1
- package/dist/parser/tests/expression/UnaryExpression.spec.d.ts +1 -0
- package/dist/parser/tests/expression/UnaryExpression.spec.js +52 -0
- package/dist/parser/tests/expression/UnaryExpression.spec.js.map +1 -0
- package/dist/parser/tests/statement/ConstStatement.spec.js +90 -16
- package/dist/parser/tests/statement/ConstStatement.spec.js.map +1 -1
- package/dist/parser/tests/statement/Continue.spec.js +2 -2
- package/dist/parser/tests/statement/Continue.spec.js.map +1 -1
- package/dist/parser/tests/statement/Enum.spec.js +35 -26
- package/dist/parser/tests/statement/Enum.spec.js.map +1 -1
- package/dist/parser/tests/statement/For.spec.js +6 -6
- package/dist/parser/tests/statement/For.spec.js.map +1 -1
- package/dist/parser/tests/statement/ForEach.spec.js +4 -4
- package/dist/parser/tests/statement/ForEach.spec.js.map +1 -1
- package/dist/parser/tests/statement/InterfaceStatement.spec.js +20 -12
- package/dist/parser/tests/statement/InterfaceStatement.spec.js.map +1 -1
- package/dist/parser/tests/statement/PrintStatement.spec.js +10 -10
- package/dist/parser/tests/statement/PrintStatement.spec.js.map +1 -1
- package/dist/preprocessor/Manifest.d.ts +1 -1
- package/dist/preprocessor/Manifest.js +2 -2
- package/dist/preprocessor/Manifest.js.map +1 -1
- package/dist/roku-types/data.json +98 -193
- package/dist/roku-types/index.d.ts +15 -11
- package/dist/types/ArrayType.d.ts +1 -1
- package/dist/types/ArrayType.js +4 -0
- package/dist/types/ArrayType.js.map +1 -1
- package/dist/types/ArrayType.spec.js +1 -1
- package/dist/types/ArrayType.spec.js.map +1 -1
- package/dist/types/AssociativeArrayType.d.ts +1 -1
- package/dist/types/AssociativeArrayType.js +1 -1
- package/dist/types/AssociativeArrayType.js.map +1 -1
- package/dist/types/BooleanType.d.ts +1 -1
- package/dist/types/BooleanType.js +2 -1
- package/dist/types/BooleanType.js.map +1 -1
- package/dist/types/BscType.d.ts +2 -2
- package/dist/types/BscType.js +30 -9
- package/dist/types/BscType.js.map +1 -1
- package/dist/types/BuiltInInterfaceAdder.d.ts +3 -0
- package/dist/types/BuiltInInterfaceAdder.js +37 -16
- package/dist/types/BuiltInInterfaceAdder.js.map +1 -1
- package/dist/types/BuiltInInterfaceAdder.spec.js +7 -0
- package/dist/types/BuiltInInterfaceAdder.spec.js.map +1 -1
- package/dist/types/ClassType.d.ts +4 -3
- package/dist/types/ClassType.js +6 -3
- package/dist/types/ClassType.js.map +1 -1
- package/dist/types/ClassType.spec.js +5 -3
- package/dist/types/ClassType.spec.js.map +1 -1
- package/dist/types/ComponentType.d.ts +1 -1
- package/dist/types/ComponentType.js +3 -0
- package/dist/types/ComponentType.js.map +1 -1
- package/dist/types/DoubleType.js +3 -1
- package/dist/types/DoubleType.js.map +1 -1
- package/dist/types/EnumType.d.ts +1 -1
- package/dist/types/EnumType.js +7 -2
- package/dist/types/EnumType.js.map +1 -1
- package/dist/types/FloatType.js +3 -1
- package/dist/types/FloatType.js.map +1 -1
- package/dist/types/InheritableType.d.ts +7 -4
- package/dist/types/InheritableType.js +67 -3
- package/dist/types/InheritableType.js.map +1 -1
- package/dist/types/IntegerType.js +3 -1
- package/dist/types/IntegerType.js.map +1 -1
- package/dist/types/InterfaceType.d.ts +5 -4
- package/dist/types/InterfaceType.js +5 -12
- package/dist/types/InterfaceType.js.map +1 -1
- package/dist/types/InterfaceType.spec.js +23 -0
- package/dist/types/InterfaceType.spec.js.map +1 -1
- package/dist/types/LongIntegerType.js +3 -1
- package/dist/types/LongIntegerType.js.map +1 -1
- package/dist/types/NamespaceType.d.ts +2 -1
- package/dist/types/NamespaceType.js +3 -0
- package/dist/types/NamespaceType.js.map +1 -1
- package/dist/types/ObjectType.d.ts +1 -1
- package/dist/types/ReferenceType.js +40 -6
- package/dist/types/ReferenceType.js.map +1 -1
- package/dist/types/StringType.js +2 -2
- package/dist/types/StringType.js.map +1 -1
- package/dist/types/TypedFunctionType.d.ts +6 -1
- package/dist/types/TypedFunctionType.js +46 -16
- package/dist/types/TypedFunctionType.js.map +1 -1
- package/dist/types/TypedFunctionType.spec.js +99 -0
- package/dist/types/TypedFunctionType.spec.js.map +1 -1
- package/dist/types/UnionType.js +8 -0
- package/dist/types/UnionType.js.map +1 -1
- package/dist/types/helper.spec.js +15 -0
- package/dist/types/helper.spec.js.map +1 -1
- package/dist/types/helpers.d.ts +3 -0
- package/dist/types/helpers.js +33 -1
- package/dist/types/helpers.js.map +1 -1
- package/dist/util.d.ts +25 -9
- package/dist/util.js +165 -72
- package/dist/util.js.map +1 -1
- package/dist/validators/ClassValidator.js.map +1 -1
- package/package.json +2 -2
- package/dist/astUtils/AstEditor.js.map +0 -1
- package/dist/astUtils/AstEditor.spec.js.map +0 -1
- package/dist/bscPlugin/transpile/BrsFilePreTranspileProcessor.js.map +0 -1
- package/dist/bscPlugin/transpile/BrsFilePreTranspileProcessor.spec.js +0 -31
- package/dist/bscPlugin/transpile/BrsFilePreTranspileProcessor.spec.js.map +0 -1
- /package/dist/astUtils/{AstEditor.spec.d.ts → Editor.spec.d.ts} +0 -0
- /package/dist/bscPlugin/{transpile/BrsFilePreTranspileProcessor.spec.d.ts → serialize/BslibInjector.spec.d.ts} +0 -0
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generatedDate": "2023-
|
|
2
|
+
"generatedDate": "2023-11-24T19:45:56.208Z",
|
|
3
3
|
"nodes": {
|
|
4
4
|
"animation": {
|
|
5
5
|
"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.",
|
|
@@ -443,7 +443,7 @@
|
|
|
443
443
|
{
|
|
444
444
|
"accessPermission": "READ_ONLY",
|
|
445
445
|
"default": "",
|
|
446
|
-
"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
|
|
446
|
+
"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. |",
|
|
447
447
|
"name": "audioFormat",
|
|
448
448
|
"type": "string"
|
|
449
449
|
},
|
|
@@ -1007,7 +1007,7 @@
|
|
|
1007
1007
|
"url": "https://developer.roku.com/docs/references/scenegraph/animation-nodes/colorfieldinterpolator.md"
|
|
1008
1008
|
},
|
|
1009
1009
|
"componentlibrary": {
|
|
1010
|
-
"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.",
|
|
1010
|
+
"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.",
|
|
1011
1011
|
"events": [],
|
|
1012
1012
|
"extends": {
|
|
1013
1013
|
"name": "Node",
|
|
@@ -1405,7 +1405,7 @@
|
|
|
1405
1405
|
{
|
|
1406
1406
|
"accessPermission": "READ_WRITE",
|
|
1407
1407
|
"default": "not set",
|
|
1408
|
-
"description": "The RSGPalette node 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. |",
|
|
1408
|
+
"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. |",
|
|
1409
1409
|
"name": "palette",
|
|
1410
1410
|
"type": "RSGPalette node"
|
|
1411
1411
|
},
|
|
@@ -2230,7 +2230,7 @@
|
|
|
2230
2230
|
{
|
|
2231
2231
|
"accessPermission": "READ_WRITE",
|
|
2232
2232
|
"default": "top",
|
|
2233
|
-
"description": "Specifies the alignment point in the vertical direction. The effect of the value set depends on the whether the layoutDirection field value is set to either horiz or vert\n\n| Value | layoutDirection | Use |\n| --- | --- | --- |\n| top | horiz | Aligns the top edges of each child in the row, and sets the **LayoutGroup** node local y-coordinate origin at the top edge of the children |\n| top | vert | Sets the LayoutGroup node local y-coordinate origin at the top edge of the first child |\n| center | horiz | Aligns the centers of each child in the row, and sets the LayoutGroup node local y-coordinate origin at the center alignment point |\n|
|
|
2233
|
+
"description": "Specifies the alignment point in the vertical direction. The effect of the value set depends on the whether the layoutDirection field value is set to either horiz or vert\n\n| Value | layoutDirection | Use |\n| --- | --- | --- |\n| top | horiz | Aligns the top edges of each child in the row, and sets the **LayoutGroup** node local y-coordinate origin at the top edge of the children |\n| top | vert | Sets the LayoutGroup node local y-coordinate origin at the top edge of the first child |\n| center | horiz | Aligns the centers of each child in the row, and sets the LayoutGroup node local y-coordinate origin at the center alignment point |\n| center | vert | Sets the **LayoutGroup** node local y-coordinate origin at the center of the vertical column of children |\n| bottom | horiz | Aligns the bottom edges of each child in the row, and sets the **LayoutGroup** node local y-coordinate origin at the bottom edge of the children |\n| bottom | vert | Sets the LayoutGroup node local y-coordinate origin at the bottom edge of the last child |\n| custom | horiz | Explicitly set the y translation of each child of the LayoutGroup. If the layoutDirection is \"vert\", custom will not be a valid setting. Instead, \"top\" will be used to do the child layout. |",
|
|
2234
2234
|
"name": "vertAlignment",
|
|
2235
2235
|
"type": "string"
|
|
2236
2236
|
}
|
|
@@ -2924,6 +2924,23 @@
|
|
|
2924
2924
|
"url": "https://developer.roku.com/docs/references/brightscript/interfaces/ifsgnodehttpagentaccess.md"
|
|
2925
2925
|
}
|
|
2926
2926
|
],
|
|
2927
|
+
"methods": [
|
|
2928
|
+
{
|
|
2929
|
+
"description": "callFunc() is a synchronized interface on roSGNode. It will always execute in the component's owning ScriptEngine and thread (by rendezvous if necessary), and it will always use the m and m.top of the owning component. Any context from the caller can be passed via one or more method parameters, which may be of any type (previously, callFunc() only supported a single associative array parameter).\n\nTo call the function, use the `callFunc` field with the required method signature. A return value, if any, can be an object that is similarly arbitrary. The method being called must determine how to interpret the parameters included in the `callFunc` field.",
|
|
2930
|
+
"isVariadic": true,
|
|
2931
|
+
"name": "callFunc",
|
|
2932
|
+
"params": [
|
|
2933
|
+
{
|
|
2934
|
+
"default": null,
|
|
2935
|
+
"description": "The function name to call.",
|
|
2936
|
+
"isRequired": true,
|
|
2937
|
+
"name": "functionName",
|
|
2938
|
+
"type": "String"
|
|
2939
|
+
}
|
|
2940
|
+
],
|
|
2941
|
+
"returnType": "Dynamic"
|
|
2942
|
+
}
|
|
2943
|
+
],
|
|
2927
2944
|
"name": "Node",
|
|
2928
2945
|
"url": "https://developer.roku.com/docs/references/scenegraph/node.md"
|
|
2929
2946
|
},
|
|
@@ -3236,7 +3253,7 @@
|
|
|
3236
3253
|
{
|
|
3237
3254
|
"accessPermission": "READ_WRITE",
|
|
3238
3255
|
"default": "noScale",
|
|
3239
|
-
"description": "Provides automatic scaling of graphical images after loading. If you intend to load very large graphical images, such as larger than the user interface resolution, you must set one of the scaling options other than noScale, otherwise the image may fail to load. The following are the possible field values:\n\n| Option | Effect |\n| --- | --- |\n| limitSize | Scale the image while loading it into texture memory so that the maximum width and height in either dimension does not exceed the specified loadWidth or loadHeight values. If the image is smaller in both dimensions than the specified values, the image is loaded at its regular size. Aspect ratio is preserved. |\n| noScale | The bitmap will be loaded at the image's original resolution. If the Poster's width and height differ from the bitmap's resolution, it will be scaled to fill the Poster's dimensions. Aspect ratio is not preserved. |\n| scaleToFit | Scale the image to fit into the target screen element area, preserving the aspect ratio but \"letterboxing\" or \"pillarboxing\" the image (background-color bars at the top/bottom or left/right of the image). |\n| scaleToFill | Stretch the image dimensions to fill the target screen element area, distorting the image if the target screen element area has a different aspect ratio than the image. |\n| scaleToZoom | Scale the image to fill the target screen element area, preserving the aspect ratio but not \"letterboxing\" or \"pillarboxing\" the image, with some of the image cropped out. |",
|
|
3256
|
+
"description": "Provides automatic scaling of graphical images after loading. If you intend to load very large graphical images, such as larger than the user interface resolution, you must set one of the scaling options other than noScale, otherwise the image may fail to load. The following are the possible field values:\n\n| Option | Effect |\n| --- | --- |\n| limitSize | Scale the image while loading it into texture memory so that the maximum width and height in either dimension does not exceed the specified loadWidth or loadHeight values. If the image is smaller in both dimensions than the specified values, the image is loaded at its regular size. Aspect ratio is preserved. |\n| noScale | The bitmap will be loaded at the image's original resolution. If the Poster's width and height differ from the bitmap's resolution, it will be scaled to fill the Poster's dimensions. Aspect ratio is not preserved. |\n| scaleToFit | Scale the image to fit into the target screen element area, preserving the aspect ratio but \"letterboxing\" or \"pillarboxing\" the image (background-color bars at the top/bottom or left/right of the image). > This field in not supported on Liberty and Littlefield devices for images that are both scaled and rotated. On these devices, scaled and rotated images appear as if the **scaleToFill** property was applied to them. |\n| scaleToFill | Stretch the image dimensions to fill the target screen element area, distorting the image if the target screen element area has a different aspect ratio than the image. |\n| scaleToZoom | Scale the image to fill the target screen element area, preserving the aspect ratio but not \"letterboxing\" or \"pillarboxing\" the image, with some of the image cropped out. |",
|
|
3240
3257
|
"name": "loadDisplayMode",
|
|
3241
3258
|
"type": "option string"
|
|
3242
3259
|
},
|
|
@@ -4148,7 +4165,7 @@
|
|
|
4148
4165
|
"accessPermission": "READ_WRITE",
|
|
4149
4166
|
"default": "not set",
|
|
4150
4167
|
"description": "Defines the default color palette used by those nodes that have a \\*\\*palette\\*\\* field (for example, the \\*\\*Scene\\*\\* node, \\[standard dialogs\\](https://developer.roku.com/docs/references/scenegraph/standard-dialog-framework-nodes/standard-dialog.md, \\[dynamic custom voice keyboards\\](https://developer.roku.com/docs/references/scenegraph/dynamic-voice-keyboard-nodes/dynamic-keyboard-base.md, and so on). Channels typically set the \\*\\*Scene.palette\\*\\* field to consistently color the standard dialogs and keyboards in the channel. Nodes that include a \\*\\*palette\\*\\* field can be set to an \\*\\*RSGPalette\\*\\* node to override the default colors specified in the \\*\\*Scene\\*\\* node. If a node that supports a palette does not set its \\*\\*palette\\*\\* filed, the node looks up the scene graph until it finds a node with its \\*\\*palette\\*\\* field set. If no ancestor node is found with its palette field set, the default color palette is used (grey with white text). The RSGPalette color values used by the Scene node are as follows:\n\n| Palette Color Name | Usages |\n| --- | --- |\n| PrimaryTextColor | The text color used for the entered text displayed in the VoiceTextEditBox node. |\n| SecondaryTextColor | The text color used for the hints displayed in the VoiceTextEditBox. |\n| InputFieldColor | The blend color applied to the VoiceTextEditBox background |\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. |",
|
|
4151
|
-
"name": "
|
|
4168
|
+
"name": "palette",
|
|
4152
4169
|
"type": "RSGPalette node"
|
|
4153
4170
|
}
|
|
4154
4171
|
],
|
|
@@ -5675,6 +5692,13 @@
|
|
|
5675
5692
|
"url": "https://developer.roku.com/docs/references/scenegraph/layout-group-nodes/group.md"
|
|
5676
5693
|
},
|
|
5677
5694
|
"fields": [
|
|
5695
|
+
{
|
|
5696
|
+
"accessPermission": "WRITE_ONLY",
|
|
5697
|
+
"default": "{ }",
|
|
5698
|
+
"description": "The significance and priority order of the attributes and values for the audio tracks available in the video stream. > A language matching any country code does not match a track that specifies the same language but with no country code. Provide the attribute fields from highest to lowest significance (for example, if the \\*\\*language\\*\\* should take precedence over the \\*\\*description\\*\\*, list \\*\\*language\\*\\* first. For the audio track languages, provide the language code values from highest to lowest priority (for example, if English for the United States \\\\\\[\"en-US\"\\\\\\] has precedence over English for the United Kingdom \\\\\\[\"en-UK\"\\\\\\], list the language codes in the following order: \\\\\\[\"en-US\", \"en-UK\"\\\\\\].\n\n| Field | Type | Description |\n| --- | --- | --- |\n| values | roAssociativeArray | Specify values for the following audio track attributes. List the attributes from highest to lowest significance. <table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>language</td><td>array of Strings</td><td>A list of (ISO-639)/country (ISO-3166) codes for the audio track. List the languages in priority order (highest to lowest).</td></tr><tr><td>descriptive</td><td>array of Strings</td><td>A flag indicating whether descriptives exist for the video playing in the stream. This is equivalent to the HLS \"public.accessibility.describes-video\" characteristic.</td></tr></tbody></table> |\n| overrideSystem | boolean | Specify whether to use the channel's preferences over the system preferences (true) or use the channel's preferences only when the system preferences do not match any of the available tracks (false), which allows the channel to provide additional rules in this case. The default value is false. |\n\n\\*\\*Example\\*\\* \\`\\`\\` video.audioSelectionPreferences = { values: \\[ { language: \\[\"en-US\", \"en-UK\", \"en\", \"en-\\*\"\\] }, { descriptive: \"false\" } \\], overrideSystem: true } \\`\\`\\` \\*\\*Explanation\\*\\* The audio language with the highest priority is \"en-US\". The next highest priority language is \"en-UK\", then \"en\" with no country code, and finally \"en\" with any country code.",
|
|
5699
|
+
"name": "audioSelectionPreferences (_Available since Roku OS 12.5_)",
|
|
5700
|
+
"type": "roAssociativeArray"
|
|
5701
|
+
},
|
|
5678
5702
|
{
|
|
5679
5703
|
"accessPermission": "READ_WRITE",
|
|
5680
5704
|
"default": "NULL",
|
|
@@ -5790,7 +5814,7 @@
|
|
|
5790
5814
|
{
|
|
5791
5815
|
"accessPermission": "READ_WRITE",
|
|
5792
5816
|
"default": "[]",
|
|
5793
|
-
"description": "Component that shows the buttons and other specified UI elements on the pause screen at the start of playback. Each element in the array has following fields:\n\n| Field | Type | Default | Description |\n| --- | --- | --- | --- |\n| text | string | system default | Text for the button label |\n| icon | uri | \"\" | A 9-patch or PNG of the icon to be displayed when the button does not have. |\n| focusIcon | uri | \"\" | A 9-patch or PNG of the icon to be displayed when the button has focus. |\n| buttonIsDisabled | Boolean | false | Controls whether the button is disabled (true) or enabled (false). A disabled button is skipped and does not have focus while the user navigates the different playback action buttons with the directional pad on the Roku remote control.
|
|
5817
|
+
"description": "Component that shows the buttons and other specified UI elements on the pause screen at the start of playback. Each element in the array has following fields:\n\n| Field | Type | Default | Description |\n| --- | --- | --- | --- |\n| text | string | system default | Text for the button label |\n| icon | uri | \"\" | A 9-patch or PNG of the icon to be displayed when the button does not have. |\n| focusIcon | uri | \"\" | A 9-patch or PNG of the icon to be displayed when the button has focus. |\n| buttonIsDisabled | Boolean | false | Controls whether the button is disabled (true) or enabled (false). A disabled button is skipped and does not have focus while the user navigates the different playback action buttons with the directional pad on the Roku remote control. |",
|
|
5794
5818
|
"name": "playbackActionButtons (_Available since Roku OS 11.5_)",
|
|
5795
5819
|
"type": "roArray of roAssociativeArrays"
|
|
5796
5820
|
},
|
|
@@ -5828,6 +5852,13 @@
|
|
|
5828
5852
|
"description": "Describes the current video play state, such as if the video play has been paused.\n\n| Value | Meaning |\n| --- | --- |\n| none | No current play state |\n| buffering | Video stream is currently buffering |\n| playing | Video is currently playing |\n| paused | Video is currently paused |\n| stopped | Video is currently stopped |\n| finished | Video has successfully completed playback |\n| error | An error has occurred in the video play. The error code, message, and diagnostics can be found in the `errorCode`, `errorMsg`, and `errorStr` fields respectively. |",
|
|
5829
5853
|
"name": "state",
|
|
5830
5854
|
"type": "value string"
|
|
5855
|
+
},
|
|
5856
|
+
{
|
|
5857
|
+
"accessPermission": "WRITE_ONLY",
|
|
5858
|
+
"default": "{ }",
|
|
5859
|
+
"description": "The significance and priority order of the attributes and values for the subtitle tracks available in the video stream. Provide the attribute fields from highest to lowest significance (for example, if \\*\\*language\\*\\* should take precedence over all other attributes, list it first). For the subtitle track languages, provide the language codes from highest to lowest priority (for example, if Spanish for Latin America and the Caribbean \\\\\\[\"es-419\"\\\\\\] has precedence over Spanish \\\\\\[\"es\"\\\\\\], list the language codes in the following order: \\\\\\[\"es-419\", \"es\"\\\\\\].\n\n| Field | Type | Description |\n| --- | --- | --- |\n| values | roAssociativeArray | Specify values for the following subtitle track attributes. List the attributes from highest to lowest significance. <table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>language</td><td>array of Strings</td><td>A list of language (ISO-639)/country (ISO-3166) codes for the subtitles. List the language codes in priority order (highest to lowest).</td></tr><tr><td>caption</td><td>array of Strings</td><td>A flag indicating whether captions exist for the video stream. This is equivalent to the HLS \"public.accessibility.transcribes-spoken-dialog\" characteristic.</td></tr><tr><td>descriptive</td><td>array of Strings</td><td>A flag indicating whether descriptives exist for the music and sounds in the video stream. This is equivalent to the HLS \"public.accessibility.describes-music-and-sound\" characteristic.</td></tr><tr><td>easyReader</td><td>array of Strings</td><td>A flag indicating whether subtitles are easy to read.</td></tr></tbody></table> |\n| overrideSystem | boolean | Specify whether to use the channel's preferences over the system preferences (true) or use the channel's preferences only when the system preferences do not match any of the available tracks (false), which allows the channel to provide additional rules in this case. The default value is false. |\n\n\\*\\*Example\\*\\* \\`\\`\\` video.subtitleSelectionPreferences = { values: \\[ { language: \\[\"es-419\", \"es\", \"es-\\*\", \"fr\", \"en-US\", \"en-UK\", \"en\"\\] }, { caption: \"true\" }, { descriptive: \\[\"false\"\\] }, { easyReader: \"true\" } \\], overrideSystem: true } \\`\\`\\` \\*\\*Explanation\\*\\* The subititle language with the highest priority is \"es\" with a country code of \"419\". The next highest priority language is \"es\" with no country code, and then \"es\" with any country code.",
|
|
5860
|
+
"name": "subtitleSelectionPreferences (_Available since Roku OS 12.5_)",
|
|
5861
|
+
"type": "roAssociativeArray"
|
|
5831
5862
|
}
|
|
5832
5863
|
],
|
|
5833
5864
|
"interfaces": [],
|
|
@@ -5927,7 +5958,7 @@
|
|
|
5927
5958
|
"roappmemorymonitor": {
|
|
5928
5959
|
"availableSince": "10.5",
|
|
5929
5960
|
"constructors": [],
|
|
5930
|
-
"description": "_Available since Roku OS 10.5_\n\nThe **roAppMemoryMonitor** component is used to subscribe channels to low-memory notifications. When a channel is subscribed, it receives a [roAppMemoryMonitorEvent](https://developer.roku.com/docs/references/brightscript/events/roappmemorymonitorevent.md when it reaches a specific percentage of the per-channel memory limit (80%).\n\n>
|
|
5961
|
+
"description": "_Available since Roku OS 10.5_\n\nThe **roAppMemoryMonitor** component is used to subscribe channels to low-memory notifications. When a channel is subscribed, it receives a [roAppMemoryMonitorEvent](https://developer.roku.com/docs/references/brightscript/events/roappmemorymonitorevent.md when it reaches a specific percentage of the per-channel memory limit (80%).\n\n> The roAppMemoryMonitor functions are supported on all [current and updatable device models](/docs/specs/hardware.md), except for Liberty, Austin, Mustang and Littlefield.",
|
|
5931
5962
|
"events": [
|
|
5932
5963
|
{
|
|
5933
5964
|
"name": "roAppMemoryMonitorEvent",
|
|
@@ -6919,6 +6950,10 @@
|
|
|
6919
6950
|
"description": "The roRegion component is used to represent a subsection of a bitmap.\n\nThe region is specified with an x,y, width, and height as well as a time field for use with animated sprites and a wrap field which causes the region to wrap during scrolling. The roRegion is a common parameter used by the drawing functions of [roBitmap](https://developer.roku.com/docs/references/brightscript/components/robitmap.md\"roBitmap\"). Wrap and Time are used by [roCompositor](https://developer.roku.com/docs/references/brightscript/components/roCompositor.md\"roCompositor\"). roRegion is also used to specify a pretranslation (x,y) for the draw, rotate, and scale operation. The pretranslation is normally used to specify the center of the region. The scaling operation is controlled by the scalemode specified in the region.\n\nThis object is created with parameters to initialize the x,y coordinates, width, height. If time and wrap are desired, use the SetTime() and SetWrap().\n\n`CreateObject(\"roRegion\", Object bitmap, Integer x, Integer y, Integer width, Integer height)`",
|
|
6920
6951
|
"events": [],
|
|
6921
6952
|
"interfaces": [
|
|
6953
|
+
{
|
|
6954
|
+
"name": "ifDraw2D",
|
|
6955
|
+
"url": "https://developer.roku.com/docs/references/brightscript/interfaces/ifdraw2d.md"
|
|
6956
|
+
},
|
|
6922
6957
|
{
|
|
6923
6958
|
"name": "ifRegion",
|
|
6924
6959
|
"url": "https://developer.roku.com/docs/references/brightscript/interfaces/ifregion.md"
|
|
@@ -6934,7 +6969,7 @@
|
|
|
6934
6969
|
"returnType": "roRegistry"
|
|
6935
6970
|
}
|
|
6936
6971
|
],
|
|
6937
|
-
"description": "The Registry is an area of non-volatile storage where a small number of persistent settings can be stored.\n\nThe Registry provides a means for an application to write and read small amounts of data such as settings, scores, etc. The data persists even if the user exits the application and even if the player is rebooted. Registry data is removed only when the application explicitly removes it, the user uninstalls the application, which remove the registry for the application, or the user performs a factory reset, which removes the registry for all applications.\n\nAccess to the registry is available through the roRegistry object. This object is created with no parameters:\n\n`CreateObject(\"roRegistry\")`\n\nThere is a separate registry for each [developer ID](/docs/developer-program/publishing/packaging-channels.md#step-3-run-the-genkey-utility-to-create-a-signing-key \"developer ID\"). This allows multiple applications to use the registry without being able to read or modify the registry from other applications. If desired, a single registry can be shared across multiple applications by using the same developer ID to package the applications. This is the conventional way that an \"application suite\" with shared preferences and other shared information should work. Each registry is divided into sections which are specified by the developer for organization and grouping of attributes. Methods in ifRegistry are provided to list the sections in the registry and to provide access to the data in each section.\n\n> The maximum size of each zlib-compressed application registry is **
|
|
6972
|
+
"description": "The Registry is an area of non-volatile storage where a small number of persistent settings can be stored.\n\nThe Registry provides a means for an application to write and read small amounts of data such as settings, scores, etc. The data persists even if the user exits the application and even if the player is rebooted. Registry data is removed only when the application explicitly removes it, the user uninstalls the application, which remove the registry for the application, or the user performs a factory reset, which removes the registry for all applications.\n\nAccess to the registry is available through the roRegistry object. This object is created with no parameters:\n\n`CreateObject(\"roRegistry\")`\n\nThere is a separate registry for each [developer ID](/docs/developer-program/publishing/packaging-channels.md#step-3-run-the-genkey-utility-to-create-a-signing-key \"developer ID\"). This allows multiple applications to use the registry without being able to read or modify the registry from other applications. If desired, a single registry can be shared across multiple applications by using the same developer ID to package the applications. This is the conventional way that an \"application suite\" with shared preferences and other shared information should work. Each registry is divided into sections which are specified by the developer for organization and grouping of attributes. Methods in ifRegistry are provided to list the sections in the registry and to provide access to the data in each section.\n\n> The maximum size of each zlib-compressed application registry is **32K bytes**. Channels should minimize the amount of data stored in the registry and the frequency in which they update it.\n> \n> Use the **ifRegistry.GetSpaceAvailable()** function to check the number of bytes available in the registry.\n\nThe Registry also supports the use of a special transient registry section. A registry section named \"Transient\" can be used to store attributes that have the lifetime of a single boot. Within a specific boot session, these values will be persistent to the application and stored as any other registry value. Whenever the user reboots the Roku Streaming Player, all \"Transient\" registry sections are removed and the values no longer persist. This technique is useful for caching data to minimize network access, yet still ensuring that this data is always fresh after a system reboot.\n\nThe registry is encrypted, and updates are relatively performance intensive and should be used sparingly. Note that all writes to the registry are delayed, and not committed to non-volatile storage until ifRegistry.Flush() or ifRegistrySection.Flush() is explicitly called. The platform may choose opportune times to flush data on its own, but no application is technically correct unless it explicitly calls Flush() at appropriate times. Flushing the registry is a relatively time-consuming operation, so it should be done as infrequently as possible. The Registry data is stored in a fault tolerant manner by preserving a backup for each write which is automatically rolled-back in the event of a failure.",
|
|
6938
6973
|
"events": [],
|
|
6939
6974
|
"interfaces": [
|
|
6940
6975
|
{
|
|
@@ -7715,6 +7750,13 @@
|
|
|
7715
7750
|
"returnDescription": "A flag indicating whether memory alerts have been enabled.",
|
|
7716
7751
|
"returnType": "Boolean"
|
|
7717
7752
|
},
|
|
7753
|
+
{
|
|
7754
|
+
"description": "Returns the estimated kilobytes (Kb) of memory available for the channel. This can be used to determine when to release memory when a channel receives low-memory warnings.",
|
|
7755
|
+
"name": "GetChannelAvailableMemory",
|
|
7756
|
+
"params": [],
|
|
7757
|
+
"returnDescription": "An integer indicating the estimated available memory remaining for the channel or the available memory for the device, whichever is lower.",
|
|
7758
|
+
"returnType": "dynamic"
|
|
7759
|
+
},
|
|
7718
7760
|
{
|
|
7719
7761
|
"description": "Returns the usage percentage of memory limit for the channel.",
|
|
7720
7762
|
"name": "GetMemoryLimitPercent",
|
|
@@ -8924,6 +8966,12 @@
|
|
|
8924
8966
|
],
|
|
8925
8967
|
"returnType": "Void"
|
|
8926
8968
|
},
|
|
8969
|
+
{
|
|
8970
|
+
"description": "The **getAllPurchases** function is similar to the [**getPurchases** function](#getpurchases-as-void) except that it requests the historical list of all canceled, expired, and terminated subscriptions over the lifetime of the current user account—in addition to the active subscriptions. You can use this method to leverage purchase history in order to implement subscription renewal flows and more easily determine if subscriptions have expired.",
|
|
8971
|
+
"name": "GetAllPurchases",
|
|
8972
|
+
"params": [],
|
|
8973
|
+
"returnType": "Void"
|
|
8974
|
+
},
|
|
8927
8975
|
{
|
|
8928
8976
|
"description": "Requests the list of In-Channel products that are linked to the running channel.",
|
|
8929
8977
|
"name": "GetCatalog",
|
|
@@ -9510,7 +9558,7 @@
|
|
|
9510
9558
|
"params": [
|
|
9511
9559
|
{
|
|
9512
9560
|
"default": null,
|
|
9513
|
-
"description": "An associative array with the audio format to be checked. The general format of the associative arrays for CanDecodeAudio() is similar to the parameter and return associative arrays used in [CanDecodeVideo()](https://developer.roku.com/docs/references/brightscript/interfaces/ifdeviceinfo.mdcandecodevideovideo_format-as-object-as-object): \n| Key | Type | Value | Requirement |\n| ---------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| Codec | string | Specifies the audio codec: “aac”, “ac3”, “eac3”, \"alac\", \"flac\", “mp2”, “mp3”, “vorbis”, “wma” (
|
|
9561
|
+
"description": "An associative array with the audio format to be checked. The general format of the associative arrays for CanDecodeAudio() is similar to the parameter and return associative arrays used in [CanDecodeVideo()](https://developer.roku.com/docs/references/brightscript/interfaces/ifdeviceinfo.mdcandecodevideovideo_format-as-object-as-object): \n| Key | Type | Value | Requirement |\n| ---------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| Codec | string | Specifies the audio codec: “aac”, “ac3”, “eac3”, \"alac\", \"flac\", “mp2”, “mp3”, “vorbis”, “wma” (sunset as of Roku OS 12.5), “wma pro” (sunset as of Roku OS 12.5), “dts”, \"ac4\" | Required |\n| Profile | string | Specifies the codec profile:CodecProfile\"h.265/h.265\"\"main\", \"high\", \"main 10\"\"vp9\"\"profile 0\", \"profile 2\"\"AAC codec profiles\"\"mp2 lc\", \"mp4 he\" | Optional |\n| Level | String | Specifies the codec level:CodecLevel\"h.265/h.265\"4.1, 4.2, 5.0, 5.1\"vp9\"3.0, 3.1, 4.0, 4.1, 5.0, 5.1 | Optional |\n| ChCnt | integer | Specifies the required number of audio channels | Optional |\n| PassThru | integer | Specifies whether the bitstream needs to be decoded on the device. By default, this reports the codec properties of both the Roku device and the attached HDMI device.You can filter the values returned by including one of the following options:**0** \\- Reports only codecs that are supported on the Roku device itself.**1** \\- Reports only codecs of the attached HDMI device (for example, an audio receiver). | Optional |\n| Atmos | Integer | Specifies whether atmos is required. Include 'atmos=1' if it is. | Optional |\n| SampleRate | integer | Specifies the sample rate | Optional |\n| BitRate | integer | Specifies the bit rate in Kbit/sec | Optional |\n| Container | string | Specifies the container format | Optional |\n",
|
|
9514
9562
|
"isRequired": true,
|
|
9515
9563
|
"name": "audio_format",
|
|
9516
9564
|
"type": "Object"
|
|
@@ -9886,10 +9934,10 @@
|
|
|
9886
9934
|
"returnType": "Object"
|
|
9887
9935
|
},
|
|
9888
9936
|
{
|
|
9889
|
-
"description": "Checks the
|
|
9937
|
+
"description": "Checks the two-letter ISO 639-1 language terminology code of the preferred caption language set on the Roku device.",
|
|
9890
9938
|
"name": "GetPreferredCaptionLanguage",
|
|
9891
9939
|
"params": [],
|
|
9892
|
-
"returnDescription": "The
|
|
9940
|
+
"returnDescription": "The two-letter ISO 639-1 language terminology code, which may be one of the following values:",
|
|
9893
9941
|
"returnType": "String"
|
|
9894
9942
|
},
|
|
9895
9943
|
{
|
|
@@ -10302,50 +10350,7 @@
|
|
|
10302
10350
|
"returnType": "Boolean"
|
|
10303
10351
|
},
|
|
10304
10352
|
{
|
|
10305
|
-
"description": "
|
|
10306
|
-
"name": "DrawScaledObject",
|
|
10307
|
-
"params": [
|
|
10308
|
-
{
|
|
10309
|
-
"default": null,
|
|
10310
|
-
"description": "The x-coordinate of the source object.",
|
|
10311
|
-
"isRequired": true,
|
|
10312
|
-
"name": "x",
|
|
10313
|
-
"type": "Integer"
|
|
10314
|
-
},
|
|
10315
|
-
{
|
|
10316
|
-
"default": null,
|
|
10317
|
-
"description": "The y-coordinate of the source object.",
|
|
10318
|
-
"isRequired": true,
|
|
10319
|
-
"name": "y",
|
|
10320
|
-
"type": "Integer"
|
|
10321
|
-
},
|
|
10322
|
-
{
|
|
10323
|
-
"default": null,
|
|
10324
|
-
"description": "The x direction in which the source object is to be scaled.",
|
|
10325
|
-
"isRequired": true,
|
|
10326
|
-
"name": "scaleX",
|
|
10327
|
-
"type": "Float"
|
|
10328
|
-
},
|
|
10329
|
-
{
|
|
10330
|
-
"default": null,
|
|
10331
|
-
"description": "The y direction in which the source object is to be scaled.",
|
|
10332
|
-
"isRequired": true,
|
|
10333
|
-
"name": "scaleY",
|
|
10334
|
-
"type": "Float"
|
|
10335
|
-
},
|
|
10336
|
-
{
|
|
10337
|
-
"default": null,
|
|
10338
|
-
"description": "The [roBitmap](https://developer.roku.com/docs/references/brightscript/components/robitmap.md\"roBitmap\") or an [roRegion](https://developer.roku.com/docs/references/brightscript/components/roregion.md\"roRegion\") object to be drawn.",
|
|
10339
|
-
"isRequired": true,
|
|
10340
|
-
"name": "src",
|
|
10341
|
-
"type": "Object"
|
|
10342
|
-
}
|
|
10343
|
-
],
|
|
10344
|
-
"returnDescription": "A flag indicating whether the object was successfully drawn.",
|
|
10345
|
-
"returnType": "Boolean"
|
|
10346
|
-
},
|
|
10347
|
-
{
|
|
10348
|
-
"description": "Draws the source object, where src is an [roBitmap](https://developer.roku.com/docs/references/brightscript/components/robitmap.md\"roBitmap\") or an [roRegion](https://developer.roku.com/docs/references/brightscript/components/roregion.md\"roRegion\") object, at position x,y, scaled in the x direction by scaleX and in the y direction by scaleY. scaleX and scaleY should each be greater than zero and less than one to reduce the object size, or greater than one to increase the object size.",
|
|
10353
|
+
"description": "**OVERLOADED METHOD**\n\nDraws the source object, where src is an [roBitmap](https://developer.roku.com/docs/references/brightscript/components/robitmap.md\"roBitmap\") or an [roRegion](https://developer.roku.com/docs/references/brightscript/components/roregion.md\"roRegion\") object, at position x,y, scaled in the x direction by scaleX and in the y direction by scaleY. scaleX and scaleY should each be greater than zero and less than one to reduce the object size, or greater than one to increase the object size\n\n or \n\nDraws the source object, where src is an [roBitmap](https://developer.roku.com/docs/references/brightscript/components/robitmap.md\"roBitmap\") or an [roRegion](https://developer.roku.com/docs/references/brightscript/components/roregion.md\"roRegion\") object, at position x,y, scaled in the x direction by scaleX and in the y direction by scaleY. scaleX and scaleY should each be greater than zero and less than one to reduce the object size, or greater than one to increase the object size.",
|
|
10349
10354
|
"name": "DrawScaledObject",
|
|
10350
10355
|
"params": [
|
|
10351
10356
|
{
|
|
@@ -10386,7 +10391,7 @@
|
|
|
10386
10391
|
{
|
|
10387
10392
|
"default": null,
|
|
10388
10393
|
"description": "The RGBA color of the source object.",
|
|
10389
|
-
"isRequired":
|
|
10394
|
+
"isRequired": false,
|
|
10390
10395
|
"name": "rgba",
|
|
10391
10396
|
"type": "Integer"
|
|
10392
10397
|
}
|
|
@@ -13868,7 +13873,7 @@
|
|
|
13868
13873
|
"returnType": "Boolean"
|
|
13869
13874
|
},
|
|
13870
13875
|
{
|
|
13871
|
-
"description": "
|
|
13876
|
+
"description": "**OVERLOADED METHOD**\n\nCalls a function when a field of the subject node changes. The function called must be in the scope of the current component.\n\n or \n\nThis overloaded form sends an [roSGNodeEvent](https://developer.roku.com/docs/references/brightscript/components/rosgnode.md\"roSGNodeEvent\") message to the [roMessagePort](https://developer.roku.com/docs/references/brightscript/components/romessageport.md\"roMessagePort\") identified by port when the subject node field identified by fieldName changes value.",
|
|
13872
13877
|
"name": "observeField",
|
|
13873
13878
|
"params": [
|
|
13874
13879
|
{
|
|
@@ -13880,10 +13885,10 @@
|
|
|
13880
13885
|
},
|
|
13881
13886
|
{
|
|
13882
13887
|
"default": null,
|
|
13883
|
-
"description": "The name of the method to be executed when the value of the field changes.",
|
|
13888
|
+
"description": "The name of the method to be executed when the value of the field changes. OR The [roMessagePort](https://developer.roku.com/docs/references/brightscript/components/romessageport.md\"roMessagePort\") to receive a [roSGNodeEvent](https://developer.roku.com/docs/references/brightscript/components/rosgnode.md\"roSGNodeEvent\") message when the value of the field changes.",
|
|
13884
13889
|
"isRequired": true,
|
|
13885
|
-
"name": "
|
|
13886
|
-
"type": "String"
|
|
13890
|
+
"name": "functionNameOrPort",
|
|
13891
|
+
"type": "String or Object"
|
|
13887
13892
|
},
|
|
13888
13893
|
{
|
|
13889
13894
|
"default": null,
|
|
@@ -13897,36 +13902,7 @@
|
|
|
13897
13902
|
"returnType": "Boolean"
|
|
13898
13903
|
},
|
|
13899
13904
|
{
|
|
13900
|
-
"description": "
|
|
13901
|
-
"name": "observeField",
|
|
13902
|
-
"params": [
|
|
13903
|
-
{
|
|
13904
|
-
"default": null,
|
|
13905
|
-
"description": "The name of the field to be monitored.",
|
|
13906
|
-
"isRequired": true,
|
|
13907
|
-
"name": "fieldName",
|
|
13908
|
-
"type": "String"
|
|
13909
|
-
},
|
|
13910
|
-
{
|
|
13911
|
-
"default": null,
|
|
13912
|
-
"description": "The [roMessagePort](https://developer.roku.com/docs/references/brightscript/components/romessageport.md\"roMessagePort\") to receive a [roSGNodeEvent](https://developer.roku.com/docs/references/brightscript/components/rosgnode.md\"roSGNodeEvent\") message when the value of the field changes.",
|
|
13913
|
-
"isRequired": true,
|
|
13914
|
-
"name": "port",
|
|
13915
|
-
"type": "Object"
|
|
13916
|
-
},
|
|
13917
|
-
{
|
|
13918
|
-
"default": null,
|
|
13919
|
-
"description": "Optional. Names of \"context\" field values to be reported via getInfo() when the monitored field changes.",
|
|
13920
|
-
"isRequired": false,
|
|
13921
|
-
"name": "infoFields",
|
|
13922
|
-
"type": "Object"
|
|
13923
|
-
}
|
|
13924
|
-
],
|
|
13925
|
-
"returnDescription": "A flag indicating whether this operation was successful.",
|
|
13926
|
-
"returnType": "Boolean"
|
|
13927
|
-
},
|
|
13928
|
-
{
|
|
13929
|
-
"description": "Sets up a connection between the observed node's field and the current component from which this call is made. This method is similar to the [observeField()](https://developer.roku.com/docs/references/brightscript/interfaces/ifsgnodefield.mdobservefieldfieldname-as-string-functionname-as-string-as-boolean \"observeField(fieldName as String, functionName as String)\") method.",
|
|
13905
|
+
"description": "**OVERLOADED METHOD**\n\nSets up a connection between the observed node's field and the current component from which this call is made. This method is similar to the [observeField()](https://developer.roku.com/docs/references/brightscript/interfaces/ifsgnodefield.mdobservefieldfieldname-as-string-functionname-as-string-as-boolean \"observeField(fieldName as String, functionName as String)\") method.",
|
|
13930
13906
|
"name": "observeFieldScoped",
|
|
13931
13907
|
"params": [
|
|
13932
13908
|
{
|
|
@@ -13938,39 +13914,10 @@
|
|
|
13938
13914
|
},
|
|
13939
13915
|
{
|
|
13940
13916
|
"default": null,
|
|
13941
|
-
"description": "The name of the method to be executed when the value of the field changes.",
|
|
13917
|
+
"description": "The name of the method to be executed when the value of the field changes. OR The [roMessagePort](https://developer.roku.com/docs/references/brightscript/components/romessageport.md\"roMessagePort\") to receive a [roSGNodeEvent](https://developer.roku.com/docs/references/brightscript/components/rosgnode.md\"roSGNodeEvent\") message when the value of the field changes.",
|
|
13942
13918
|
"isRequired": true,
|
|
13943
|
-
"name": "
|
|
13944
|
-
"type": "String"
|
|
13945
|
-
},
|
|
13946
|
-
{
|
|
13947
|
-
"default": null,
|
|
13948
|
-
"description": "Optional. Names of \"context\" field values to be reported via getInfo() when the monitored field changes.",
|
|
13949
|
-
"isRequired": false,
|
|
13950
|
-
"name": "infoFields",
|
|
13951
|
-
"type": "Object"
|
|
13952
|
-
}
|
|
13953
|
-
],
|
|
13954
|
-
"returnDescription": "A flag indicating whether this operation was successful.",
|
|
13955
|
-
"returnType": "Boolean"
|
|
13956
|
-
},
|
|
13957
|
-
{
|
|
13958
|
-
"description": "Sets up a connection between the observed node's field and the current component from which this call is made. This method is similar to the [observeField()](https://developer.roku.com/docs/references/brightscript/interfaces/ifsgnodefield.mdobservefieldfieldname-as-string-functionname-as-string-as-boolean \"observeField(fieldName as String, functionName as String)\") method.",
|
|
13959
|
-
"name": "observeFieldScoped",
|
|
13960
|
-
"params": [
|
|
13961
|
-
{
|
|
13962
|
-
"default": null,
|
|
13963
|
-
"description": "The name of the field to be monitored.",
|
|
13964
|
-
"isRequired": true,
|
|
13965
|
-
"name": "fieldName",
|
|
13966
|
-
"type": "String"
|
|
13967
|
-
},
|
|
13968
|
-
{
|
|
13969
|
-
"default": null,
|
|
13970
|
-
"description": "The [roMessagePort](https://developer.roku.com/docs/references/brightscript/components/romessageport.md\"roMessagePort\") to receive a [roSGNodeEvent](https://developer.roku.com/docs/references/brightscript/components/rosgnode.md\"roSGNodeEvent\") message when the value of the field changes.",
|
|
13971
|
-
"isRequired": true,
|
|
13972
|
-
"name": "port",
|
|
13973
|
-
"type": "Object"
|
|
13919
|
+
"name": "functionNameOrPort",
|
|
13920
|
+
"type": "String or Object"
|
|
13974
13921
|
},
|
|
13975
13922
|
{
|
|
13976
13923
|
"default": null,
|
|
@@ -15597,30 +15544,20 @@
|
|
|
15597
15544
|
"returnType": "String"
|
|
15598
15545
|
},
|
|
15599
15546
|
{
|
|
15547
|
+
"description": "**OVERLOADED METHOD**\n\n",
|
|
15600
15548
|
"name": "EndsWith",
|
|
15601
15549
|
"params": [
|
|
15602
15550
|
{
|
|
15603
15551
|
"default": null,
|
|
15604
|
-
"
|
|
15605
|
-
"name": "matchString",
|
|
15606
|
-
"type": "String"
|
|
15607
|
-
}
|
|
15608
|
-
],
|
|
15609
|
-
"returnDescription": "A flag indicating whether a matching substring was found.",
|
|
15610
|
-
"returnType": "Boolean"
|
|
15611
|
-
},
|
|
15612
|
-
{
|
|
15613
|
-
"name": "EndsWith",
|
|
15614
|
-
"params": [
|
|
15615
|
-
{
|
|
15616
|
-
"default": null,
|
|
15552
|
+
"description": "",
|
|
15617
15553
|
"isRequired": true,
|
|
15618
15554
|
"name": "matchString",
|
|
15619
15555
|
"type": "String"
|
|
15620
15556
|
},
|
|
15621
15557
|
{
|
|
15622
15558
|
"default": null,
|
|
15623
|
-
"
|
|
15559
|
+
"description": "",
|
|
15560
|
+
"isRequired": false,
|
|
15624
15561
|
"name": "length",
|
|
15625
15562
|
"type": "Integer"
|
|
15626
15563
|
}
|
|
@@ -15643,40 +15580,25 @@
|
|
|
15643
15580
|
"returnType": "String"
|
|
15644
15581
|
},
|
|
15645
15582
|
{
|
|
15646
|
-
"description": "
|
|
15583
|
+
"description": "**OVERLOADED METHOD**\n\nReturns the zero-based index of the first occurrence of substring in the string. If the substring does not occur in the string, this method returns -1\n\n or \n\nReturns the zero-based index of the first occurrence of substring in the string, starting at the specified zero-based start\\_index. If the substring does not occur in the string after start\\_index, returns -1",
|
|
15647
15584
|
"name": "Instr",
|
|
15648
15585
|
"params": [
|
|
15649
15586
|
{
|
|
15650
15587
|
"default": null,
|
|
15651
|
-
"description": "The substring within the roString object to be returned.",
|
|
15588
|
+
"description": "The substring within the roString object to be returned. OR The position in the roString object from which to start looking for and returning the **substring**.",
|
|
15652
15589
|
"isRequired": true,
|
|
15653
|
-
"name": "
|
|
15654
|
-
"type": "String"
|
|
15655
|
-
}
|
|
15656
|
-
],
|
|
15657
|
-
"returnDescription": "The index of the first instance of the substring within the string.",
|
|
15658
|
-
"returnType": "Integer"
|
|
15659
|
-
},
|
|
15660
|
-
{
|
|
15661
|
-
"description": "Returns the zero-based index of the first occurrence of substring in the string, starting at the specified zero-based start\\_index. If the substring does not occur in the string after start\\_index, returns -1",
|
|
15662
|
-
"name": "Instr",
|
|
15663
|
-
"params": [
|
|
15664
|
-
{
|
|
15665
|
-
"default": null,
|
|
15666
|
-
"description": "The position in the roString object from which to start looking for and returning the **substring**.",
|
|
15667
|
-
"isRequired": true,
|
|
15668
|
-
"name": "start_index",
|
|
15669
|
-
"type": "Integer"
|
|
15590
|
+
"name": "substringOrStart_index",
|
|
15591
|
+
"type": "String or Integer"
|
|
15670
15592
|
},
|
|
15671
15593
|
{
|
|
15672
15594
|
"default": null,
|
|
15673
15595
|
"description": "The substring within the roString object to be found.",
|
|
15674
|
-
"isRequired":
|
|
15596
|
+
"isRequired": false,
|
|
15675
15597
|
"name": "substring",
|
|
15676
15598
|
"type": "String"
|
|
15677
15599
|
}
|
|
15678
15600
|
],
|
|
15679
|
-
"returnDescription": "The index of the first instance of the substring within the string, based on the specified starting position.",
|
|
15601
|
+
"returnDescription": "The index of the first instance of the substring within the string.\n\n or \n\nThe index of the first instance of the substring within the string, based on the specified starting position.",
|
|
15680
15602
|
"returnType": "Integer"
|
|
15681
15603
|
},
|
|
15682
15604
|
{
|
|
@@ -15702,27 +15624,12 @@
|
|
|
15702
15624
|
"returnType": "Integer"
|
|
15703
15625
|
},
|
|
15704
15626
|
{
|
|
15705
|
-
"description": "
|
|
15706
|
-
"name": "Mid",
|
|
15707
|
-
"params": [
|
|
15708
|
-
{
|
|
15709
|
-
"default": null,
|
|
15710
|
-
"description": "The position in the roString object from which to return the remaining characters.",
|
|
15711
|
-
"isRequired": true,
|
|
15712
|
-
"name": "start_index",
|
|
15713
|
-
"type": "Integer"
|
|
15714
|
-
}
|
|
15715
|
-
],
|
|
15716
|
-
"returnDescription": "The string generated by the method.",
|
|
15717
|
-
"returnType": "String"
|
|
15718
|
-
},
|
|
15719
|
-
{
|
|
15720
|
-
"description": "Returns a string consisting of num\\_chars characters of the string, starting at the zero-based start\\_index. If there are fewer than num\\_chars in the string after start\\_index, returns the remaining characters in the string.",
|
|
15627
|
+
"description": "**OVERLOADED METHOD**\n\nReturns a string consisting of the last characters of the string, starting at the zero-based start\\_index.\n\n or \n\nReturns a string consisting of num\\_chars characters of the string, starting at the zero-based start\\_index. If there are fewer than num\\_chars in the string after start\\_index, returns the remaining characters in the string.",
|
|
15721
15628
|
"name": "Mid",
|
|
15722
15629
|
"params": [
|
|
15723
15630
|
{
|
|
15724
15631
|
"default": null,
|
|
15725
|
-
"description": "The position in the roString object from which to return the number of characters specified by num\\_chars.",
|
|
15632
|
+
"description": "The position in the roString object from which to return the remaining characters. OR The position in the roString object from which to return the number of characters specified by num\\_chars.",
|
|
15726
15633
|
"isRequired": true,
|
|
15727
15634
|
"name": "start_index",
|
|
15728
15635
|
"type": "Integer"
|
|
@@ -15730,11 +15637,12 @@
|
|
|
15730
15637
|
{
|
|
15731
15638
|
"default": null,
|
|
15732
15639
|
"description": "The number of characters in the remaining part of the roString object to be retrieved.",
|
|
15733
|
-
"isRequired":
|
|
15640
|
+
"isRequired": false,
|
|
15734
15641
|
"name": "num_chars",
|
|
15735
15642
|
"type": "Integer"
|
|
15736
15643
|
}
|
|
15737
15644
|
],
|
|
15645
|
+
"returnDescription": "The string generated by the method.\n\n or \n\n",
|
|
15738
15646
|
"returnType": "String"
|
|
15739
15647
|
},
|
|
15740
15648
|
{
|
|
@@ -15745,14 +15653,14 @@
|
|
|
15745
15653
|
"default": null,
|
|
15746
15654
|
"description": "The string of characters within the roString object to be replaced.",
|
|
15747
15655
|
"isRequired": true,
|
|
15748
|
-
"name": "
|
|
15656
|
+
"name": "fromStr",
|
|
15749
15657
|
"type": "String"
|
|
15750
15658
|
},
|
|
15751
15659
|
{
|
|
15752
15660
|
"default": null,
|
|
15753
15661
|
"description": "The string of characters that will replace all instances of the **from** string.",
|
|
15754
15662
|
"isRequired": true,
|
|
15755
|
-
"name": "
|
|
15663
|
+
"name": "toStr",
|
|
15756
15664
|
"type": "String"
|
|
15757
15665
|
}
|
|
15758
15666
|
],
|
|
@@ -15810,30 +15718,20 @@
|
|
|
15810
15718
|
"returnType": "Object"
|
|
15811
15719
|
},
|
|
15812
15720
|
{
|
|
15721
|
+
"description": "**OVERLOADED METHOD**\n\n",
|
|
15813
15722
|
"name": "StartsWith",
|
|
15814
15723
|
"params": [
|
|
15815
15724
|
{
|
|
15816
15725
|
"default": null,
|
|
15817
|
-
"
|
|
15818
|
-
"name": "matchString",
|
|
15819
|
-
"type": "String"
|
|
15820
|
-
}
|
|
15821
|
-
],
|
|
15822
|
-
"returnDescription": "A flag indicating whether a matching substring was found.",
|
|
15823
|
-
"returnType": "Boolean"
|
|
15824
|
-
},
|
|
15825
|
-
{
|
|
15826
|
-
"name": "StartsWith",
|
|
15827
|
-
"params": [
|
|
15828
|
-
{
|
|
15829
|
-
"default": null,
|
|
15726
|
+
"description": "",
|
|
15830
15727
|
"isRequired": true,
|
|
15831
15728
|
"name": "matchString",
|
|
15832
15729
|
"type": "String"
|
|
15833
15730
|
},
|
|
15834
15731
|
{
|
|
15835
15732
|
"default": null,
|
|
15836
|
-
"
|
|
15733
|
+
"description": "",
|
|
15734
|
+
"isRequired": false,
|
|
15837
15735
|
"name": "matchPos",
|
|
15838
15736
|
"type": "Integer"
|
|
15839
15737
|
}
|
|
@@ -16570,6 +16468,13 @@
|
|
|
16570
16468
|
"returnDescription": "The URL.",
|
|
16571
16469
|
"returnType": "String"
|
|
16572
16470
|
},
|
|
16471
|
+
{
|
|
16472
|
+
"description": "Returns the user agent of the device, which can then be passed into server-side ad requests.",
|
|
16473
|
+
"name": "GetUserAgent",
|
|
16474
|
+
"params": [],
|
|
16475
|
+
"returnDescription": "The device user agent, which has the following syntax: \"Roku/DVP-major.minor (major.minor.revision.build-plid)\". For example, Roku/DVP‑12.0 (12.0.0.4171‑29).",
|
|
16476
|
+
"returnType": "String"
|
|
16477
|
+
},
|
|
16573
16478
|
{
|
|
16574
16479
|
"description": "Synchronously performs an HTTP HEAD request and returns an [roUrlTransfer](https://developer.roku.com/docs/references/brightscript/interfaces/ifurltransfer.md\"roUrlTransfer\") object.",
|
|
16575
16480
|
"name": "Head",
|