| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
ON THIS PAGE
|
...
Enables GPU rasterization for HTML graphics. By default, the decision to use GPU rasterization is based on internal Chromium logic.
[boolean] canvas_2d_acceleration_enabled
...
[string or double] storage_quota
Sets the total size (in bytes) allotted to all local storage applications (including IndexedDB). A BrightScript integer is only guaranteed to be able to represent a count of bytes up to 2GB so avoid using integers when calculating the size: Use float or double instead since they can represent values over 2GB (string can also be used but is not recommended). If the storage path is specified without a storage quota, Chromium defaults to reserving 1GB plus 10% of the total size of the storage device.
[roMessagePort] port
Configures the message port to which the roHtmlWidget instance will send events. When using initialization parameters, the port parameter should be used instead of the SetPort() method to ensure the script can catch load-started, load-finished, and load-error events.
...
Displays content from the specified URL. When using this method to retrieve content from local storage, specify the file location as follows: "file:/<drive>:/<directory>/<filename>". For example, an index.html file in the "Content" folder on the SD card can be selected with the string "file:/SD:/Content/index.html". You can also omit the drive specification to select the currently active drive (i.e. whichever drive the current autorun as loaded from).
...
Enables or disables pinch-to-zoom functionality, which is disabled by default.
...
EnableSecurity(
...
enable As
...
Dynamic) As
...
Sets the screen orientation of content in the widget (note that the coordinates and dimensions of the roRectangle containing the widget are not affected by rotation). This method accepts the following strings:
"identity": There is no transform (i.e. the widget content is oriented as landscape). This is the default setting."rot90": The widget content is rotated to portrait at 90 degrees (clockwise)."rot270": The widget content is rotated to portrait at 270 degrees (counter-clockwise).
| Note | ||
|---|---|---|
| ||
The JavaScript |
SetAlpha(alpha As Integer) As Boolean
Sets the overall alpha level for the widget (the default equals 255).
SetVideoPlayerDefaults(defaults As roAssociativeArray) As Boolean
...
Boolean Anchor enablesecurity() enablesecurity()
| enablesecurity() | |
| enablesecurity() |
Deprecated. Use security_params in initialization parameters instead.
EnableMouseEvents(enable As Boolean) As Boolean
Deprecated. Use mouse_enabled in initialization parameters instead.
SetPortrait(portrait_mode As Boolean) As Boolean
Deprecated. Use transform in initialization parameters instead.
SetTransform(transform As String) As Boolean
Sets the screen orientation of content in the widget (note that the coordinates and dimensions of the roRectangle containing the widget are not affected by rotation). This method accepts the following strings:
"identity": There is no transform (i.e. the widget content is oriented as landscape). This is the default setting."rot90": The widget content is rotated to portrait at 90 degrees (clockwise)."rot270": The widget content is rotated to portrait at 270 degrees (counter-clockwise).
| Note | ||
|---|---|---|
| ||
The JavaScript |
SetAlpha(alpha As Integer) As Boolean
Sets the overall alpha level for the widget (the default equals 255).
EnableScrollbars(scrollbars As Boolean) As Boolean
Deprecated. Use scrollbar_enabled in initialization parameters instead.
AddFont(filename As String) As Boolean
Deprecated. Use fonts in initialization parameters instead.
SetPcmAudioOutputs(outputs As roArray) As Boolean
Deprecated. Use pcm_audio_outputs in initialization parameters instead.
SetCompressedAudioOutputs(outputs As roArray) As Boolean
Deprecated. Use compressed_audio_outputs in initialization parameters instead.
SetMultichannelAudioOutputs(outputs As roArray) As Boolean
Deprecated. Use multi_channel_audio_outputs in initialization parameters instead.
SetHWZDefault(default As String) As Void Anchor sethwzdefault() sethwzdefault()
| sethwzdefault() | |
| sethwzdefault() |
Deprecated. Use hwz_default in initialization parameters instead.
SetVideoPlayerDefaults(defaults As roAssociativeArray) As Boolean
Sets default playback settings for <video> elements in the widget. Available parameters are identical to the roVideoPlayer.PlayFile() method. Default settings will be overwritten by parameters specified in individual <video> elements.
ForceGpuRasterization(enable As Boolean) As Boolean
Deprecated. As of OS8, GPU rasterization is enabled by default and calling this method has no effect.
EnableCanvas2dAcceleration(enable As Boolean) As Boolean
Deprecated. Use canvas_2d_acceleration_enabled in initialization parameters instead.
SetUserStylesheet(URI As String) As Boolean
| Anchor | ||||
|---|---|---|---|---|
|
Deprecated. Use user_stylesheet in initialization parameters instead.
FlushCachedResources() As Boolean
...
Sets the maximum size (in bytes) for the application cache. Changing the storage size of the application cache will clear the cache and rebuild the cache storage. Depending on database-specific attributes, you will only be able to set the size in units that are equal to the page size of the database, which is established at creation. These storage units will occur only in the following increments: 512, 1024, 2048, 4096, 8192, 16384, 32768, 32768.
EnableJavaScript(enable As Boolean) As Boolean
Deprecated. Use javascript_enabled in initialization parameters instead.
AllowJavaScriptURLs(url_collection As roAssociativeArray)
Deprecated. If javascript_enabled is set to true in the initialization parameters, JavaScript objects are enabled for all sites.
PostJSMessage(data As roAssociativeArray) As Boolean
...
| Note | ||
|---|---|---|
| ||
Changing the DOM is only possible at |
StartInspectorServer(port As Integer) As Boolean
Deprecated. Use inspector_server in initialization parameters instead.
SetUserAgent(user_agent As String) As Boolean
Deprecated. Use user_agent in initialization parameters instead.
GetUserAgent() As String
Returns the currently active user-agent string for the roHtmlWidget instance.
SetUserAgentSuffix(suffix As String) As Boolean
Deprecated. Use user_agent in initialization parameters instead.
SetProxy(proxy as String) As Boolean
...
- Proxy URL: The proxy address should be formatted as "http://user:password@hostname:port". The hostname can contain up to four "*" characters; each "*" character can be used to replace one octet from the current IP address. For example, if the IP address is currently 192.168.1.2, and the proxy is set to "proxy-*-*", then the player will attempt to use a proxy named "proxy-192.168".
- Proxy File: The .pac proxy file can be located on either the local file system or the network. If the file is local, there are no file-name restrictions; if the file is located on the network, the file name should have a .pac extension. If the URL is a hostname only, it will be considered a proxy-server address rather than a file URL.
| Tip | ||
|---|---|---|
| ||
The following are examples of valid location formats for .pac files: |
SetProxyBypass(hostnames As String) As Boolean
Exempts the specified hosts from the proxy configuration on the roHtmlWidget instance. The passed array should consist of one or more hostnames. The player will attempt to reach the specified hosts directly rather than using the proxy that has been specified with the SetProxy() method. For example, the hostname "example.com" would exempt "example.com", "example.com:80", and "www.example.com" from the proxy setting.
...
Allows the user to set up one or more proxies. If proxy pac files are included, this method must be used to specify authentication parameters.
ifMessagePort
SetPort(port As roMessagePort)
...