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 by using the handle (dot) on the left side of the clip.

Arguments

None.

Attributes

accentcolor [4 floats]

Sets the controls color (when off) of the object in RGBA format.

allowreorder [int] (default: 2)

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.

Possible values:

0 = 'Off'
1 = 'On'
2 = 'Automatic'

bgcolor [4 floats]

Sets the background color of the object in RGBA format.

clipheight [float] (default: 30.)

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.

color [4 floats]

Sets the waveform and controls color (when on) of the object in RGBA format.

elementcolor [4 floats]

Sets the clip divider color of the object in RGBA format.

expansion [symbol] (default: squeeze)

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

Possible values:

'squeeze' ( Maintain the size of the box and reduce the height of all clips to make room. )
'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. )

loopreport [int] (default: 0)

When loopreport is set to 1, a bang will be sent out the second outlet of jit.playlist every time the selected video file reaches the end of playback.

output_texture [int] (default: 0)

When output_texture is set to 1, the video files in jit.playlist will be output as a texture.

reportprogress [int] (default: 0)

When reportprogress is set to 1, the current playback position will be sent out the second outlet of jit.playlist as a float from 0-1.

selectioncolor [4 floats]

Sets the selection color of the object in RGBA format.

showname [int] (default: 1)

When showname is set to 1, the name of the video file is displayed in the jit.playlist UI.

style [symbol] (default: )

Sets the style to be applied to the object. Styles can be set using the Format palette.

textcolor [4 floats]

Sets the text color of the object in RGBA format.

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

int

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

adapt

Arguments

clip [int]
adapt [int]
Adapt output matrix dimensions to movie size flag. The first argument specifies which clip (starting at 1). The second argument enables/disables adapt for that clip.

append

Arguments

video file [symbol]
clip number [int]
Add a new video file to the list. First argument specifies the video file. Second (optional) argument specifies the slot number for the clip (starting at 1). If no arguments are listed, clicking the append message in a locked patcher will open a dialog box where you can choose a file to append.

automatic

Arguments

clip [int]
automatic [int]
Enable automatic matrix output when bound to jit.world. The first argument specifies which clip (starting at 1). The second argument enables/disables automatic matrix output for that clip.

autostart

Arguments

clip [int]
autostart [int]
Autoplay on movie load (default = 1). The first argument specifies which clip (starting at 1). The second argument enables/disables autostart for that clip.

cache_size

Arguments

clip [int]
cache size [float]
The maximum cache size in gigabytes (default = 0.1). The first argument specifies which clip (starting at 1). The second argument sets the maximum cache size for that clip. The cache stores frames in memory as they are decoded, allowing for efficient playback. When the cache_size limit is reached, the least recently used frames are discarded from the cache. Reverse playback stutters may be the result of insufficient cache_size. Care should be taken when adjusting the cache_size, if the frame cache exceeds the available memory, the application may crash.

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.

colormode

Arguments

clip [int]
colormode [symbol]
The output matrix's color encoding. The first argument specifies which clip (starting at 1). The second argument sets the colormode for that clip.

Possible values are:

argb (alpha, red, green, blue)
uyvy (YUV 4:2:2 packed)

dim

TEXT_HERE

drawto

Arguments

clip [int]
render context name [symbol]
A render context name, used when output_texture is enabled. The first argument specifies which clip (starting at 1). The second argument sets the render context name for that clip.

(drag)

To load a compatible media file, drag and drop the file onto the jit.playlist object.

dstrect

The portion of the output matrix used for decompressing media to the internal matrix (default = 0 0 (matrix width) (matrix height))
The bounds of the rectangle are expressed in the form left top right bottom . All values are relative to the top-left corner of the viewing area of the output matrix.

duration

The duration of the movie.

engine

Video engine backend. This message can only be set in the max box. If not specified, it is determined by the Video Engine Max preference. As of this writing, possible values include avf (Mac only), qt and viddll .

fps

The approximate calculation of the movie's internal FPS rate.

framecount

Number of frames in the movie.

framereport

Frame reporting flag (default = 0).

getcontent

The word getcontent sends the contents and behavior of all clips out the last outlet of jit.playlist in dictionary format. Connect the last outlet to a dict.view object to see the contents.

interp

Arguments

clip [int]
interp [int]
Output interpolation flag (default = 0). When the flag is set to 1, the input matrix will be interpolated when copied to the internal matrix.

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).

loopend

Arguments

clip [int]
loopend [int]
The movie loop point end. Time is specified as time values. The first argument specifies which clip (starting at 1). The second argument sets the loop point end.

looppoints

Arguments

clip [int]
looppoint [int]
The movie loop point. Time is specified as time values. The first argument specifies which clip (starting at 1). The second argument sets the beginning loop point.

looppoints_ms

Arguments

clip [int]
looppoint [int]
Movie loop points in milliseconds. The first argument specifies which clip (starting at 1). The second argument sets the beginning loop point in milliseconds. The clip will loop from this point to the end.

looppoints_secs

Arguments

clip [int]
looppoint [float]
Movie loop points in seconds. The first argument specifies which clip (starting at 1). The second argument sets the beginning loop point in seconds. The clip will loop from this point to the end.

loopreport

Loop notification flag

loopstart

Arguments

clip [int]
loopstart [int]
The movie loop point start. Time is specified as time values. The first argument specifies which clip (starting at 1). The second argument sets the loop point start.

(mouse)

Use your mouse to play and stop a clip in jit.playlist. Also use it to select small parts of the sample for playback.

moviefile

Load a movie file from disk.

next

Plays the next clip loaded in jit.playlist.

out_name

TEXT_HERE

output_texture

Arguments

clip [int]
output_texture [int]
Enable OpenGL texture output (default = 0) for a specific clip. The first argument specifies which clip (starting at 1). The second argument enables/disables OpenGL texture output. When enabled an OpenGL texture is output instead of a Jitter matrix. The object's drawto message must be set to a valid gl context. An RGBA texture is output using the movie's native dimensions. When enabled, the following messages have no effect:
adapt
colormode
dim
dstrect
srcrect
usedstrect
usesrcrect

outputmode

TEXT_HERE

pause

Pause playback of the current clip at the current position.

position

Arguments

clip [int]
position [float]
Sets the playback position, normalized between 0. and 1. This message only works while the video is playing, or if preceeded by the pause message and followed by the resume message. If two arguments are given, the first argument specifies the clip (starting at 1), and the second argument sets the playback position for that clip. If only one argument is given, it sets the playback position for the clip currently playing.

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).

remove

Arguments

clip-number [int]
Remove a clip from the list.

resume

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

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.

srcrect

The portion of the movie to decompress into a matrix (default = 0 0 (movie width) (movie height)). The bounds of the rectangle are expressed in the form left top right bottom . All values are relative to the top-left corner of the viewing area of the movie.

texture_name

Arguments

clip [int]
texture_name [symbol]
Output texture name, when output_texture is enabled. The first argument specifies which clip (starting at 1). The second argument sets the output texture name.

time

TEXT_HERE

time_ms

TEXT_HERE

time_secs

TEXT_HERE

timescale

Arguments

clip [int]
timescale [int]
The timescale for the movie (default = 600, but movie-dependent). The first argument specifies which clip (starting at 1). The second argument sets the timescale for that clip.

unique

Arguments

clip [int]
unique [int]
Unique frame filter flag (default = 0 (disabled)). When the flag is set, only new frames from the movie are output when the object receives a bang. If no new frame has been decompressed, the jit.playlist object will not respond to the bang. The first argument specifies which clip (starting at 1). The second argument disables or enables the flag.

usedstrect

Arguments

clip [int]
usedstrect [int]
Destination rect flag (default = 0). When the flag is set, the dstrect messages are used when copying an input matrix to the internal matrix. The first argument specifies which clip (starting at 1). The second argument disables or enables the flag.

usesrcrect

Arguments

clip [int]
usesrcrect [int]
Source rect flag (default = 0). When the flag is set, the srcrect messages are used when copying an input matrix to the internal matrix. The first argument specifies which clip (starting at 1). The second argument disables or enables the flag.

vol

Arguments

clip [int]
volume [float]
Sets the volume of a clip in jit.playlist. The first argument specifies which clip (starting at 1). The second argument sets the volume level.

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