Package bpy :: Package ops :: Module sequencer
[hide private]
[frames] | no frames]

Module sequencer

Functions [hide private]
 
cut(frame=0, type='SOFT', side='BOTH')
Cut the selected strips.
 
delete()
Erase selected strips from the sequencer.
 
duplicate(mode=1)
Duplicate the selected strips.
 
effect_strip_add(path='', filename='', directory='', filter_blender=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=False, filemode=9, name='', start_frame=0, end_frame=0, channel=1, replace_sel=True, type='CROSS', color=(0.0, 0.0, 0.0))
Add an effect to the sequencer, most are applied on top of existing strips
 
image_strip_add(path='', filename='', directory='', filter_blender=False, filter_image=True, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=9, name='', start_frame=0, channel=1, replace_sel=True, files=None)
Add an image or image sequence to the sequencer
 
images_separate(length=1)
On image sequences strips, it return a strip for each image.
 
lock()
Lock the active strip so that it can't be transformed.
 
meta_make()
Group selected strips into a metastrip.
 
meta_separate()
Put the contents of a metastrip back in the sequencer.
 
meta_toggle()
Toggle a metastrip (to edit enclosed strips).
 
movie_strip_add(path='', filename='', directory='', filter_blender=False, filter_image=False, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=9, name='', start_frame=0, channel=1, replace_sel=True, files=None, sound=True)
Add a movie strip to the sequencer
 
mute(unselected=False)
Mute selected strips.
 
next_edit()
Move frame to next edit point.
 
previous_edit()
Move frame to previous edit point.
 
properties()
Open sequencer properties panel.
 
refresh_all()
Refresh the sequencer editor.
 
reload()
Reload strips in the sequencer.
 
rendersize()
Set render size and aspect from active sequence.
 
scene_strip_add(name='', start_frame=0, channel=1, replace_sel=True, scene='')
Add a strip to the sequencer using a blender scene as a source
 
select(extend=False, linked_handle=False, left_right=False, linked_time=False)
Select a strip (last selected becomes the "active strip").
 
select_active_side(side='BOTH')
DOC_BROKEN
 
select_all_toggle()
Select or deselect all strips.
 
select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)
Enable border select mode.
 
select_handles(side='BOTH')
DOC_BROKEN
 
select_inverse()
Select unselected strips.
 
select_less()
DOC_BROKEN
 
select_linked()
DOC_BROKEN
 
select_linked_pick(extend=False)
DOC_BROKEN
 
select_more()
DOC_BROKEN
 
snap(frame=0)
Frame where selected strips will be snapped.
 
sound_strip_add(path='', filename='', directory='', filter_blender=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=True, filter_text=False, filter_folder=True, filemode=9, name='', start_frame=0, channel=1, replace_sel=True, files=None, cache=False)
Add a sound strip to the sequencer
 
swap_left()
Swap active strip with strip to the left.
 
swap_right()
Swap active strip with strip to the right.
 
unlock()
Unlock the active strip so that it can't be transformed.
 
unmute(unselected=False)
UnMute unselected rather than selected strips.
 
view_all()
View all the strips in the sequencer.
 
view_selected()
Zoom the sequencer on the selected strips.
Function Details [hide private]

cut(frame=0, type='SOFT', side='BOTH')

 

Cut the selected strips.

Parameters:
  • frame (int) - Frame where selected strips will be cut in (-inf, inf)
  • type (enum) - The type of cut operation to perform on strips in (SOFT, HARD)
  • side (enum) - The side that remains selected after cutting in (LEFT, RIGHT, BOTH)

duplicate(mode=1)

 

Duplicate the selected strips.

Parameters:
  • mode (int) - in (0, inf)

effect_strip_add(path='', filename='', directory='', filter_blender=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=False, filemode=9, name='', start_frame=0, end_frame=0, channel=1, replace_sel=True, type='CROSS', color=(0.0, 0.0, 0.0))

 

Add an effect to the sequencer, most are applied on top of existing strips

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • start_frame (int) - Start frame of the sequence strip in (-inf, inf)
  • end_frame (int) - End frame for the color strip in (-inf, inf)
  • channel (int) - Channel to place this strip into in (1, 32)
  • type (enum) - Sequencer effect type in (CROSS, ADD, SUBTRACT, ALPHA_OVER, ALPHA_UNDER, GAMMA_CROSS, MULTIPLY, OVER_DROP, PLUGIN, WIPE, GLOW, TRANSFORM, COLOR, SPEED)
  • color (float array of 3 items) - Initialize the strip with this color (only used when type='COLOR') in (0, 1)
  • replace_sel (boolean)
  • filter_text (boolean)
  • name (string)
  • filter_sound (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

image_strip_add(path='', filename='', directory='', filter_blender=False, filter_image=True, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=9, name='', start_frame=0, channel=1, replace_sel=True, files=None)

 

Add an image or image sequence to the sequencer

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • start_frame (int) - Start frame of the sequence strip in (-inf, inf)
  • channel (int) - Channel to place this strip into in (1, 32)
  • files (collection)
  • replace_sel (boolean)
  • filter_text (boolean)
  • name (string)
  • filter_sound (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

images_separate(length=1)

 

On image sequences strips, it return a strip for each image.

Parameters:
  • length (int) - Length of each frame in (1, 1000)

movie_strip_add(path='', filename='', directory='', filter_blender=False, filter_image=False, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=9, name='', start_frame=0, channel=1, replace_sel=True, files=None, sound=True)

 

Add a movie strip to the sequencer

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • start_frame (int) - Start frame of the sequence strip in (-inf, inf)
  • channel (int) - Channel to place this strip into in (1, 32)
  • files (collection)
  • sound (boolean)
  • replace_sel (boolean)
  • filter_text (boolean)
  • name (string)
  • filter_sound (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

mute(unselected=False)

 

Mute selected strips.

Parameters:
  • unselected (boolean)

scene_strip_add(name='', start_frame=0, channel=1, replace_sel=True, scene='')

 

Add a strip to the sequencer using a blender scene as a source

Parameters:
  • start_frame (int) - Start frame of the sequence strip in (-inf, inf)
  • channel (int) - Channel to place this strip into in (1, 32)
  • replace_sel (boolean)
  • scene (string)
  • name (string)

select(extend=False, linked_handle=False, left_right=False, linked_time=False)

 

Select a strip (last selected becomes the "active strip").

Parameters:
  • linked_handle (boolean)
  • left_right (boolean)
  • linked_time (boolean)
  • extend (boolean)

select_active_side(side='BOTH')

 

DOC_BROKEN

Parameters:
  • side (enum) - The side of the handle that is selected in (LEFT, RIGHT, BOTH)

select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0)

 

Enable border select mode.

Parameters:
  • gesture_mode (int) - in (-inf, inf)
  • xmin (int) - in (-inf, inf)
  • xmax (int) - in (-inf, inf)
  • ymin (int) - in (-inf, inf)
  • ymax (int) - in (-inf, inf)

select_handles(side='BOTH')

 

DOC_BROKEN

Parameters:
  • side (enum) - The side of the handle that is selected in (LEFT, RIGHT, BOTH)

select_linked_pick(extend=False)

 

DOC_BROKEN

Parameters:
  • extend (boolean)

snap(frame=0)

 

Frame where selected strips will be snapped.

Parameters:
  • frame (int) - Frame where selected strips will be snapped in (-inf, inf)

sound_strip_add(path='', filename='', directory='', filter_blender=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=True, filter_text=False, filter_folder=True, filemode=9, name='', start_frame=0, channel=1, replace_sel=True, files=None, cache=False)

 

Add a sound strip to the sequencer

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • start_frame (int) - Start frame of the sequence strip in (-inf, inf)
  • channel (int) - Channel to place this strip into in (1, 32)
  • files (collection)
  • replace_sel (boolean)
  • filter_text (boolean)
  • name (string)
  • filter_sound (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • cache (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

unmute(unselected=False)

 

UnMute unselected rather than selected strips.

Parameters:
  • unselected (boolean)