add_shot_media

add_shot_media(path: unicode, state: RumbaDocument.State, frame: Optional[float], media_layer: Optional[maquina.Node], create_clip: bool, undo_stack: bool)

Get or create a shot document, media and clip in the current sequence.

Returns the media node, the clip node (if created), and the clip’s last frame

Parameters
  • path (unicode) – The path to the ‘.rumba’ file to add to the project OR the node’s full name prefixed by “doc:”, like in “doc:/documents/New Shot”.

  • state (RumbaDocument.State) – Use RumbaDocument::State::unloaded.

  • frame (Optional[float]) – The optional clip start frame. If not defined, use the end of the current sequence.

  • media_layer (Optional[maquina.Node]) – If defined, use that media layer to create the shot clip. If not defined, use an existing media layer or create a “Sequence” media layer.

  • create_clip (bool) – If true, add a clip on the media layer for the shot.

  • undo_stack (bool) – If true, this action is undoable.

Return type

(maquina.Node, Optional[maquina.Node], float)