Package Max

jweb~

Web browser with audio output

Description

The jweb~ object uses the cross-platform Chromium Embedded Framework (CEF) to host web pages within a Max UI object. Audio signals generated by the page are sent out the object's outlets.

Arguments

None.

Attributes

disablefind[int]

When enabled, the disablefind prevents the user from using the Find... command to locate text on the current page.

history[symbol]:

Specifies a named dictionary (dict object) where the browser history will be recorded, up to the number of pages set by the historysize attribute. Previously visited pages can be reloaded with the gotohistory message.

historysize[int]: 25

Set the size of the browser history; the default is 25 pages.

latency[float]

Sets the output latency in milliseconds. Setting the latency to 0 will set the minimum possible latency (around 23ms at 44.1kHz sampling rate; around 21ms at 48kHz). The minimum latency may result in occasionaly drop-outs or distortion. The maximum latency is three times the minimum.

rendermode[int]

When the rendermode attribute is set to ‘offscreen’, jweb~ will first render to an offscreen buffer, then draw to the patcher window. This mode is slower, but useful if you need UI elements to appear in front of the jweb~ object. When set to ‘onscreen’, jweb~ will render faster, but render directly in the patcher (without using an offscreen buffer), drawing over any other UI elements. When set to 'onscreen with transparent background', the background of the jweb~ object will be rendered transparently. Possible values:

0 = 'Offscreen'
1 = 'Onscreen'
2 = 'Offscreen with Transparent Background'

url[symbol]:

The URL of the current page

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

annotation[symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background[int]: 0

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color[4 floats]

Sets the color for the object box outline.

fontface[int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname[symbol]

Sets the object's font.

fontsize[float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden[int]: 0

Toggles whether an object is hidden when the patcher is locked.

hint[symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick[int]: 0

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile[symbol]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

patching_rect[4 floats]: 0. 0. 100. 0.

Sets the position and size of the object in the patcher window.

position[2 floats]
write-only

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation[int]: 0

Sets whether an object belongs to the patcher's presentation.

presentation_rect[4 floats]: 0. 0. 0. 0.

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect[4 floats]
write-only

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size[2 floats]
write-only

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor[4 floats]

Sets the color for the object's text in RGBA format.

textjustification[int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname[symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

anything

You can send any message to the JavaScript of the contained website. In order to be able to receive messages make sure to setup the JavaScript as described in the Web Browser and jweb guide.

back

The back message reloads the previous page of data, functioning like the 'Back' button in a conventional web browser.

executejavascript

Using executejavascript you can inject and run a JavaScript code snippet in the currently displayed web page. The provided code will be inserted and executed in a new script tag.

Arguments:
  • script [symbol]

forward

When a sequence of multiple pages has been loaded, and the object has received the back message, the word forward will advance to the following page in the object's page history. forward functions like the 'Forward' button in a conventional web browser.

gotohistory

If the history attribute has been set to a named dictionary, gotohistory followed by an index will navigate to the page with that index in the dictionary. The most recently visited page is stored at index 0.

Arguments:
  • index [int]

(mouse)

Use the mouse (and keyboard) to interact with the page displayed by jweb~ in a locked patcher.

mute

mute 1 will mute the signal output of the page; mute 0 will unmute

Arguments:
  • mute-state [int]

read

The word read , followed by a symbol that specifies a URL or a file pathname, will read the webpage or file and attempt to render its contents. Upon successful load of a page, two messages are sent from the object's outlet: url , followed the final URL which was loaded based on the provided argument; and title , followed by the title of the loaded page as a symbol.

Arguments:
  • url [symbol]

readfile

The word readfile , followed by a symbol that specifies a file pathname, will read the file and attempt to render its contents. The word readfile with no argument opens a file dialog to choose a file. Upon successful load of a page, two messages are sent from the object's outlet: url , followed the final URL which was loaded based on the provided argument; and title , followed by the title of the loaded page as a symbol.

Arguments:
  • file path [symbol]

reload

The reload message causes the browser to refresh the current page, functioning like the 'Reload' button in a conventional web browser.

signal

TEXT_HERE

See Also

Name Description
Web Browser Web Browser
jweb Web browser
js Execute Javascript (Legacy Engine)
maxurl Make HTTP requests