jit.playlist
Jitter Reference
Open Help

jit.playlist

Play video files

Description

Use jit.playlist to organize sets of video files and play them back. Each video is given a visual representation in a clip where a selection from the entire video file may be choosen. Clips may be dragged within a jit.playlist to re-order them, or they maybe dragged to other jit.playlist objects.

Arguments

None.

Attributes

displaymode [symbol] (default: sample)

Display format for clips.

Possible values:

'list' ( Clips are displayed with a vignettes in a timeline )
'grid' ( Clips are displayed as thumbnails in a grid )

allowreorder [long] (default: 1)

Allow the re-ordering of clips in the jit.playlist by dragging the handle (dot on the left side) for a clip above or below other clips.

clipheight [float] (default: 1)

Height alloted for each clip to be displayed. This value may be altered when dragging new clips into the jit.playlist according to the @expansion attribute.

expansion [symbol] (default: sample)

Style of accomodation for adding clips to a jit.playlist with no empty space available.

Possible values:

'grow' ( Increase the size of the box to make room for adding a new clip of the same height as existing clips. )
'squeeze' ( Maintain the size of the box and reduce the height of all clips to make room. )
'squeezegrow' ( Increase the size of the box slightly and also reduce the height of all clips slightly to accomodate the new clip. )
'static' ( Maintain both the size of the box and the height of all clips. A scroll bar will need to be used to access clips out of view. )

autopwindow [long] (default: 1)

Automatically patch a jit.pwindow object connect it, if needed, when a clip is asked to play.

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.

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 [float]

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

textjustification [int]

Text Justification

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

int

Arguments

clip [int]
0 stops video playback. A number greater than zero begins playback of the clip with that index. Indices begin counting at 1.

pause

Pause playback of the current clip at the current position.

resume

Resume playback from the current position if playback has been paused.

clear

Remove all clips from the playlist. To remove just one clip, right-click on the file you wish to remove and choose "Remove" from the contextual menu.

rate

Arguments

clip [int]
rate [float]
Set playback speed for a clip. First argument specifies which clip (starting at 1). Second argument is the rate (1.0 = original speed, 0.5 = half-speed, etc).

loop

Arguments

clip [int]
loop [int]
Turn looping on/off for a clip. First argument specifies which clip (starting at 1). Second argument is a 1 (loop) or 0 (don't loop).

selection

Arguments

clip [int]
start [float]
end [float]
Select playback endpoints for a clip using a normalized range (0.0 is the beginning, 1.0 is the end). First argument specifies which clip (starting at 1). Second argument is the start point for the clip. Third argument is the end point for the clip.

Output

list

The 'mouse' message is sent together with normalized mouse coordinates and the mouse button state.

See Also

Name Description
playlist~ Play sound files
sfplay~ Play audio file from disk
waveform~ buffer~ viewer and editor