jit.polymovie Reference

Manage multiple jit.movie objects

jit.polymovie

Examples

Arguments

drawto [message]

The named drawing context in which to draw (default = none). A named drawing context is a named instance of a jit.world, jit.pworld or jit.gl.node object. If no argument is provided the object will find a context implicitly.

Attributes

cachemode [int]

(EXPERIMENTAL) Enable auto cache feature when viddll is the video engine.

cache_sizeauto [float]

(EXPERIMENTAL) Set the auto cache_size when cachemode is enabled (default = 5)

cache_size [float]

Set the cache_size for all movie instances when viddll is the video engine (default = 0.5).

drawto [symbol]

Named drawing context used for texture output

target [int]

The polymovie target-instance that will receive subsequent jit.movie messages. For example target 2, play 0 will tell the second target to play the first movie file. Targets are activated dynamically by the target attribute. Active targets will add their movie output name (texture or matrix) to the polymovie output list. If 3 targets are activated the movie output list will contain 3 matrix or texture names, e.g. jit_gl_texture texname1 texname2 texname3 . Sending target 0 will deactivate all targets except the first.

Common Box Attributes

annotation [symbol]

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

background [int] (default: 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] (default: 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] (default: 0)

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

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

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

position [2 floats]

g/s(set)

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] (default: 0)

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

presentation_rect [4 floats] (default: 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]

g/s(set)

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]

g/s(set)

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

Get and set jit.movie attributes on the active movie instance. See play for more info.

appendfolder

Arguments

path [symbol]
Load all movie files found from the the folder at path and append to the current movie list.

appendmovie

Arguments

path [symbol]
Append movie at path to the end of the movie list.

clear

Remove and release resources for all loaded files.

getdict

Output the movie state dictionary out the third outlet. This dictionary contains the full list of currently loaded movie files, as well as any jit.movie attributes modified after loading. See also readdict and writedict.

play

Arguments

index [int]
Play the movie at index (0 based). Playing an instance makes it active and the recepient of any attributes or playback messages (e.g. start and stop).

readdict

Arguments

path [symbol]
Read the movie list contents from a dictionary at path. If no path is given a file dialog is opened. See getdict for more info on polymovie dictionary usage.

readfolder

Arguments

path [symbol]
Load all movie files found from the the folder at path, replacing the currently loaded movie list.

scrub

Arguments

position [float]
Scrub the the active movie playhead. See play for more info. The position arg is between 0 (movie start ) and 1 (movie end).

sendmovies

Set jit.movie attributes on all loaded instances.

start

Start playback on the active movie instance. See play for more info.

stop

Stop playback on the active movie instance. See play for more info.

writedict

Arguments

path [symbol]
Write the movie list contents to a dictionary at path. If no path is given a file dialog is opened. See getdict for more info on polymovie dictionary usage.

See Also

Name Description
jit.movie Play a movie
jit.playlist Play video files