Description

Sets the specified clip to be active or specify a clip to be referenced with a -next or -prev flag.

Useful when jumping back and forth between clips in a script.

Functional area

Data manipulators

Command syntax

Syntax

setActiveClip "clip" [-next] [-prev]

Arguments

Name	Type	Required	Comments
`clip`	string	no	The clip in which you want to make active or have the command reference. Not required if you use the -next or -prev flags, though if one of those flags is specified, then the clip made active will be relative to this clip.

Flags

Name	Flag arguments	Argument type	Exclusive to	Comments
`next`	0	—	prev	Activates the clip before the currently active clip. If the currently active clip is the first clip in the clip list, then it will "wrap" around, selecting the last clip in the clip list.
`prev`	0	—	next	Activates the clip after the currently active clip. If the currently active clip is the last clip in the clip list, then it will "wrap" around, selecting the first clip in the clip list.

Return value

void

Examples

// Create 3 Clips
create Clip "Clip_A" "Clip_B" "Clip_C";
 
// Set Clip_B active
setActiveClip "Clip_B";
 
// Set Clip_A active
setActiveClip -prev;
 
//set Clip_C active
setActiveClip "Clip_B" -next;