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.

Discussion

The jit.playlist object inherits the following attributes from jit.movie. See the jit.movie reference page for descriptions.
colormode
interp
unique
vol
rate
seamless_loopcount (avf engine only)
cache_size (viddll engine only)

Attributes inherited from jit.movie are applied globally to each clip in the playlist. Use the setclip message to override values for specific clips. Global and clip specific attribute values are saved in the playlist's content dictionary and reloaded with the patch. Access these values via the getcontent message.

Arguments

None.

Attributes

accentcolor [4 floats]

Sets the color of the loop icon when turned off.

allowreorder [int] (default: 1)

Allow the re-ordering of clips in 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 jit.playlist according to the expansion attribute.

color [4 floats]

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

drawto [symbol]

A render context name, used when output_texture is enabled. If no value is specified the attribute is set implicitly. In this case use the getclipattr message to query the value.

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. )
'grow' ( Expand the size of the box downward, while maintaining the height of all clips. )

loop [int]

Turn looping on/off.

loopreport [int] (default: 0)

When loopreport is set to 1, the word "loopnotify", followed by the clip number and file name, will be sent out the second outlet of jit.playlist every time the selected video file reaches the end of a loop.

output_texture [int]

When output_texture is set to 1, the video files in jit.playlist will be output as a texture. A valid GL context (e.g. a jit.world or jit.pworld) is required for texture output functionality.

parameter_enable [int]

Enables use of this object with Max for Live Parameters and allows for setting initial parameter values in the Max environment.

parameter_mappable [int] (default: 1)

When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Mappings feature.

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 color of the file name text 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.

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.

Parameter Attributes

Order

Typeint

Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.

Parameter Mode Enable

Typeint

Parameter Mode Enable (not available from Parameters window)

Link to Scripting Name

Typeint

When checked, the Scripting Name is linked to the Long Name attribute.

Long Name

Typesymbol

The long name of the parameter. This name must be unique per patcher hierarchy.

Short Name

Typesymbol

Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.

Type

Typeint

Specifies the data type. The data types used in Max for Live are:

Float
Int
Enum (enumerated list)
Blob

Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to 256 values, with a default range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values will exceed this range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.

Range/Enum

Typelist

When used with an integer or floating point data type, this field is used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains a space-delimited list of the enumerated values (if list items contain a space or special characters, the name should be enclosed in double quotes).

Modulation Mode

Typeint

Sets the Modulation Mode used by the Live application. The modulation modes are:

None
Unipolar
Bipolar
Additive
Absolute

Modulation Range

Typelist

This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.

Initial Enable

Typeint

When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).

Initial

Typelist

Sets the initial value to be stored and used when the Initial Enable attribute is checked.

Unit Style

Typeint

Sets the unit style to be used when displaying values. The unit style values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values

Custom Units

Typesymbol

Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").

Exponent

Typefloat

When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.

Steps

Typeint

The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.

Parameter Visibility

Typeint

For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.

Update Limit (ms)

Typeint

Speed limits values triggered by automation.

Defer Automation Output

Typeint

Defers values triggered by automation.

Messages

int

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

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.

clear

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

(drag)

Create a new jit.playlist object by dragging and dropping a compatible media file into an unlocked patch. To load additional media files into a jit.playlist object, drag the new file onto the jit.playlist UI until a line appears above or below the currently loaded file. To rearrange tracks within jit.playlist, click and drag the handle (dot on the left side) up or down in a locked patch. To replace a currently loaded file, drag the new file over the old one until the entire track is highlighted.

getclipattr

Arguments

clip [int]
attribute [symbol]
The word getclipattr, followed by a clip number and attribute name, will send that attribute's value out the notification (middle) outlet of jit.playlist. This allows you to retrieve an attribute state for a specific clip. You can retrieve read-only attributes (e.g. duration, moviedim, etc.), along with most attributes supported by jit.movie.

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. Please note that most content states will not print their default values. These will only be printed if you explicitly set a value. For the "absolutepath" entry, the full file path for each clip will only be displayed if the file is not in Max's search path. If the file is in Max's search path, only the file name will be displayed.

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

next

Plays the next clip loaded in jit.playlist.

pause

Pause playback of the current clip at the current position.

remove

Arguments

clip-number [int]
The word remove, followed by a clip number starting at 1, removes that 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). The first argument specifies which clip (starting at 1). The second argument is the start point for the clip, and the third argument is the end point. If only two arguments are given, they serve as the start and end points for all clips in jit.playlist. If only one argument is given, it serves as the clip number and clears any selection from that clip.

selectionms

Arguments

clip [int]
start [float]
end [float]
Select playback endpoints for a clip in milliseconds. The first argument specifies which clip (starting at 1). The second argument is the start point for the clip, and the third argument is the end point. If only two arguments are given, they serve as the start and end points for all clips in jit.playlist. If only one argument is given, it serves as the end point for all clips in jit.playlist.

setclip

Arguments

clip [int]
attribute [symbol]
value [anything]
jit.movie attributes are available in jit.playlist. To control a specific clip, use the "setclip" message followed by the clip number, attribute name, and value. The message "setclip 2 loop 1" will turn looping on for clip 2.

See Also

Name Description
jit.movie Play a movie
playlist~ Play sound files
mc.playlist~ Play sound files with multichannel output
jit.world The Jitter world context
jit.pworld Display a Jitter GL context