Autodesk Flame Family 2025 Help | Autodesk Flame Python: flame module

connect_nodes(...): connect_nodes( (PyActionFamilyNode)arg1, (PyFlameObject)parent_node, (PyFlameObject)child_node [, (str)link_type='Default']) -> bool : Connect two nodes in the Action/Image/GMaskTracer schematic. Keyword argument: type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

create_node(...): create_node( (PyActionFamilyNode)arg1, (str)node_type [, (str)file_path='' [, (bool)is_udim=False [, (int)tile_resolution=0]]]) -> object : Add an Action/Image/GMaskTracer object node to the Action/Image/GMaskTracer schematic. Keyword argument: file_path -- Required by nodes that load an asset, such as Matchbox.

disconnect_nodes(...): disconnect_nodes( (PyActionFamilyNode)arg1, (PyFlameObject)parent_node, (PyFlameObject)child_node [, (str)link_type='Default']) -> bool : Disconnect two nodes in the Action/Image/GMaskTracer schematic. Keyword argument: type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

encompass_nodes(...): encompass_nodes( (PyActionFamilyNode)arg1, (list)node_list) -> object : Create a compass including the node list given as argument Keyword argument: node_list -- a list of nodes (either string or node objects) output_type -- the created compass node

get_node(...): get_node( (PyActionFamilyNode)arg1, (str)node_name) -> object : Get a node by node name. Doesn't select it in the UI.

organize(...): organize( (PyActionFamilyNode)arg1) -> bool : Clean up the Action/Image/GMaskTracer schematic.

Read-only properties defined here:

all_tabs: Return a list of the object tabs.

cursor_position: Return a tuple that provides the cursor position in the Action/Image/GMaskTracer schematic.

left_tabs: Return a list of the object left tabs.

media_layers: Return a list of the Media layers of the Action/Image/GMaskTracer node.

node_types: Return a list of the node types available in the Action/Image/GMaskTracer schematic.

nodes: Return a list of Action/Image/GMaskTracer nodes used in the the Action/Image/GMaskTracer schematic.

right_tabs: Return a list of the object right tabs.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyActionNode(PyActionFamilyNode)

Class derived from PyActionFamilyNode. Represents an Action node object.

Method resolution order:: PyActionNode; PyActionFamilyNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

add_media(...): add_media( (PyActionFamilyNode)arg1) -> object : Add a Media layer to the Batch Action node. Also instantiates a matching Surface node (and Axis) in the Action node schematic.

disable_output(...): disable_output( (PyActionFamilyNode)arg1, (str)output_type) -> bool : Disable the render output_type for the Action node. Keyword argument: output_type -- The output to enable. (Comp, Matte, 3D Motion, Albedo, AO, Background, Emissive, GMask, Lens Flare, Motion Vectors, Normals, Object ID, Occluder, Position, Projectors Matte, Reflection, Roughness, Shadow, Specular, UV, Z-Depth HQ, Z-Depth)

enable_output(...): enable_output( (PyActionFamilyNode)arg1, (str)output_type) -> bool : Enable the render output_type for the Action node. Keyword argument: output_type -- The output to enable. (Comp, Matte, 3D Motion, Albedo, AO, Background, Emissive, GMask, Lens Flare, Motion Vectors, Normals, Object ID, Occluder, Position, Projectoars Matte, Reflection, Roughness, Shadow, Specular, UV, Z-Depth HQ, Z-Depth)

export_fbx(...): export_fbx( (PyActionFamilyNode)arg1, (str)file_path [, (bool)only_selected_nodes=False [, (float)pixel_to_units=0.10000000149011612 [, (str)frame_rate='23.976 fps' [, (bool)bake_animation=False [, (bool)export_axes=True [, (bool)export_point_locators=False [, (bool)combine_material=True [, (bool)duplicate_material=False]]]]]]]]) -> bool : Export Action nodes to an FBX file. Keyword argument: file_path -- Path to the output FBX file. Mandatory.

import_abc(...): import_abc( (PyActionFamilyNode)arg1, (str)file_path [, (bool)lights=True [, (bool)cameras=True [, (bool)models=True [, (bool)normals=True [, (bool)mesh_animations=True [, (str)frame_rate='23.976 fps' [, (bool)auto_fit=False [, (float)unit_to_pixels=10.0 [, (bool)consolidate_geometry=True [, (bool)create_object_group=False]]]]]]]]]]) -> list : Import an Alembic (ABC) file into the Action schematic using the Action Objects mode. Keyword argument: file_path -- Path to the ABC file. Mandatory.

import_fbx(...): import_fbx( (PyActionFamilyNode)arg1, (str)file_path [, (bool)lights=True [, (bool)cameras=True [, (bool)models=True [, (bool)normals=True [, (bool)mesh_animations=True [, (bool)keep_frame_rate=True [, (bool)bake_animation=False [, (bool)object_properties=True [, (bool)auto_fit=False [, (float)unit_to_pixels=10.0 [, (bool)create_media=True [, (bool)is_udim=False [, (bool)relink_material=True [, (str)input_colour_space='']]]]]]]]]]]]]]) -> list : Import an FBX file into the Action schematic using the Action Objects mode. Keyword argument: file_path -- Path to the FBX file. Mandatory.

import_psd(...): import_psd( (PyActionFamilyNode)arg1, (str)file_path [, (str)input_colour_space='']) -> list : Import a PSD file into the Action schematic. Keyword arguments: file_path -- Path to the PSD file. Mandatory. input_colour_space -- The colour space used as input. Optional.

read_abc(...): read_abc( (PyActionFamilyNode)arg1, (str)file_path [, (bool)lights=True [, (bool)cameras=True [, (bool)models=True [, (bool)normals=True [, (bool)mesh_animations=True [, (str)frame_rate='23.976 fps' [, (bool)auto_fit=False [, (float)unit_to_pixels=10.0 [, (bool)consolidate_geometry=True [, (bool)create_object_group=False]]]]]]]]]]) -> object : Import an Alembic (ABC) file into the Action schematic using the Read File mode. Keyword argument: file_path -- Path to the ABC file. Mandatory.

read_fbx(...): read_fbx( (PyActionFamilyNode)arg1, (str)file_path [, (bool)lights=True [, (bool)cameras=True [, (bool)models=True [, (bool)normals=True [, (bool)mesh_animations=True [, (bool)keep_frame_rate=True [, (bool)bake_animation=False [, (bool)object_properties=True [, (bool)auto_fit=False [, (float)unit_to_pixels=10.0 [, (bool)is_udim=False [, (bool)relink_material=True [, (str)input_colour_space='']]]]]]]]]]]]]) -> object : Import an FBX file into the Action schematic using the Read File mode. Keyword argument: file_path -- Path to the FBX file. Mandatory.

Read-only properties defined here:

media_nodes: Return a list of the Media nodes attached to the Action node.

output_types: Return a list of the output types available to the Action node.

Static methods inherited from PyActionFamilyNode:

clear_schematic(...): clear_schematic( (PyActionFamilyNode)arg1) -> bool : Clear the Action/Image/GMaskTracer schematic of all nodes.

connect_nodes(...): connect_nodes( (PyActionFamilyNode)arg1, (PyFlameObject)parent_node, (PyFlameObject)child_node [, (str)link_type='Default']) -> bool : Connect two nodes in the Action/Image/GMaskTracer schematic. Keyword argument: type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

create_node(...): create_node( (PyActionFamilyNode)arg1, (str)node_type [, (str)file_path='' [, (bool)is_udim=False [, (int)tile_resolution=0 [, (str)input_colour_space='']]]]) -> object : Add an Action/Image/GMaskTracer object node to the Action/Image/GMaskTracer schematic. Keyword argument: file_path -- Required by nodes that load an asset, such as Matchbox.

disconnect_nodes(...): disconnect_nodes( (PyActionFamilyNode)arg1, (PyFlameObject)parent_node, (PyFlameObject)child_node [, (str)link_type='Default']) -> bool : Disconnect two nodes in the Action/Image/GMaskTracer schematic. Keyword argument: type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

encompass_nodes(...): encompass_nodes( (PyActionFamilyNode)arg1, (list)node_list) -> object : Create a compass including the node list given as argument Keyword argument: node_list -- a list of nodes (either string or node objects) output_type -- the created compass node

get_node(...): get_node( (PyActionFamilyNode)arg1, (str)node_name) -> object : Get a node by node name. Doesn't select it in the UI.

organize(...): organize( (PyActionFamilyNode)arg1) -> bool : Clean up the Action/Image/GMaskTracer schematic.

Read-only properties inherited from PyActionFamilyNode:

all_tabs: Return a list of the object tabs.

cursor_position: Return a tuple that provides the cursor position in the Action/Image/GMaskTracer schematic.

left_tabs: Return a list of the object left tabs.

media_layers: Return a list of the Media layers of the Action/Image/GMaskTracer node.

node_types: Return a list of the node types available in the Action/Image/GMaskTracer schematic.

nodes: Return a list of Action/Image/GMaskTracer nodes used in the the Action/Image/GMaskTracer schematic.

right_tabs: Return a list of the object right tabs.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyArchiveEntry(PyFlameObject)

Class derived from PyFlameObject. Base class for any object displayed in the Media Panel.

Method resolution order:: PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyAttribute( )

Method resolution order:: PyAttribute

Static methods defined here:

__add__(...): __add__( (PyAttribute)arg1, (float)arg2) -> object __add__( (PyAttribute)arg1, (int)arg2) -> object __add__( (PyAttribute)arg1, (str)arg2) -> object

__eq__(...): __eq__( (PyAttribute)arg1, (object)arg2) -> bool

__floordiv__(...): __floordiv__( (PyAttribute)arg1, (object)arg2) -> object

__ge__(...): __ge__( (PyAttribute)arg1, (float)arg2) -> object __ge__( (PyAttribute)arg1, (int)arg2) -> object

__gt__(...): __gt__( (PyAttribute)arg1, (float)arg2) -> object __gt__( (PyAttribute)arg1, (int)arg2) -> object

__iadd__(...): __iadd__( (object)arg1, (float)arg2) -> object __iadd__( (object)arg1, (int)arg2) -> object __iadd__( (object)arg1, (str)arg2) -> object

__idiv__(...): __idiv__( (object)arg1, (float)arg2) -> object __idiv__( (object)arg1, (int)arg2) -> object

__imul__(...): __imul__( (object)arg1, (float)arg2) -> object __imul__( (object)arg1, (int)arg2) -> object

__init__(...): Raises an exception This class cannot be instantiated from Python

__isub__(...): __isub__( (object)arg1, (float)arg2) -> object __isub__( (object)arg1, (int)arg2) -> object

__le__(...): __le__( (PyAttribute)arg1, (float)arg2) -> object __le__( (PyAttribute)arg1, (int)arg2) -> object

__lt__(...): __lt__( (PyAttribute)arg1, (float)arg2) -> object __lt__( (PyAttribute)arg1, (int)arg2) -> object

__mul__(...): __mul__( (PyAttribute)arg1, (float)arg2) -> object __mul__( (PyAttribute)arg1, (int)arg2) -> object

__ne__(...): __ne__( (PyAttribute)arg1, (object)arg2) -> bool

__radd__(...): __radd__( (PyAttribute)arg1, (float)arg2) -> object __radd__( (PyAttribute)arg1, (int)arg2) -> object __radd__( (PyAttribute)arg1, (str)arg2) -> object

__reduce__ = (...)

__repr__(...): __repr__( (PyAttribute)arg1) -> object

__rmul__(...): __rmul__( (PyAttribute)arg1, (float)arg2) -> object __rmul__( (PyAttribute)arg1, (int)arg2) -> object

__rsub__(...): __rsub__( (PyAttribute)arg1, (float)arg2) -> object __rsub__( (PyAttribute)arg1, (int)arg2) -> object

__rtruediv__(...): __rtruediv__( (PyAttribute)arg1, (float)arg2) -> object __rtruediv__( (PyAttribute)arg1, (int)arg2) -> object

__str__(...): __str__( (PyAttribute)arg1) -> str

__sub__(...): __sub__( (PyAttribute)arg1, (float)arg2) -> object __sub__( (PyAttribute)arg1, (int)arg2) -> object

__truediv__(...): __truediv__( (PyAttribute)arg1, (float)arg2) -> object __truediv__( (PyAttribute)arg1, (int)arg2) -> object

get_value(...): get_value( (PyAttribute)arg1) -> object : Get the value of an attribute.

set_value(...): set_value( (PyAttribute)arg1, (object)arg2) -> bool : Set the value of an attribute.

Read-only properties defined here:

values: List the possible values or the range of possible values for an attribute.

class PyAudioTrack(PyFlameObject)

Object representing an Audio Track.

Method resolution order:: PyAudioTrack; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

copy_to_media_panel(...): copy_to_media_panel( (PyAudioTrack)arg1, (PyArchiveEntry)destination [, (str)duplicate_action='add']) -> object : Create a new clip with a copy of the PyObject.

Read-only properties defined here:

channels: Return a list of the Audio Track's channels.

stereo: Return whether or not the Audio Track is stereo.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyBatch(PyFlameObject)

Class derived from PyFlameObject. This class represents a Batch Group.

Method resolution order:: PyBatch; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

append_setup(...): append_setup( (PyBatch)arg1, (str)setup_path [, (bool)confirm=True]) -> bool : Append a Batch setup file to the existing Batch setup. Keywords arguments: setup_path -- A path and a filename must be defined as arguments. confirm -- Set to True (default) to display a dialogue box in case of

append_to_batch(...): append_to_batch( (PyBatch)arg1, (PyBatchIteration)batch_iteration) -> bool : Append a Batch Iteration object to the current Batch Group. A duplicate Batch Iteration object is renamed to the next available *vDD*. Batch Iteration objects are displayed in the Iterations folder. Iterations folder is a UI construction, not accessible directly.

append_to_setup(...): append_to_setup( (PyBatch)arg1, (PyBatchIteration)batch_iteration) -> bool : Append a Batch Iteration object to the Batch Group's setup.

clear(...): clear( (PyBatch)arg1 [, (bool)confirm=True]) -> bool : Clear the Batch Group.

clear_all_contexts(...): clear_all_contexts( (PyBatch)arg1) -> bool : Clear all registered Context views in the Batch Group.

clear_colour(...): clear_colour( (PyBatch)arg1, (int)index) -> bool : Clear the colour of the the Batch Group.

clear_context(...): clear_context( (PyBatch)arg1, (int)index) -> bool : Clear a specific Context view in the Batch Group.

clear_setup(...): clear_setup( (PyBatch)arg1) -> bool : Clear the Batch Group's setup.

close(...): close( (PyBatch)arg1) -> bool : Close the Batch Group. You cannot close the Batch Group currently selected. Closing a Batch Group frees up the application it occupies when open. The size of the used memory is significant if in Batch Group schematic hosts many Action nodes with textures or 3D geoms.

connect_nodes(...): connect_nodes( (PyBatch)arg1, (PyNode)output_node, (str)output_socket_name='Default', (PyNode)input_node [, (str)input_socket_name='Default']) -> bool : Connect two nodes in the Batch schematic. Keyword arguments: output_node -- The Batch node object, the origin of the connection. output_socket_name -- The name of the output socket where the connector starts; use *Default* to use the first output socket, usually *Result*. input_node -- The child Batch node object, the target of the connection. input_socket_name -- The name of the input socket where the connector ends; use *Default* to use the first input socket, usually *Front*. Using *Default* on an Action node connects to the Background socket. To connect to an Action media node, use <ActionNode>.media_nodes[].

create_batch_group(...): create_batch_group( (PyBatch)arg1, (str)name [, (int)nb_reels=4 [, (int)nb_shelf_reels=1 [, (list)reels=[] [, (list)shelf_reels=[] [, (int)start_frame=1 [, (object)duration=None]]]]]]) -> object : Create a new Batch Group object in the Desktop catalogue. Keyword arguments: name -- Name of the Batch Group. nb_reels -- Number of reels created. *reels* overrides *nb_reels*. nb_shelf_reels -- Number of shelf reels. The first shelf reel created is named Batch Renders. *shelf_reels* ovverides *nb_shelf_reels*. reels -- A list of reel names. Overrides *nb_reels*. shelf_reels -- A list of shelf reel names. Overrides *nb_shelf_reels*. start_frame -- The Batch Group's start frame. No timecodes, only a frame value. duration -- The number of frames. Sets the Duration field in the Batch UI. Will be set to the first clip duration when not specified.

create_node(...): create_node( (PyBatch)arg1, (str)node_type [, (str)file_path='']) -> object : Create a Batch node object in the Batch schematic. Keyword argument: node_type -- Must be a value from the PyBatch.node_types.

create_reel(...): create_reel( (PyBatch)arg1, (str)name) -> object : Create a new Schematic Reel in the Batch Gtroup.

create_shelf_reel(...): create_shelf_reel( (PyBatch)arg1, (str)name) -> object : Create a new Shelf Reel in the Batch Group.

disconnect_node(...): disconnect_node( (PyBatch)arg1, (PyNode)node [, (str)input_socket_name='']) -> bool : Disconnect the input links of a given node, given an input socket. Keyword arguments: node -- The Batch node object, the origin of the connection. input_socket_name -- The name of the input socket to disconnect.

encompass_nodes(...): encompass_nodes( (PyBatch)arg1, (list)nodes) -> object : Create a Compass around a list of nodes in the Batch schematic. Keyword argument: nodes -- List of strings of node names.

frame_all(...): frame_all( (PyBatch)arg1) -> bool : Set the Batch schematic view to frame all the nodes in the Batch schematic.

frame_selected(...): frame_selected( (PyBatch)arg1) -> bool : Set the Batch schematic view to frame the nodes selected in the Batch schematic.

get_node(...): get_node( (PyBatch)arg1, (str)node_name) -> object : Return a Batch node object with a name matching the parameter. Every node in a Batch schematic has a unique name: no duplicates allowed. Keyword argument: node_name -- Node name.

go_to(...): go_to( (PyBatch)arg1) -> bool : Display and set the Batch tab as the active environment.

import_clip(...): import_clip( (PyBatch)arg1, (str)file_path, (str)reel_name) -> object : Import a clip using the Import node, and create a Clip node. Keyword arguments: file_path -- The path to the media can be: - A path to a single media file. - A path to a sequence of media files (ie "/dir/clip.[100-2000].dpx"). - A pattern to media files (ie "/dir/name_v{version}.{frame}.{extension}").reel_name -- The name of the destination Schematic Reel.

import_clips(...): import_clips( (PyBatch)arg1, (object)file_paths, (str)reel_name) -> object : Import clips using the Import node, and then create Clip nodes in the Schematic Reel. Keyword arguments: file_paths -- A path, or a list of paths, to the media that can be: - A path to a single media file. - A path to a sequence of media files (ie "/dir/clip.[100-2000].dpx"). - A pattern to media files (ie "/dir/name_v{version}.{frame}.{extension}").reel_name -- The name of the destination Schematic Reel.

iterate(...): iterate( (PyBatch)arg1 [, (int)index=-1]) -> object : Iterate the current Batch Setup, creating a new iteration named BatchSetupName_X, where X is the Batch Iteration's index, and starts at 001. Keyword argument: index -- Specifies the iteration's index. If none is specified, the iteration is assigned the next available index (max index + 1). If the index matches that of an existing Batch Iteration, its overwrites the iteration without warning.

load_setup(...): load_setup( (PyBatch)arg1, (str)setup_path) -> bool : Load a Batch setup from disk and replace the current Batch Group's setup. Keyword argument: setup_path -- Filepath + Batch Setup filename.

mimic_link(...): mimic_link( (PyBatch)arg1, (PyNode)leader_node, (PyNode)follower_node) -> bool : Create a Mimic Link between two Batch nodes. They must be of the same node_type. Keyword arguments: leader_node -- The node being mimicked. follower_node -- The node doing the mimicking.

open(...): open( (PyBatch)arg1) -> bool : Open the Batch Group and display it in the Batch view.

open_as_batch_group(...): open_as_batch_group( (PyBatch)arg1 [, (bool)confirm=True]) -> bool : Open a Batch Group as a new Batch Group, adding it to PyDesktop.batch_groups. Can only be called from a Library.

organize(...): organize( (PyBatch)arg1) -> bool : Clean up the nodes layout in the Batch schematic.

render(...): render( (PyBatch)arg1 [, (str)render_option='Foreground' [, (bool)generate_proxies=False [, (bool)include_history=False]]]) -> bool : Trigger the rendering of the Batch Group setup. Every active Render and Write File nodes render. If specified render_option is not supported by the workstation, returns an error. Keyword arguments: render_option -- Defines the rendering method used. (Foreground, Background Reactor, Burn) generate_proxies -- Set to True to render at proxy resolution. (Default: False) include_history -- Set to True to create History with the rendering. (Default:False)

replace_setup(...): replace_setup( (PyBatch)arg1, (PyBatchIteration)batch_iteration [, (bool)confirm=True]) -> bool : Replace the Batch Group setup with the specified Batch Iteration. Cannot be called on the Batch Group currently selected and displayed in the Batch view.

save(...): save( (PyBatch)arg1) -> object : Save the Batch Group to the location defined by PyDesktop.destination.

save_current_iteration(...): save_current_iteration( (PyBatch)arg1) -> object : Save the current Batch Group setup to the location defined by PyDesktop.destination.

save_setup(...): save_setup( (PyBatch)arg1, (str)setup_path) -> bool : Save the Batch Group setup to disk. Includes media paths for clip node object, but not the media files themselves. Keyword argument: setup_path -- The filepath includes the filename. File extension must be .batch.

select_nodes(...): select_nodes( (PyBatch)arg1, (object)nodes) -> bool : Select nodes. Keyword argument: nodes -- A list of the names of Batch node objects.

set_viewport_layout(...): set_viewport_layout( (PyBatch)arg1, (object)num_views) -> bool : Set the viewport layout for Batch. Keyword argument: num_views -- The layout used. (1-Up, 2-Up, 3-Up, 3-Up Split Top, 3-Up Split Left, 3-Up Split Right, 3-Up Split Bottom, 4-Up Split, 4-Up)

Read-only properties defined here:

batch_iterations: Return a list of Batch Iteration objects of the Batch Group.

contexts: Return a dictionary of Context views registered in the Batch Group. Dictionary {key:value} -- {Context ID : {Batch node name:socket name} }

current_iteration: Return the current Batch Iteration object of the Batch Group.

current_iteration_number: Return the iteration number of the current Batch Iteration.

cursor_position: Return a tuple that provides the cursor position in the Batch Schematic.

node_types: Return a list of the names of the Batch node types available to the Batch schematic.

nodes: Return the list of Batch node objects from the Batch schematic.

opened: Return True if the Batch Group is loaded in memory.

reels: Return the list of reel objects (as Schematic Reels) for the Batch Group.

shelf_reels: Return the list of reel objects (as Shelf Reels) for the Batch Group.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyBatchIteration(PyArchiveEntry)

Class derived from PyArchiveEntry. This class represents a Batch Iteration.

Method resolution order:: PyBatchIteration; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

open_as_batch_group(...): open_as_batch_group( (PyBatchIteration)arg1 [, (bool)confirm=True]) -> bool : Open a Batch Iteration as a new Batch Group, adding it to PyDesktop.batch_groups. Can only be called from a Library.

Read-only properties defined here:

iteration_number: Return the iteration number of the Batch Iteration.

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyBrowser( )

This class represents the file browser.

Method resolution order:: PyBrowser

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

show(...): show( (PyBrowser)arg1, (str)default_path [, (object)extension='' [, (bool)select_directory=False [, (bool)multi_selection=False [, (object)include_resolution=False [, (str)title='Load']]]]]) -> None : Show the file browser.Keyword arguments: default_path -- Set the path. extension -- Set the extension filter. Can be a single extension or a list of extensions. Leave empty to see all files. select_directory -- Only show directories. multi_selection -- Allow the user to select multiple files. include_resolution -- Display the resolution controls. Possible values are False, True, or "Full". The Full mode includes the new adaptive and scaling presets modes. title -- Set the window title.

Read-only properties defined here:

bit_depth: Return the bit depth.

colour_space: Return the colour space.

frame_ratio: Return the frame ratio. Returns None when resolution is set to Same As Source.

height: Return the height. Returns None when resolution is set to Same As Source.

resize_filter: Return the resize filter.

resize_mode: Return the resize mode.

resolution: Return the name of the resolution preset.

scaling_presets_value: Return the scaling presets value. Returns None when resolution is not set to Scaling Presets.

scan_mode: Return the scan mode.

selection: Get the selected files/directories.

sequence_mode: Return the sequence mode.

width: Return the width. Returns None when resolution is set to Same As Source.

class PyClip(PyArchiveEntry)

CLass derived from PyArchiveEntry. This class represents a Clip.

Method resolution order:: PyClip; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

cache_media(...): cache_media( (PyClip)arg1 [, (str)mode='current']) -> bool : Cache the Clip's linked media. Keyword argument: mode -- Determine the version to cache (currently selected or all versions). All Versions is only useful with to multi-version clips (Current, All Versions)

change_dominance(...): change_dominance( (PyClip)arg1, (str)scan_mode) -> None : Change the Clip's dominance. Changes only the clip's metadata. Keyword argument: scan_mode -- Field dominance. (P, F1, F2)

change_start_frame(...): change_start_frame( (PyClip)arg1, (int)start_frame [, (bool)use_segment_connections=True]) -> None : Modify the start frame of a source Clip. Keywords argument: start_frame -- New start frame of the clip. use_segment_connections -- Sync the start frame of connected segments.

close_container(...): close_container( (PyClip)arg1) -> None : Close the container timeline if the Clip is inside a container.

create_marker(...): create_marker( (PyClip)arg1, (object)location) -> object : Add a Marker to the Clip.Keyword argument: location -- The frame where the marker gets created.

cut(...): cut( (PyClip)arg1, (PyTime)cut_time) -> None : Cut all tracks of the Clip.

flush_cache_media(...): flush_cache_media( (PyClip)arg1 [, (str)mode='current']) -> bool : Flush the Clip's media cache. Keyword argument: mode -- Determine the version's cache to flush. (Current, All Versions, All But Current)

flush_renders(...): flush_renders( (PyClip)arg1) -> None : Flush the Clip's TimelineFX renders.

get_colour_space(...): get_colour_space( (PyClip)arg1 [, (PyTime)time=None]) -> str : Return the colour space at the requested time. Use current_time when no time is supplied.

is_rendered(...): is_rendered( (PyClip)arg1 [, (bool)top_only=False [, (str)render_quality='Full Resolution']]) -> bool : Return if a Clip is rendered. The following attributes can be defined: top_only, render_quality.

open_as_sequence(...): open_as_sequence( (PyClip)arg1) -> object : Open the Clip as a Sequence. Mutates the PyClip object into a PySequence object.

open_container(...): open_container( (PyClip)arg1) -> bool : Open the container timeline if the Clip is inside a container.

reformat(...): reformat( (PyClip)arg1 [, (int)width=0 [, (int)height=0 [, (float)ratio=0.0 [, (int)bit_depth=0 [, (str)scan_mode='' [, (str)frame_rate='' [, (str)resize_mode='Letterbox']]]]]]]) -> None : Reformat the Clip to the specified format. Keywords arguments: width -- Integer between 24 and 16384. height -- Integer between 24 and 16384. ratio -- Frame aspect ratio. Float between 0.01 and 100. bit_depth -- Bit depth. (8, 10, 12, 16 or 32) scan_mode -- Scan mode of the sequence. (F1, F2, P) frame_rate -- Frame rate. (60 fps, 59.54 NDF, 59.94 DF, 50 fps, 30 fps, 29.97 NDF, 29.97 DF, 25 fps, 24 fps, 23.976 fps) resize_mode -- Resize mode. (Letterbox, Crop Edges, Fill, Centre)

render(...): render( (PyClip)arg1 [, (str)render_mode='All' [, (str)render_option='Foreground' [, (str)render_quality='Full Resolution' [, (str)effect_type='' [, (str)effect_caching_mode='Current' [, (bool)include_handles=False]]]]]]) -> bool : Trigger a render of the Clip The following attributes can be defined: render_mode, render_option, render_quality, effect_type, effect_caching_mode and include_handles.

save(...): save( (PyClip)arg1) -> bool : Save the Clip to the defined save destination.

Read-only properties defined here:

archive_date: Return the Clip's last archive date.

archive_error: Return the Clip's last archive error.

audio_tracks: Return a list of the Clip's Audio Tracks.

bit_depth: Return the Clip's bit depth.

cached: Return the Clip's cache status.

colour_primaries: Deduce the Clip's 'colour primaries' export attribute.

creation_date: Return the Clip's creation date.

duration: Return the Clip's duration.

essence_uid: Return the Clip's essence uid.

frame_rate: Return the Clip's frame rate.

has_deliverables: Return the existence of deliverables on the Clip.

has_history: Return the existence of history inside the Clip.

height: Return the Clip's height.

markers: Return a list of the Clip's Markers.

matrix_coefficients: Deduce the Clip's 'matrix coefficients' export attribute.

original_source_uid: Return the Clip's original source UID.

proxy_resolution: Return the Clip's proxy resolution if it has proxies.

ratio: Return the Clip's frame ratio.

sample_rate: Return the Clip's audio sample rate.

scan_mode: Return the Clip's scan mode.

source_uid: Return the Clip's source uid.

start_frame: Return the Clip's start frame.

subtitles: Return a list of the Clip's Subtitles Tracks.

transfer_characteristics: Deduce the Clip's 'transfer characteristics' export attribute.

unlinked: Return the Clip's unlinked status.

versions: Return a list of the Clip's versions.

width: Return the Clip's width.

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyClipNode(PyNode)

Class derived from PyNode. This class represents a Clip node.

Method resolution order:: PyClipNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

clip: The associated PyClip or PySequence of the clip node.

colour_space: The clip colour space at current frame for primary output.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyCoCameraAnalysis(PyCoNode)

Class derived from PyCoNode. This class represents the camera analysis node in the Action schematic.

Method resolution order:: PyCoCameraAnalysis; PyCoNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

analyseRange(...): analyseRange( (PyCoCameraAnalysis)arg1, (object)arg2, (object)start) -> bool : Run the analysis for the given frame range using the first frame as a reference if none has been already set.

resetAnalysis(...): resetAnalysis( (PyCoCameraAnalysis)arg1) -> bool : Reset the current analysis.

Static methods inherited from PyCoNode:

add_reference(...): add_reference( (PyCoNode)arg1, (object)frame) -> bool : Add a Motion Warp map's reference frame at specified index. Keyword argument frame -- The reference frame's index. An integer.

assign_media(...): assign_media( (PyCoNode)arg1, (object)media_name) -> bool : Assign a media layer to the node. Keyword argument media_name -- The index of the media layer from Actions' *media_layers*; or the name of the media layer.

cache_range(...): cache_range( (PyCoNode)arg1, (object)arg2, (object)start) -> bool : Cache the selected Map Analysis over the specified range. Keyword arguments start -- The first frame of the range. An integer. end -- The last frame of the range. An integer.

children(...): children( (PyCoNode)arg1 [, (str)link_type='Default']) -> list : Return a list of PyCoNode objects that are the children of the action node. Keyword argument: link_type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

parents(...): parents( (PyCoNode)arg1 [, (str)link_type='Default']) -> list : Return a list of PyCoNode objects that are the parents of the action node. Keyword argument: link_type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

Read-only properties inherited from PyCoNode:

type: Return the type of the Action node.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyCoCompass(PyCoNode)

Class derived from PyCoNode. This class represents the compass node in the Action schematic.

Method resolution order:: PyCoCompass; PyCoNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

nodes: Return a list of PyCoNode objects enclosed by the Compass node.

Static methods inherited from PyCoNode:

add_reference(...): add_reference( (PyCoNode)arg1, (object)frame) -> bool : Add a Motion Warp map's reference frame at specified index. Keyword argument frame -- The reference frame's index. An integer.

assign_media(...): assign_media( (PyCoNode)arg1, (object)media_name) -> bool : Assign a media layer to the node. Keyword argument media_name -- The index of the media layer from Actions' *media_layers*; or the name of the media layer.

cache_range(...): cache_range( (PyCoNode)arg1, (object)arg2, (object)start) -> bool : Cache the selected Map Analysis over the specified range. Keyword arguments start -- The first frame of the range. An integer. end -- The last frame of the range. An integer.

children(...): children( (PyCoNode)arg1 [, (str)link_type='Default']) -> list : Return a list of PyCoNode objects that are the children of the action node. Keyword argument: link_type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

parents(...): parents( (PyCoNode)arg1 [, (str)link_type='Default']) -> list : Return a list of PyCoNode objects that are the parents of the action node. Keyword argument: link_type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

Read-only properties inherited from PyCoNode:

type: Return the type of the Action node.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyCoNode(PyFlameObject)

Class derived from PyFlameObject. This class represents an Action node in the Action schematic.

Method resolution order:: PyCoNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

add_reference(...): add_reference( (PyCoNode)arg1, (object)frame) -> bool : Add a Motion Warp map's reference frame at specified index. Keyword argument frame -- The reference frame's index. An integer.

assign_media(...): assign_media( (PyCoNode)arg1, (object)media_name) -> bool : Assign a media layer to the node. Keyword argument media_name -- The index of the media layer from Actions' *media_layers*; or the name of the media layer.

cache_range(...): cache_range( (PyCoNode)arg1, (object)arg2, (object)start) -> bool : Cache the selected Map Analysis over the specified range. Keyword arguments start -- The first frame of the range. An integer. end -- The last frame of the range. An integer.

children(...): children( (PyCoNode)arg1 [, (str)link_type='Default']) -> list : Return a list of PyCoNode objects that are the children of the action node. Keyword argument: link_type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

parents(...): parents( (PyCoNode)arg1 [, (str)link_type='Default']) -> list : Return a list of PyCoNode objects that are the parents of the action node. Keyword argument: link_type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

Read-only properties defined here:

type: Return the type of the Action node.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyCompassNode(PyNode)

Class derived from PyNode. This class represents a Compass node.

Method resolution order:: PyCompassNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

nodes: Return a list of PyNode objects enclosed by the Compass node.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyDesktop(PyArchiveEntry)

Class derived from PyArchiveEntry. This class represents a Desktop.

Method resolution order:: PyDesktop; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

clear(...): clear( (PyDesktop)arg1) -> bool : Clear the Desktop.

create_batch_group(...): create_batch_group( (PyDesktop)arg1, (str)name [, (int)nb_reels=4 [, (int)nb_shelf_reels=1 [, (list)reels=[] [, (list)shelf_reels=[] [, (int)start_frame=1 [, (object)duration=None]]]]]]) -> object : Create a new Batch Group object in the Desktop catalogue. Keyword arguments: name -- Name of the Batch Group. nb_reels -- Number of reels created. *reels* overrides *nb_reels*. nb_shelf_reels -- Number of shelf reels. The first shelf reel created is named Batch Renders. *shelf_reels* ovverides *nb_shelf_reels*. reels -- A list of reel names. Overrides *nb_reels*. shelf_reels -- A list of shelf reel names. Overrides *nb_shelf_reels*. start_frame -- The Batch Group's start frame. No timecodes, only a frame value. duration -- The number of frames. Sets the Duration field in the Batch UI. Will be set to the first clip duration when not specified.

create_reel_group(...): create_reel_group( (PyDesktop)arg1, (str)name) -> object : Create a new Reel Group object in the Desktop catalogue.

save(...): save( (PyDesktop)arg1) -> bool : Save the Desktop to the location defined by the *destination* attribute.

Read-only properties defined here:

batch_groups: Return a list of Batch Group objects that are immediate children of the current object.

children: Return a list of the immediate children of the current object.

reel_groups: Return a list of Reel Group objects that are immediate children of the current object..

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyExporter( )

Object holding export settings.

Method resolution order:: PyExporter

Static methods defined here:

__init__(...): __init__( (object)arg1) -> None

__reduce__ = (...)

export(...): export( (PyExporter)arg1, (object)sources, (str)preset_path, (str)output_directory [, (BackgroundJobSettings)background_job_settings=None [, (object)hooks=None [, (object)hooks_user_data=None]]]) -> None : Perform export. Keyword arguments: sources -- Flame clip object, a Flame container object or a list of either first. If a container is passed, a multi-export will be done and structure will be respected as much as possible. preset_path -- Absolute path to the export preset to use. output_directory -- Absolute path to the output directory root. background_job_settings -- Settings of background job(s) created if any. hooks -- Export python hooks override. If passed, regular export python hooks implemented in exportHooks.py will be bypassed for this export and methods in the passed object with matching name will be called. Instance of object passed should implement the following signature: class PythonHookOverride(object): def preExport(self, info, userData, *args, **kwargs) pass def postExport(self, info, userData, *args, **kwargs): pass def preExportSequence(self, info, userData, *args, **kwargs): pass def postExportSequence(self, info, userData, *args, **kwargs): pass def preExportAsset(self, info, userData, *args, **kwargs): pass def postExportAsset(self, info, userData, *args, **kwargs): pass def exportOverwriteFile(self, path, *args, **kwargs): return "ask" # or "overwrite" hooks_user_data -- User data object passed to the export python hooks. This object can be modified by the PythonHookOverride methods but cannot be re-assigned

get_presets_base_dir(...): get_presets_base_dir( (PresetVisibility)preset_visibility) -> str : Get a presets base directory.

get_presets_dir(...): get_presets_dir( (PresetVisibility)preset_visibility, (PresetType)preset_type) -> str : Get a presets directory.

Data descriptors defined here:

export_all_subtitles: Set export option 'All Subtitles Tracks'.

export_between_marks: Set export option 'Export between marks'.

export_subtitles_as_files: Set subtitles export option 'Export As Files.

foreground: Set export option 'Foreground export'.

include_subtitles: Set export option 'Include Subtitles'.

keep_timeline_fx_renders: Set export option 'Keep Timeline FX Renders'.

use_top_video_track: Set export option 'Use top video track'.

warn_on_link_unsupported: Set export option 'Warn on link unsupported'.

warn_on_mixed_colour_space: Set export option 'Warn on mixed colour space'.

warn_on_no_media: Set export option 'Warn on no media'.

warn_on_pending_render: Set export option 'Warn on pending render'.

warn_on_reimport_unsupported: Set export option 'Warn on reimport unsupported'.

warn_on_unlinked: Set export option 'Warn on unlinked'.

warn_on_unrendered: Set export option 'Warn on unrendered'.

Data and other attributes defined here:

Audio = flame.PresetType.Audio

Autodesk = flame.PresetVisibility.Autodesk

BackgroundJobSettings = <class 'flame.BackgroundJobSettings'>: Object holding background export job settings. These settings refer to the Backburner job, server and manager.

Distribution_Package = flame.PresetType.Distribution_Package

Image_Sequence = flame.PresetType.Image_Sequence

Movie = flame.PresetType.Movie

PresetType = <class 'flame.PresetType'>

PresetVisibility = <class 'flame.PresetVisibility'>

Project = flame.PresetVisibility.Project

Sequence_Publish = flame.PresetType.Sequence_Publish

Shared = flame.PresetVisibility.Shared

Shotgun = flame.PresetVisibility.Shotgun

__instance_size__ = 32

class PyFlameObject( )

The basic type of all accessible Flame objects from the python API.

Method resolution order:: PyFlameObject

Static methods defined here:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties defined here:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyFolder(PyArchiveEntry)

Class derived from PyArchiveEntry. This class represents a Folder.

Method resolution order:: PyFolder; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

clear(...): clear( (PyFolder)arg1 [, (bool)confirm=True]) -> bool : Clear the contents of the Folder object.

create_folder(...): create_folder( (PyFolder)arg1, (str)name) -> object : Create a new Folder object inside the Folder.

create_reel(...): create_reel( (PyFolder)arg1, (str)name) -> object : Create a new Reel object inside the Folder.

create_reel_group(...): create_reel_group( (PyFolder)arg1, (str)name) -> object : Create a new Reel Group object inside the Folder.

create_sequence(...): create_sequence( (PyFolder)arg1 [, (str)name='Untitled Sequence' [, (int)video_tracks=1 [, (bool)video_stereo=False [, (int)width=1920 [, (int)height=1080 [, (float)ratio=1.7777777777777777 [, (int)bit_depth=8 [, (str)scan_mode='P' [, (str)frame_rate='29.97 fps NDF' [, (object)start_at=00:00:00:00 [, (object)duration=00:00:00:01 [, (int)audio_tracks=1 [, (bool)audio_stereo=True]]]]]]]]]]]]]) -> object : Create a Sequence in a PyReel, PyLibrary, PyFolder. Keywords arguments: video_tracks -- Number of video tracks. Integer between 1 and 8. video_stereo -- Stereoscopy. False for mono, True for stereo. width -- Integer between 24 and 16384. height -- Integer between 24 and 16384. ratio -- Frame aspect ratio. Float between 0.01 and 100. scan_mode -- Scan mode of the sequence. (F1, F2, P) frame_rate -- Frame rate. (60 fps, 59.54 NDF, 59.94 DF, 50 fps, 30 fps, 29.97 NDF, 29.97 DF, 25 fps, 24 fps, 23.976 fps) start_at -- Start timecode. The timecode format must be of the format specified by *frame_rate*. duration -- Can be an end timecode or an integer. If an end timecode, format must be of the format specified by *frame_rate*. If an integer, it represents a number of frames. audio_tracks -- Number of audio tracks. (0, 1, 2, 4, 8, 12, 16) audio_stereo -- Stereophony, apply to all *audio_tracks*. False for mono tracks, True for stereo.

Read-only properties defined here:

batch_groups: Return a list of Batch Group objects that are immediate children of the current object.

batch_iterations: Return a list of Batch Iteration objects that are immediate children of the current object.

children: Return a list of the immediate children of the current object.

clips: Return a list of Clip objects that are immediate children of the current object.

desktops: Return a list Desktop objects that are immediate children of the current object.

folders: Return a list of the Folder objects that are immediate children of the current object.

reel_groups: Return a list of Reel Group objects that are immediate children of the current object..

reels: Return a list of Reel objects that are immediate children of the current object.

sequences: Return a list of Sequence objects that are immediate children of the current object.

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyGMaskTracerNode(PyActionFamilyNode)

Class derived from PyActionFamilyNode. Represents a GMask Tracer node object.

Method resolution order:: PyGMaskTracerNode; PyActionFamilyNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

disable_output(...): disable_output( (PyActionFamilyNode)arg1, (str)output_type) -> bool : Disable the render output_type for the GMask Tracer node. Keyword argument: output_type -- The output to enable. (Comp, Matte, 3D Motion, Albedo, AO, Background, Emissive, GMask, Lens Flare, Motion Vectors, Normals, Object ID, Occluder, Position, Projectors Matte, Reflection, Roughness, Shadow, Specular, UV, Z-Depth HQ, Z-Depth)

enable_output(...): enable_output( (PyActionFamilyNode)arg1, (str)output_type) -> bool : Enable the render output_type for the GMask Tracer node. Keyword argument: output_type -- The output to enable. (Comp, Matte, 3D Motion, Albedo, AO, Background, Emissive, GMask, Lens Flare, Motion Vectors, Normals, Object ID, Occluder, Position, Projectoars Matte, Reflection, Roughness, Shadow, Specular, UV, Z-Depth HQ, Z-Depth)

export_fbx(...): export_fbx( (PyActionFamilyNode)arg1, (str)file_path [, (bool)only_selected_nodes=False [, (float)pixel_to_units=0.10000000149011612 [, (str)frame_rate='23.976 fps' [, (bool)bake_animation=False [, (bool)export_axes=True [, (bool)export_point_locators=False [, (bool)combine_material=True [, (bool)duplicate_material=False]]]]]]]]) -> bool : Export GMask Tracer nodes to an FBX file. Keyword argument: file_path -- Path to the output FBX file. Mandatory.

import_abc(...): import_abc( (PyActionFamilyNode)arg1, (str)file_path [, (bool)lights=True [, (bool)cameras=True [, (bool)models=True [, (bool)normals=True [, (bool)mesh_animations=True [, (str)frame_rate='23.976 fps' [, (bool)auto_fit=False [, (float)unit_to_pixels=10.0 [, (bool)consolidate_geometry=True [, (bool)create_object_group=False]]]]]]]]]]) -> list : Import an Alembic (ABC) file into the GMask Tracer schematic using the GMask Tracer Objects mode. Keyword argument: file_path -- Path to the ABC file. Mandatory.

import_fbx(...): import_fbx( (PyActionFamilyNode)arg1, (str)file_path [, (bool)lights=True [, (bool)cameras=True [, (bool)models=True [, (bool)normals=True [, (bool)mesh_animations=True [, (bool)keep_frame_rate=True [, (bool)bake_animation=False [, (bool)object_properties=True [, (bool)auto_fit=False [, (float)unit_to_pixels=10.0 [, (bool)create_media=True [, (bool)is_udim=False [, (bool)relink_material=True]]]]]]]]]]]]]) -> list : Import an FBX file into the GMask Tracer schematic using the GMask Tracer Objects mode. Keyword argument: file_path -- Path to the FBX file. Mandatory.

read_abc(...): read_abc( (PyActionFamilyNode)arg1, (str)file_path [, (bool)lights=True [, (bool)cameras=True [, (bool)models=True [, (bool)normals=True [, (bool)mesh_animations=True [, (str)frame_rate='23.976 fps' [, (bool)auto_fit=False [, (float)unit_to_pixels=10.0 [, (bool)consolidate_geometry=True [, (bool)create_object_group=False]]]]]]]]]]) -> object : Import an Alembic (ABC) file into the GMask Tracer schematic using the Read File mode. Keyword argument: file_path -- Path to the ABC file. Mandatory.

read_fbx(...): read_fbx( (PyActionFamilyNode)arg1, (str)file_path [, (bool)lights=True [, (bool)cameras=True [, (bool)models=True [, (bool)normals=True [, (bool)mesh_animations=True [, (bool)keep_frame_rate=True [, (bool)bake_animation=False [, (bool)object_properties=True [, (bool)auto_fit=False [, (float)unit_to_pixels=10.0 [, (bool)is_udim=False [, (bool)relink_material=True]]]]]]]]]]]]) -> object : Import an FBX file into the GMask Tracer schematic using the Read File mode. Keyword argument: file_path -- Path to the FBX file. Mandatory.

Read-only properties defined here:

output_types: Return a list of the output types available to the GMask Tracer node.

Static methods inherited from PyActionFamilyNode:

clear_schematic(...): clear_schematic( (PyActionFamilyNode)arg1) -> bool : Clear the Action/Image/GMaskTracer schematic of all nodes.

connect_nodes(...): connect_nodes( (PyActionFamilyNode)arg1, (PyFlameObject)parent_node, (PyFlameObject)child_node [, (str)link_type='Default']) -> bool : Connect two nodes in the Action/Image/GMaskTracer schematic. Keyword argument: type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

create_node(...): create_node( (PyActionFamilyNode)arg1, (str)node_type [, (str)file_path='' [, (bool)is_udim=False [, (int)tile_resolution=0]]]) -> object : Add an Action/Image/GMaskTracer object node to the Action/Image/GMaskTracer schematic. Keyword argument: file_path -- Required by nodes that load an asset, such as Matchbox.

disconnect_nodes(...): disconnect_nodes( (PyActionFamilyNode)arg1, (PyFlameObject)parent_node, (PyFlameObject)child_node [, (str)link_type='Default']) -> bool : Disconnect two nodes in the Action/Image/GMaskTracer schematic. Keyword argument: type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

encompass_nodes(...): encompass_nodes( (PyActionFamilyNode)arg1, (list)node_list) -> object : Create a compass including the node list given as argument Keyword argument: node_list -- a list of nodes (either string or node objects) output_type -- the created compass node

get_node(...): get_node( (PyActionFamilyNode)arg1, (str)node_name) -> object : Get a node by node name. Doesn't select it in the UI.

organize(...): organize( (PyActionFamilyNode)arg1) -> bool : Clean up the Action/Image/GMaskTracer schematic.

Read-only properties inherited from PyActionFamilyNode:

all_tabs: Return a list of the object tabs.

cursor_position: Return a tuple that provides the cursor position in the Action/Image/GMaskTracer schematic.

left_tabs: Return a list of the object left tabs.

media_layers: Return a list of the Media layers of the Action/Image/GMaskTracer node.

node_types: Return a list of the node types available in the Action/Image/GMaskTracer schematic.

nodes: Return a list of Action/Image/GMaskTracer nodes used in the the Action/Image/GMaskTracer schematic.

right_tabs: Return a list of the object right tabs.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyHDRNode(PyNode)

Object representing a HDR node.

Method resolution order:: PyHDRNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

analyze(...): analyze( (PyHDRNode)arg1 [, (str)analyze_mode='Current Shot']) -> None : Perform HDR analysis.

export_DolbyVision_xml(...): export_DolbyVision_xml( (PyHDRNode)arg1, (str)file_name [, (str)comment='']) -> None : Export the current HDR to a Dolby Vision XML file.

has_trim(...): has_trim( (PyHDRNode)arg1, (int)target_display_id) -> bool : Returns True if the given Target Display ID has trims.

import_DolbyVision_xml(...): import_DolbyVision_xml( (PyHDRNode)arg1, (str)file_name [, (str)mode='Include Frame Based Transitions Trims' [, (int)shot_idx=0]]) -> None : Import the current HDR from a Dolby Vision XML file.

interpolate_trims(...): interpolate_trims( (PyHDRNode)arg1) -> None : Interpolate the current HDR trims.

keep_analysis(...): keep_analysis( (PyHDRNode)arg1) -> None : Remove the dirty flag from the HDR analysis.

l2_from_l8(...): l2_from_l8( (PyHDRNode)arg1) -> object : Dictionary containing the L2 values based on L8 values. Not valid in Dolby Vision 2.9.

reset_analysis(...): reset_analysis( (PyHDRNode)arg1) -> None : Reset the current HDR analysis.

reset_trims(...): reset_trims( (PyHDRNode)arg1) -> None : Reset the current HDR trims.

Read-only properties defined here:

analysis_status: Return the current state of the HDR analysis.

mastering_display_ids: List of available Mastering Display Ids.

mastering_display_info: Dictionary containing Mastering Display information. Returned object is a copy.

target_display_ids: List of available Target Display Ids.

target_display_info: Dictionary containing Target Display information. Returned object is a copy.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyHDRTimelineFX(PyTimelineFX)

Object representing a HDR TimelineFX.

Method resolution order:: PyHDRTimelineFX; PyTimelineFX; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

analyze(...): analyze( (PyHDRTimelineFX)arg1 [, (str)analyze_mode='Current Shot']) -> None : Perform HDR analysis.

export_DolbyVision_xml(...): export_DolbyVision_xml( (PyHDRTimelineFX)arg1, (str)file_name [, (bool)shot_only=False [, (str)comment='']]) -> None : Export the current HDR to a Dolby Vision XML file.

has_trim(...): has_trim( (PyHDRTimelineFX)arg1, (int)target_display_id) -> bool : Returns True if the given Target Display ID has trims.

import_DolbyVision_xml(...): import_DolbyVision_xml( (PyHDRTimelineFX)arg1, (str)file_name [, (str)mode='Include Frame Based Transitions Trims' [, (int)shot_idx=0]]) -> None : Import the current HDR from a Dolby Vision XML file.

interpolate_trims(...): interpolate_trims( (PyHDRTimelineFX)arg1, (str)arg2) -> None : Interpolate the current HDR trims.

keep_analysis(...): keep_analysis( (PyHDRTimelineFX)arg1) -> None : Remove the dirty flag from the HDR analysis.

l2_from_l8(...): l2_from_l8( (PyHDRTimelineFX)arg1) -> object : Dictionary containing the L2 values based on L8 values. Not valid in Dolby Vision 2.9.

reset_analysis(...): reset_analysis( (PyHDRTimelineFX)arg1) -> None : Reset the current HDR analysis.

reset_trims(...): reset_trims( (PyHDRTimelineFX)arg1) -> None : Reset the current HDR trims.

Read-only properties defined here:

analysis_status: Return the current state of the HDR analysis.

mastering_display_ids: List of available Mastering Display Ids.

mastering_display_info: Dictionary containing Mastering Display information. Returned object is a copy.

target_display_ids: List of available Target Display Ids.

target_display_info: Dictionary containing Target Display information. Returned object is a copy.

Static methods inherited from PyTimelineFX:

flush_maps_cache_media(...): flush_maps_cache_media( (PyTimelineFX)arg1) -> bool : Flush the Timeline FX Maps and ML cached media.

load_setup(...): load_setup( (PyTimelineFX)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_setup(...): save_setup( (PyTimelineFX)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

slide_keyframes(...): slide_keyframes( (PyTimelineFX)arg1, (float)offset) -> None : Slide the keyframes the PySegment. Keywords argument: offset -- Relative offset to slide the keyframes. sync -- Enable to perform the same operation on the segments that belong to the same sync group as the current PySegment.

sync_connected_segments(...): sync_connected_segments( (PyTimelineFX)arg1) -> None : Push the Timeline FX to connected segments.

Read-only properties inherited from PyTimelineFX:

has_maps_cache_media: Return whether the Timeline FX has Maps or ML cached media.

type: Return the type of the Timeline FX.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyInferenceNode(PyNode)

Object representing an Inference node.

Method resolution order:: PyInferenceNode; PyNode; PyFlameObject

Read-only properties defined here:

model_name: Return the current model name.

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyLensDistortionNode(PyNode)

Object representing a Lens Distortion node.

Method resolution order:: PyLensDistortionNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

import_lens_distortion(...): import_lens_distortion( (PyLensDistortionNode(str)filename) -> None : Import a Lens Distortion file.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyMorphNode(PyNode)

Object representing a Morph node.

Method resolution order:: PyMorphNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

set_mix_to_range(...): set_mix_to_range( (PyMorphNode)arg1) -> None : Move the first and last keyframes of the mix curve to the range's first and last frame.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyImageNode(PyActionFamilyNode)

Class derived from PyActionFamilyNode. Represents an Image node object.

Method resolution order:: PyImageNode; PyActionFamilyNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

add_media(...): add_media( (PyActionFamilyNode)arg1) -> object : Add a Media layer to the Batch Image node.

Read-only properties defined here:

media_nodes: Return a list of the Media nodes attached to the Image node.

Static methods inherited from PyActionFamilyNode:

clear_schematic(...): clear_schematic( (PyActionFamilyNode)arg1) -> bool : Clear the Action/Image/GMaskTracer schematic of all nodes.

connect_nodes(...): connect_nodes( (PyActionFamilyNode)arg1, (PyFlameObject)parent_node, (PyFlameObject)child_node [, (str)link_type='Default']) -> bool : Connect two nodes in the Action/Image/GMaskTracer schematic. Keyword argument: type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

create_node(...): create_node( (PyActionFamilyNode)arg1, (str)node_type [, (str)file_path='' [, (bool)is_udim=False [, (int)tile_resolution=0]]]) -> object : Add an Action/Image/GMaskTracer object node to the Action/Image/GMaskTracer schematic. Keyword argument: file_path -- Required by nodes that load an asset, such as Matchbox.

disconnect_nodes(...): disconnect_nodes( (PyActionFamilyNode)arg1, (PyFlameObject)parent_node, (PyFlameObject)child_node [, (str)link_type='Default']) -> bool : Disconnect two nodes in the Action/Image/GMaskTracer schematic. Keyword argument: type -- The type of link used to connect the nodes (default, look at, gmask, gmask exclusive, light, light exclusive, mimic)

encompass_nodes(...): encompass_nodes( (PyActionFamilyNode)arg1, (list)node_list) -> object : Create a compass including the node list given as argument Keyword argument: node_list -- a list of nodes (either string or node objects) output_type -- the created compass node

get_node(...): get_node( (PyActionFamilyNode)arg1, (str)node_name) -> object : Get a node by node name. Doesn't select it in the UI.

organize(...): organize( (PyActionFamilyNode)arg1) -> bool : Clean up the Action/Image/GMaskTracer schematic.

Read-only properties inherited from PyActionFamilyNode:

all_tabs: Return a list of the object tabs.

cursor_position: Return a tuple that provides the cursor position in the Action/Image/GMaskTracer schematic.

left_tabs: Return a list of the object left tabs.

media_layers: Return a list of the Media layers of the Action/Image/GMaskTracer node.

node_types: Return a list of the node types available in the Action/Image/GMaskTracer schematic.

nodes: Return a list of Action/Image/GMaskTracer nodes used in the the Action/Image/GMaskTracer schematic.

right_tabs: Return a list of the object right tabs.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyLibrary(PyArchiveEntry)

Class derived from PyArchiveEntry. This class represents a Library.

Method resolution order:: PyLibrary; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

acquire_exclusive_access(...): acquire_exclusive_access( (PyLibrary)arg1) -> bool : Acquire exclusive access to the Shared Library. Shared Libraries are created locked. Only use with Shared Libraries.

clear(...): clear( (PyLibrary)arg1 [, (bool)confirm=True]) -> bool : Clear the Library's contents.

close(...): close( (PyLibrary)arg1) -> bool : Close a Library to release it from the application memory.

create_folder(...): create_folder( (PyLibrary)arg1, (str)name) -> object : Create a Folder inside a Library.

create_reel(...): create_reel( (PyLibrary)arg1, (str)name) -> object : Create a Reel inside a Library.

create_reel_group(...): create_reel_group( (PyLibrary)arg1, (str)name) -> object : Create a Reel Group inside a Library.

create_sequence(...): create_sequence( (PyLibrary)arg1 [, (str)name='Untitled Sequence' [, (int)video_tracks=1 [, (bool)video_stereo=False [, (int)width=1920 [, (int)height=1080 [, (float)ratio=1.7777777777777777 [, (int)bit_depth=8 [, (str)scan_mode='P' [, (str)frame_rate='29.97 fps NDF' [, (object)start_at=00:00:00:00 [, (object)duration=00:00:00:01 [, (int)audio_tracks=1 [, (bool)audio_stereo=True]]]]]]]]]]]]]) -> object : Create a Sequence in a PyReel, PyLibrary, PyFolder. Keywords arguments: video_tracks -- Number of video tracks. Integer between 1 and 8. video_stereo -- Stereoscopy. False for mono, True for stereo. width -- Integer between 24 and 16384. height -- Integer between 24 and 16384. ratio -- Frame aspect ratio. Float between 0.01 and 100. scan_mode -- Scan mode of the sequence. (F1, F2, P) frame_rate -- Frame rate. (60 fps, 59.54 NDF, 59.94 DF, 50 fps, 30 fps, 29.97 NDF, 29.97 DF, 25 fps, 24 fps, 23.976 fps) start_at -- Start timecode. The timecode format must be of the format specified by *frame_rate*. duration -- Can be an end timecode or an integer. If an end timecode, format must be of the format specified by *frame_rate*. If an integer, it represents a number of frames. audio_tracks -- Number of audio tracks. (0, 1, 2, 4, 8, 12, 16) audio_stereo -- Stereophony, apply to all *audio_tracks*. False for mono tracks, True for stereo.

open(...): open( (PyLibrary)arg1) -> bool : Open a Library and load it in the application memory. Until a Library is open, it cannot be accessed. Libraries are created open.

release_exclusive_access(...): release_exclusive_access( (PyLibrary)arg1) -> bool : Release exclusive access to the Shared Library. Only used for Shared Libraries. Only use with Shared Libraries.

Read-only properties defined here:

batch_groups: Return a list of Batch Group objects that are immediate children of the current object.

batch_iterations: Return a list of Batch Iteration objects that are immediate children of the current object.

children: Return a list of the immediate children of the current object.

clips: Return a list of Clip objects that are immediate children of the current object.

desktops: Return a list Desktop objects that are immediate children of the current object.

folders: Return a list of the Folder objects that are immediate children of the current object.

opened: Return True if the Library is in the open state.

reel_groups: Return a list of Reel Group objects that are immediate children of the current object..

reels: Return a list of Reel objects that are immediate children of the current object.

sequences: Return a list of Sequence objects that are immediate children of the current object.

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyMarker(PyFlameObject)

Object representing a Marker.

Method resolution order:: PyMarker; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyMediaHub( )

This class represents the MediaHub.

Method resolution order:: PyMediaHub

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Data descriptors defined here:

archives

files

class PyMediaHubFilesEntry(PyArchiveEntry)

Object representing a clip in the MediaHub Files tabs

Method resolution order:: PyMediaHubFilesEntry; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

path: Returns the absolute path of the clip

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyMediaHubFilesFolder(PyArchiveEntry)

Object representing a folder in the MediaHub Files tabs

Method resolution order:: PyMediaHubFilesFolder; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

path: Returns the absolute path of the folder

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyMediaHubFilesTab(PyMediaHubTab)

This class represents the MediaHub Files tab.

Method resolution order:: PyMediaHubFilesTab; PyMediaHubTab

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Data descriptors defined here:

options

Static methods inherited from PyMediaHubTab:

get_path(...): get_path( (PyMediaHubTab)arg1) -> str : Return the MediaHub tab current path.

set_path(...): set_path( (PyMediaHubTab)arg1, (str)arg2 [, (bool)allow_partial_success=False]) -> bool : Set the MediaHub tab current path. If allow_partial_success is True, the path will be set to the last valid folder in the path.

class PyMediaHubFilesTabOptions( )

This class represents the MediaHub Files tab options.

Method resolution order:: PyMediaHubFilesTabOptions

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

set_tagged_colour_space(...): set_tagged_colour_space( (PyMediaHubFilesTabOptions)arg1, (str)colour_space) -> None : Import pixel ratio value. Returns None when resolution is not set to Same As Source.

Data descriptors defined here:

bit_depth: Import bit depth value. Possible values are 8, 10, 12, 16, 32, and From Source.

cache_and_proxies_all_versions: Generate caches and proxies for all versions instead of the current one on import.

cache_mode: Cache media on import.

frame_ratio: Import frame ratio value. Returns None when resolution mode is not set to Resolution List.

height: Import height value. Returns None when resolution is set to Same as Source, Scaling Presets or Adaptive when based on width.

multi_channel_mode: Multi-Channel Mode to use upon import.

pixel_ratio: Import pixel ratio value. Returns None when resolution is not set to Same As Source.

proxies_mode: Generate proxies on import.

resize_filter: Import resizing filter value. Possible values are Lanczos, Shannon, Gaussian, Quadratic, Bicubic, Mitchell, Triangle, and Impulse.

resize_mode: Import resizing mode value. Possible values are Letterbox, Crop Edges, Fill, and Centre.

resolution: Set the resolution based on the name. Possible values are Custom Resolution, Project Res, Adaptive, Scaling Presets, Same as Source or a resolution with this format: HD 720 16:9 (1280 x 720)

scaling_presets_value: Import scaling presets value. Returns None when the resolution selector is not Scaling Presets.

scan_mode: Import scan mode value. Possible values are P, F1, F2, and From Source.

sequence_mode: Use the sequence mode to import a range of files.

width: Import width value. Returns None when resolution is set to Same as Source, Scaling Presets or Adaptive when based on height.

class PyMediaHubProjectsEntry(PyArchiveEntry)

Object representing a clip in the MediaHub Projects tabs

Method resolution order:: PyMediaHubProjectsEntry; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

path: Returns the path of the clip

uid: Returns the Unique ID of the clip

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyMediaHubProjectsFolder(PyArchiveEntry)

Object representing a folder in the MediaHub Projects tabs

Method resolution order:: PyMediaHubProjectsFolder; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

path: Returns the path of the folder

uid: Returns the Unique ID of the folder

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyMediaHubTab( )

This class represents a MediaHub tab.

Method resolution order:: PyMediaHubTab

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

get_path(...): get_path( (PyMediaHubTab)arg1) -> str : Return the MediaHub tab current path.

set_path(...): set_path( (PyMediaHubTab)arg1, (str)arg2 [, (bool)allow_partial_success=False]) -> bool : Set the MediaHub tab current path. If allow_partial_success is True, the path will be set to the last valid folder in the path.

class PyMediaPanel( )

This class represents the media panel.

Method resolution order:: PyMediaPanel

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

copy(...): copy( (PyMediaPanel)arg1, (object)source_entries, (object)destination [, (str)duplicate_action='add']) -> object : Copy a PyObject or a list of PyObjects from the Media Panel to a destination inside the Media Panel.Return a list of the copied PyObjects.Keyword arguments: source_entries -- The PyObject or list of PyObjects to copy. destination -- The PyObject that acts as destination. duplicate_action -- Action to take when finding an object with the same name (add or replace).

move(...): move( (PyMediaPanel)arg1, (object)source_entries, (object)destination [, (str)duplicate_action='add']) -> object : Move a PyObject or a list of PyObjects from the Media Panel to a destination inside the Media Panel. Return a list of the moved PyObjects. Keyword arguments: source_entries -- The PyObject or list of PyObjects to move. destination -- The PyObject that acts as destination. duplicate_action -- Action to take when finding an object with the same name (add or replace).

Data descriptors defined here:

dual: The dual view status of the media panel.

full_height: The full height status of the media panel.

full_width: The full width status of the media panel.

selected_entries: A list of PyObject currently selected.

visible: The visible status of the media panel.

class PyMessages( )

Module handling message bar in application UI.

Method resolution order:: PyMessages

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

clear_console(...): clear_console( (PyMessages)arg1) -> None : Remove currently displayed message in the message bar.

show_in_console(...): show_in_console( (PyMessages)arg1, (str)message [, (str)type='info' [, (int)duration=-1]]) -> None : Display an informative message in application message bar. message -- Message string to display. type -- Message type can be info, warning, or error. duration -- An optional time in seconds to keep message on screen.

show_in_dialog(...): show_in_dialog( (PyMessages)arg1, (str)title, (str)message, (str)type, (list)buttons [, (str)cancel_button='']) -> str : Display a custom dialog with a selection of options. Keywords argument: title -- The title of the dialog. message -- The message displayed in the center of the dialog. type -- The type of dialog. Can be error, info, question, or warning. buttons -- The list of titles used to refer to the options cancel_button -- The text displayed in the cancel option

class PyNode(PyFlameObject)

Object representing a Node.

Method resolution order:: PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

set_context(...): clear_schematic_colour( (PyNode)arg1) -> None : Clear the schematic colour of the Node.

Read-only properties defined here:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyOFXNode(PyNode)

Object representing a OpenFX node.

Method resolution order:: PyOFXNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

change_plugin(...): change_plugin( (PyOFXNode)arg1, (str)plugin_name) -> bool : Change the active plugin for the openFX node

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyPaintNode(PyNode)

Object representing a Paint node.

Method resolution order:: PyPaintNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

add_source(...): add_source( (PyPaintNode)arg1) -> object : Add a Source layer to a Paint node.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyProject(PyArchiveEntry)

Object representing a Project.

Method resolution order:: PyProject; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

create_shared_library(...): create_shared_library( (PyProject)arg1, (str)name) -> object : Create a new Shared Library in the Project.

get_available_colour_spaces(...): get_available_colour_spaces( (PyProject)arg1) -> object : Return a list of all the available colour spaces.

refresh_shared_libraries(...): refresh_shared_libraries( (PyProject)arg1) -> bool : Refresh the Shared Libraries list in the Media Panel.

Read-only properties defined here:

current_workspace: Return the current Workspace.

name: Return the Project name.

nickname: Return the Project nickname.

project_name: Deprecated / use name instead

shared_libraries: Return a list of Shared Libraries inside the Project.

workspaces_count: Return the amount of Project Workspaces.

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyProjectSelector( )

Object representing the Project manager.

Method resolution order:: PyProjectSelector

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

current_project: The PyProject linked to the current Project.

class PyReel(PyArchiveEntry)

Object representing a Reel.

Method resolution order:: PyReel; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

clear(...): clear( (PyReel)arg1 [, (bool)confirm=True]) -> bool : Clear the Reel content.

create_sequence(...): create_sequence( (PyReel)arg1 [, (str)name='Untitled Sequence' [, (int)video_tracks=1 [, (bool)video_stereo=False [, (int)width=1920 [, (int)height=1080 [, (float)ratio=1.7777777777777777 [, (int)bit_depth=8 [, (str)scan_mode='P' [, (str)frame_rate='29.97 fps NDF' [, (object)start_at=00:00:00:00 [, (object)duration=00:00:00:01 [, (int)audio_tracks=1 [, (bool)audio_stereo=True]]]]]]]]]]]]]) -> object : Create a Sequence in a PyReel, PyLibrary, PyFolder. Keywords arguments: video_tracks -- Number of video tracks. Integer between 1 and 8. video_stereo -- Stereoscopy. False for mono, True for stereo. width -- Integer between 24 and 16384. height -- Integer between 24 and 16384. ratio -- Frame aspect ratio. Float between 0.01 and 100. scan_mode -- Scan mode of the sequence. (F1, F2, P) frame_rate -- Frame rate. (60 fps, 59.54 NDF, 59.94 DF, 50 fps, 30 fps, 29.97 NDF, 29.97 DF, 25 fps, 24 fps, 23.976 fps) start_at -- Start timecode. The timecode format must be of the format specified by *frame_rate*. duration -- Can be an end timecode or an integer. If an end timecode, format must be of the format specified by *frame_rate*. If an integer, it represents a number of frames. audio_tracks -- Number of audio tracks. (0, 1, 2, 4, 8, 12, 16) audio_stereo -- Stereophony, apply to all *audio_tracks*. False for mono tracks, True for stereo.

save(...): save( (PyReel)arg1) -> bool : Save the Reel to the defined save destination.

Read-only properties defined here:

children: Return a list of the immediate children of the current object.

clips: Return a list of Clip objects that are immediate children of the current object.

sequences: Return a list of Sequence objects that are immediate children of the current object.

type: Return the Reel type (Reel, Schematic, Sequences, Shelf).

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyReelGroup(PyArchiveEntry)

Object representing a Reel Group.

Method resolution order:: PyReelGroup; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

clear(...): clear( (PyReelGroup)arg1 [, (bool)confirm=True]) -> bool : Clear the Reel Group content.

create_reel(...): create_reel( (PyReelGroup)arg1, (str)name [, (bool)sequence=False]) -> object : Create a new Reel inside a Reel Group.

save(...): save( (PyReelGroup)arg1) -> bool : Save the Reel Group to the defined save destination.

Read-only properties defined here:

children: Return a list of the immediate children of the current object.

reels: Return a list of Reel objects that are immediate children of the current object.

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyRenderNode(PyNode)

Class derived from PyNode. This class represents a Render node.

Method resolution order:: PyRenderNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

set_channel_name(...): set_channel_name( (PyRenderNode)arg1, (object)channel, (object)name) -> None : Rename a channel, using its index or front channel name as the index key. Keyword arguments: channel -- The channel to rename. Can be the channel index or the current name of the channel's front socket. name -- The new name of the channel. The type is either a string or a tuple. A Write File node always takes a string. A Render node takes a string or a tuple. In a Render node, a string only sets the name of the channel's front socket; the function creates the name of the matte socket by appending '_alpha' to 'name'. In the UI, the channel is flagged 'Sync'. A Write File node has only one socket per channel, and requires only a string to set a socket name. In a Render node, a tuple sets the names of the front and matte sockets. In the UI, the channel is not flagged 'Sync'. A Write File node does not accept a tuple.

Read-only properties defined here:

channels: The channels attribute is a list of tuples, where each tuple is made of a socket name and its channel name.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyResolution( )

Object representing a resolution PyResolution() PyResolution(width, height, bit_depth, frame_ratio, scan_format)

Method resolution order:: PyResolution

Static methods defined here:

__init__(...): __init__( (object)arg1) -> None __init__( (object)arg1, (int)arg2, (int)arg3, (int)arg4, (float)arg5, (str)arg6) -> None __init__( (object)arg1, (str)arg2) -> None

__reduce__ = (...)

Data descriptors defined here:

bit_depth: Return the resolution bit depth.

frame_ratio: Return the resolution frame ratio.

height: Return the resolution height.

resolution: Set the resolution based on its name in the UI. Possible values are: Custom Resolution Project Res Project Resolution A resolution, in the format used by the Resolution List in the UI. Example: HD 720 16:9 (1280 x 720)

scan_mode: Return the resolution scan mode.

width: Return the resolution width.

Data and other attributes defined here:

__instance_size__ = 80

class PySearch( )

This class represents the search.

Method resolution order:: PySearch

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

activate_search_result(...): activate_search_result( (PySearch)arg1, (str)name, (str)type [, (str)tab='Tools']) -> None : Activate a search result.

search_results(...): search_results( (PySearch)arg1 [, (str)search_str='*' [, (str)tab='Tools']]) -> list : Search results that match a string.

set_tool_favorite(...): set_tool_favorite( (PySearch)arg1, (str)arg2, (str)name, (bool)type) -> None : Return the favorite status of a tool.

set_tool_hidden(...): set_tool_hidden( (PySearch)arg1, (str)arg2, (str)name, (bool)type) -> None : Return the hidden status of a tool.

set_tool_weight(...): set_tool_weight( (PySearch)arg1, (str)arg2, (str)name, (int)type) -> None : Return the tool weight.

Data descriptors defined here:

use_weight: Return true if the search sorting is done using weight.

class PySegment(PyFlameObject)

Object representing a Segment.

Method resolution order:: PySegment; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

change_start_frame(...): change_start_frame( (PySegment)arg1, (int)start_frame [, (bool)use_segment_connections=True]) -> None : Modify the start frame of the segment. Keywords argument: start_frame -- New start frame of the segment. use_segment_connections -- Sync the start frame of connected segments.

clear_colour(...): clear_colour( (PySegment)arg1) -> None : Clear the colour of the Segment.

connected_segments(...): connected_segments( (PySegment)arg1 [, (str)scoping='all reels']) -> object : Return a list of the connected segments. Keywords argument: scoping -- Scopes of the sequences to query (all reels, sequences reels, current reel, current sequence). (Default:all reels)

copy_to_media_panel(...): copy_to_media_panel( (PySegment)arg1, (PyArchiveEntry)destination [, (str)duplicate_action='add']) -> object : Create a new clip with a copy of the PyObject.

create_connection(...): create_connection( (PySegment)arg1) -> None : Create a connected segment connection.

create_effect(...): create_effect( (PySegment)arg1, (str)effect_type [, (str)after_effect_type='']) -> object : Add an effect of effect_type on the Segment. after_effect_type can be specified to insert the effect at a specific position.

create_marker(...): create_marker( (PySegment)arg1, (object)location) -> object : Create a Marker at the specified location on the Segment.

create_unlinked_segment(...): create_unlinked_segment( (PySegment)arg1 [, (str)source_name='' [, (str)tape_name='' [, (object)start_time=0 [, (object)source_duration=0 [, (object)head=0 [, (str)file_path='' [, (int)source_audio_track=1 [, (int)width=0 [, (int)height=0 [, (float)ratio=0.0 [, (int)bit_depth=0 [, (str)scan_mode='Same As Sequence' [, (str)frame_rate='Same As Sequence']]]]]]]]]]]]]) -> None : Replace the gap with an unlinked source media segment. Keywords argument: source_name -- Name of the source. tape_name -- Tape name of the source. start_time -- Start time of the source. Must be a PyTime or a frame number. source_duration -- Length of the source. Must be a PyTime, a number of frames, or "Infinite". head -- Amount of head media to set on the segment. file_path -- File path to the media. source_audio_track -- Audio track from the source. width -- Width of the video media. (0 to use the sequence width) height -- Height of the video media. (0 to use the sequence height) ratio -- Frame ratio of the video media. (0.0 to use the sequence ratio) bit_depth -- Bit depth of the video media. (0 to use the sequence bit depth) scan_mode -- Scan mode of the video media. (P, F1, F2, or Same As Sequence) frame_rate -- Frame rate. (60 fps, 59.54 NDF, 59.94 DF, 50 fps, 30 fps, 29.97 NDF, 29.97 DF, 25 fps, 24 fps, 23.976 fps, Same As Sequence)

duplicate_source(...): duplicate_source( (PySegment)arg1) -> None : Insure that the segment's source is not shared anymore.

get_colour_space(...): get_colour_space( (PySegment)arg1 [, (PyTime)time=None]) -> str : Return the colour space at the requested time. Use record_in when no time is supplied.

is_rendered(...): is_rendered( (PySegment)arg1 [, (str)render_quality='Full Resolution']) -> bool : Return if the segment is rendered.

match(...): match( (PySegment)arg1, (PyArchiveEntry)destination [, (bool)preserve_handle=False [, (bool)use_sequence_info=True [, (bool)include_nested_content=False [, (bool)include_timeline_fx=False]]]]) -> object : Match out the media of the PySegment to the destination. Returns a PyClip or a list of PyClip (with the included_nested_content option). Keywords argument: destination -- The PyObject that acts as the destination. preserve_handle -- Prevent the unrolling of the media handles. use_sequence_info -- Copy sequence segment information to the new matched clip. include_nested_content -- Include all sources found inside a BFX or Matte Container. include_timeline_fx -- Copy the Timeline FX present on the original clip to the new matched clip.

remove_connection(...): remove_connection( (PySegment)arg1) -> None : Remove the connected segment connection.

set_gap_bars(...): set_gap_bars( (PySegment)arg1 [, (str)type='smpte' [, (bool)full_luminance=False [, (float)softness=0.0]]]) -> object : Create colour bars segment for the duration of the gap. Returns a new PySegment on success. Keywords argument: type -- smpte or pal. full_luminance -- bars created at 100 or 75 percent luminance. softness -- softness to apply between the bars.

set_gap_colour(...): set_gap_colour( (PySegment)arg1 [, (float)r=0.0 [, (float)g=0.0 [, (float)b=0.0]]]) -> None : Create a colour source segment for the duration of the gap, or set the colour of an existing colour source.

set_matte_channel(...): set_matte_channel( (PySegment)arg1 [, (str)channel_name='' [, (int)channel_index=-1 [, (str)scope='Follow Preferences' [, (str)matte_mode='Custom Matte']]]]) -> bool : Set the Matte channel of the source specified by channel_index or by channel_name if the matte_mode is set to Custom Matte. Keywords argument: channel_name -- Name of the channel found in matte_channels. channel_index -- Index of the channel found in matte_chanels. scope -- Scope of the changes ( Follow Preferences, No Sharing, Follow Source Sharing, Follow Connected Segments). matte_mode -- Matte origin (Follow RGB, No Matte, Custom Matte).

set_rgb_channel(...): set_rgb_channel( (PySegment)arg1 [, (str)channel_name='' [, (int)channel_index=-1 [, (str)scope='Follow Preferences']]]) -> bool : Set the RGB channel of the source specified by channel_index or by channel_name Keywords argument: channel_name -- Name of the channel found in rgb_channels. channel_index -- Index of the channel found in rgb_chanels. scope -- Scope of the changes ( Follow Preferences, No Sharing, Follow Source Sharing, Follow Connected Segments).

shared_source_segments(...): shared_source_segments( (PySegment)arg1) -> object : Return a list of the segments sharing this segment's source.

slide_keyframes(...): slide_keyframes( (PySegment)arg1, (int)offset [, (bool)sync=False]) -> bool : Slide the keyframes the PySegment. Keywords argument: offset -- Relative offset to slide the keyframes. sync -- Enable to perform the same operation on the segments that belong to the same sync group as the current PySegment.

slip(...): slip( (PySegment)arg1, (int)offset [, (bool)sync=False [, (str)keyframes_move_mode='Shift']]) -> bool : Slip the media of the PySegment. Keywords argument: offset -- Relative offset to slip the media. sync -- Enable to perform the same operation on the segments that belong to the same sync group as the current PySegment. keyframes_move_mode -- Select how the animation channels are affected ( Pin, Shift, Prop)

smart_replace(...): smart_replace( (PySegment)arg1, (PyClip)source_clip) -> None : Replace the PySegment by the source_clip segment, including the TimelineFX.

smart_replace_media(...): smart_replace_media( (PySegment)arg1, (PyClip)source_clip) -> None : Replace the media of PySegment by the source_clip segment, leaving the PySegment TimelineFX untouched

sync_connected_segments(...): sync_connected_segments( (PySegment)arg1) -> None : Sync connected segments with the Timeline FXs of the current segment.

trim_head(...): trim_head( (PySegment)arg1, (int)offset [, (bool)ripple=False [, (bool)sync=False [, (str)keyframes_move_mode='Shift']]]) -> bool : Modify the amount of head of the PySegment. Keywords argument: offset -- Number of frames to add or remove from the head. ripple -- Enable to prevent gaps from appearing when performing a trim. sync -- Enable to perform the same operation on the segments that belong to the same sync group as the current PySegment. keyframes_move_mode -- Select how the animation channels are affected ( Pin, Shift, Prop)

trim_tail(...): trim_tail( (PySegment)arg1, (int)offset [, (bool)ripple=False [, (bool)sync=False [, (str)keyframes_move_mode='Shift']]]) -> bool : Modify the amount of tail of the PySegment. Keywords argument: offset -- Number of frames to add or remove from the tail. ripple -- Enable to prevent gaps from appearing when performing a trim. sync -- Enable to perform the same operation on the segments that belong to the same sync group as the current PySegment. keyframes_move_mode -- Select how the animation channels are affected ( Pin, Shift, Prop)

Read-only properties defined here:

container_clip: Return the current Matte mode.

effect_types: Return a list of available effect types for the segment

effects: Return a list of PyTimelineFX on the segment.

file_path: Return the file path of the Segment's source.

groups: Return a list of PySequenceGroups that contains the segment.

head: Return the amount of head of the Segment.

markers: Return a list of the segment's Markers.

matte_channel: Return the name of the Matte channel.

matte_channels: Return a list of all Matte channels.

matte_mode: Return the current Matte mode.

original_source_uid: Return the Clip's original source UID.

record_duration: Return the duration of the Segment.

record_in: Return the record time in of the Segment.

record_out: Return the record time out of the Segment.

rgb_channel: Return the name of the RGB channel.

rgb_channels: Return a list of all RGB channels

source_audio_track: Return the audio track of the source.

source_bit_depth: Return the Clip's bit depth.

source_cached: Return the Clip's cache status.

source_colour_primaries: Deduce the Clip's 'colour primaries' export attribute.

source_duration: Return the duration of the Segment's source.

source_essence_uid: Return the Clip's essence uid.

source_frame_rate: Return the Clip's frame rate.

source_has_history: Return the existence of history inside the Clip.

source_height: Return the Clip's height.

source_in: Return the source time in of the Segment.

source_matrix_coefficients: Deduce the Clip's 'matrix coefficients' export attribute.

source_name: Return the name of the Segment's source.

source_out: Return the source time out of the Segment.

source_ratio: Return the Clip's frame ratio.

source_sample_rate: Return the Clip's audio sample rate.

source_scan_mode: Return the Clip's scan mode.

source_transfer_characteristics: Deduce the Clip's 'transfer characteristics' export attribute.

source_uid: Return the Clip's source uid.

source_unlinked: Return the Clip's unlinked status.

source_width: Return the Clip's width.

start_frame: Return the start frame of the Segment.

tail: Return the amount of tail of the Segment.

tape_name: Return the tape name of the Segment.

type: Return the Segment type.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PySequence(PyClip)

Object representing a Sequence.

Method resolution order:: PySequence; PyClip; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

copy_selection_to_media_panel(...): copy_selection_to_media_panel( (PySequence)arg1, (PyArchiveEntry)destination [, (str)duplicate_action='add']) -> object : Create a new clip by copying the currently selected segments. Return the new PyClip. Keyword arguments: destination -- The PyObject that acts as the destination. duplicate_action -- Action to take when an object with the same name already exists (add or replace).

create_audio(...): create_audio( (PySequence)arg1 [, (bool)stereo=False]) -> object : Add an Audio Track to the Sequence.

create_container(...): create_container( (PySequence)arg1) -> object : Create a container with the selected segments or between the in and out marks.

create_group(...): create_group( (PySequence)arg1, (str)name) -> object : Creates a new PySequenceGroup. The group name must be supplied as argument.

create_subtitle(...): create_subtitle( (PySequence)arg1) -> object : Add a Subtitle Track to the Sequence.

create_version(...): create_version( (PySequence)arg1 [, (bool)stereo=False]) -> object : Add a Version to the Sequence.

extract_selection_to_media_panel(...): extract_selection_to_media_panel( (PySequence)arg1 [, (PyArchiveEntry)destination=None [, (str)duplicate_action='add']]) -> object : Extract the selection from the sequence. Return the new PyClip created from the selection when a destination is supplied. Keyword arguments: destination -- The PyObject that acts as the destination. duplicate_action -- Action to take when an object with the same name already exists (add or replace).

import_subtitles_file(...): import_subtitles_file( (PySequence)arg1, (str)file_name [, (object)file_type=None [, (bool)align_first_event_to_clip_start=False [, (object)convert_from_frame_rate=None]]]) -> object : Import a subtitles file into a new Subtitles Track. Return the new PySubtitleTrack. Keyword arguments: file_name -- The path and name of the file to import. file_type -- The type of subtitle if it is not the file extension (srt or txt). align_first_event_to_clip_start -- Force the first event to be aligned with the clip start. convert_from_frame_rate -- frame rate of the imported file (for txt files only).

insert(...): insert( (PySequence)arg1, (PyClip)source_clip [, (PyTime)insert_time=None [, (PyTrack)destination_track=None]]) -> bool : Creates a new PySequenceGroup. The group name must be supplied as argument.

lift_selection_to_media_panel(...): lift_selection_to_media_panel( (PySequence)arg1 [, (PyArchiveEntry)destination=None [, (str)duplicate_action='add']]) -> object : Lift the selection from the sequence. Return the new PyClip created from the selection when a destination is supplied. Keyword arguments: destination -- The PyObject that acts as the destination. duplicate_action -- Action to take when an object with the same name already exists (add or replace).

open(...): open( (PySequence)arg1) -> bool : Open the Sequence.

overwrite(...): overwrite( (PySequence)arg1, (PyClip)source_clip [, (PyTime)overwrite_time=None [, (PyTrack)destination_track=None]]) -> bool : Creates a new PySequenceGroup. The group name must be supplied as argument.

Read-only properties defined here:

groups: Return a list of the sequence's PySequenceGroups.

Static methods inherited from PyClip:

cache_media(...): cache_media( (PyClip)arg1 [, (str)mode='current']) -> bool : Cache the Clip's linked media. Keyword argument: mode -- Determine the version to cache (currently selected or all versions). All Versions is only useful with to multi-version clips (Current, All Versions)

change_dominance(...): change_dominance( (PyClip)arg1, (str)scan_mode) -> None : Change the Clip's dominance. Changes only the clip's metadata. Keyword argument: scan_mode -- Field dominance. (P, F1, F2)

change_start_frame(...): change_start_frame( (PyClip)arg1, (int)start_frame [, (bool)use_segment_connections=True]) -> None : Modify the start frame of a source Clip. Keywords argument: start_frame -- New start frame of the clip. use_segment_connections -- Sync the start frame of connected segments.

close_container(...): close_container( (PyClip)arg1) -> None : Close the container timeline if the Clip is inside a container.

create_marker(...): create_marker( (PyClip)arg1, (object)location) -> object : Add a Marker to the Clip.Keyword argument: location -- The frame where the marker gets created.

cut(...): cut( (PyClip)arg1, (PyTime)cut_time) -> None : Cut all tracks of the Clip.

flush_cache_media(...): flush_cache_media( (PyClip)arg1 [, (str)mode='current']) -> bool : Flush the Clip's media cache. Keyword argument: mode -- Determine the version's cache to flush. (Current, All Versions, All But Current)

flush_renders(...): flush_renders( (PyClip)arg1) -> None : Flush the Clip's TimelineFX renders.

get_colour_space(...): get_colour_space( (PyClip)arg1 [, (PyTime)time=None]) -> str : Return the colour space at the requested time. Use current_time when no time is supplied.

is_rendered(...): is_rendered( (PyClip)arg1 [, (bool)top_only=False [, (str)render_quality='Full Resolution']]) -> bool : Return if a Clip is rendered. The following attributes can be defined: top_only, render_quality.

open_as_sequence(...): open_as_sequence( (PyClip)arg1) -> object : Open the Clip as a Sequence. Mutates the PyClip object into a PySequence object.

open_container(...): open_container( (PyClip)arg1) -> bool : Open the container timeline if the Clip is inside a container.

reformat(...): reformat( (PyClip)arg1 [, (int)width=0 [, (int)height=0 [, (float)ratio=0.0 [, (int)bit_depth=0 [, (str)scan_mode='' [, (str)frame_rate='' [, (str)resize_mode='Letterbox']]]]]]]) -> None : Reformat the Clip to the specified format. Keywords arguments: width -- Integer between 24 and 16384. height -- Integer between 24 and 16384. ratio -- Frame aspect ratio. Float between 0.01 and 100. bit_depth -- Bit depth. (8, 10, 12, 16 or 32) scan_mode -- Scan mode of the sequence. (F1, F2, P) frame_rate -- Frame rate. (60 fps, 59.54 NDF, 59.94 DF, 50 fps, 30 fps, 29.97 NDF, 29.97 DF, 25 fps, 24 fps, 23.976 fps) resize_mode -- Resize mode. (Letterbox, Crop Edges, Fill, Centre)

render(...): render( (PyClip)arg1 [, (str)render_mode='All' [, (str)render_option='Foreground' [, (str)render_quality='Full Resolution' [, (str)effect_type='' [, (str)effect_caching_mode='Current' [, (bool)include_handles=False]]]]]]) -> bool : Trigger a render of the Clip The following attributes can be defined: render_mode, render_option, render_quality, effect_type, effect_caching_mode and include_handles.

save(...): save( (PyClip)arg1) -> bool : Save the Clip to the defined save destination.

Read-only properties inherited from PyClip:

archive_date: Return the Clip's last archive date.

archive_error: Return the Clip's last archive error.

audio_tracks: Return a list of the Clip's Audio Tracks.

bit_depth: Return the Clip's bit depth.

cached: Return the Clip's cache status.

colour_primaries: Deduce the Clip's 'colour primaries' export attribute.

creation_date: Return the Clip's creation date.

duration: Return the Clip's duration.

essence_uid: Return the Clip's essence uid.

frame_rate: Return the Clip's frame rate.

has_deliverables: Return the existence of deliverables on the Clip.

has_history: Return the existence of history inside the Clip.

height: Return the Clip's height.

markers: Return a list of the Clip's Markers.

matrix_coefficients: Deduce the Clip's 'matrix coefficients' export attribute.

original_source_uid: Return the Clip's original source UID.

proxy_resolution: Return the Clip's proxy resolution if it has proxies.

ratio: Return the Clip's frame ratio.

sample_rate: Return the Clip's audio sample rate.

scan_mode: Return the Clip's scan mode.

source_uid: Return the Clip's source uid.

start_frame: Return the Clip's start frame.

subtitles: Return a list of the Clip's Subtitles Tracks.

transfer_characteristics: Deduce the Clip's 'transfer characteristics' export attribute.

unlinked: Return the Clip's unlinked status.

versions: Return a list of the Clip's versions.

width: Return the Clip's width.

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PySequenceGroup(PyFlameObject)

Object representing a Group in a Sequence.

Method resolution order:: PySequenceGroup; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

add(...): add( (PySequenceGroup)arg1, (object)segments) -> None : Adds a PySegment or list of PySegments to the Group.

remove(...): remove( (PySequenceGroup)arg1, (object)segments) -> None : Remove a PySegment or list of PySegments from the Group.

Read-only properties defined here:

segments: Return a list of the Group's PySegments.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PySubtitleTrack(PyTrack)

Object representing a Subtitle Track.

Method resolution order:: PySubtitleTrack; PyTrack; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

export_as_avid_txt_file(...): export_as_avid_txt_file( (PySubtitleTrack)arg1, (str)file_name [, (str)start_timecode='Same as Clip']) -> None : Export the Subtitle Track as a Avid Caption (txt) file.Keyword arguments: file_name -- The path and name of the file to write. start_timecode -- Specify the timecode mode, Same As Clip or, Relative to Clip Start.

export_as_srt_file(...): export_as_srt_file( (PySubtitleTrack)arg1, (str)file_name [, (bool)character_based_attributes=True [, (bool)export_colours=False [, (str)exclude_colour='' [, (bool)use_original_colours=False [, (bool)use_original_alignment=False [, (bool)export_alignments=False [, (str)alignment_type='an' [, (str)exclude_alignment='' [, (str)start_timecode='Same as Clip']]]]]]]]]) -> None : Export the Subtitles Track as a SubRip (srt) file.Keyword arguments: file_name -- The path and name of the file to write. character_based_attributes -- Export the bold, italic, and underline attributes. export_colours -- Export colours. exclude_colour -- Specify a colour, in hexadecimal or CSS colour name, to ignore. use_original_colours -- Reuse hexadecimal or CSS colour names from the imported file. use_original_alignment -- Reuse alignment tokens from the imported file . export_alignments -- Export alignments. alignment_type -- Set to a or an alignment style tokens. exclude_alignment -- Specify an alignment to ignore. start_timecode -- Specify the timecode mode, Same as Clip or, Relative to Clip Start.

Static methods inherited from PyTrack:

copy_to_media_panel(...): copy_to_media_panel( (PyTrack)arg1, (PyArchiveEntry)destination [, (str)duplicate_action='add']) -> object : Create a new clip with a copy of the PyObject.

cut(...): cut( (PyTrack)arg1, (PyTime)cut_time [, (bool)sync=False]) -> None : Cut the Track.

insert_transition(...): insert_transition( (PyTrack)arg1, (PyTime)record_time, (str)type [, (int)duration=10 [, (str)alignment='Centred' [, (int)in_offset=0 [, (bool)sync=False]]]]) -> object : Insert a Transition on the Track. Returns the new PyTransition if successful. Keywords argument: record_time -- Time at which the Transition is inserted. type -- Type of the new Transition. duration -- Duration of the new Transition in frames. alignment -- Alignment of the new Transition. in_offset -- Number of frames on left side of the cut in custom alignment. sync -- Perform the operation on all Tracks part of the sync group.

Read-only properties inherited from PyTrack:

segments: Return a list of the Track's segments.

transitions: Return a list of the Track's transitions.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyTime( )

Object representing a time unit PyTime(timecode, frame_rate) PyTime(relative_frame) PyTime(absolute_frame, frame_rate)

Method resolution order:: PyTime

Static methods defined here:

__add__(...): __add__( (PyTime)arg1, (PyTime)arg2) -> object __add__( (PyTime)arg1, (int)arg2) -> object

__eq__(...): __eq__( (PyTime)arg1, (PyTime)arg2) -> bool

__iadd__(...): __iadd__( (object)arg1, (PyTime)arg2) -> object __iadd__( (object)arg1, (int)arg2) -> object

__init__(...): __init__( (object)arg1, (str)arg2, (str)arg3) -> None __init__( (object)arg1, (int)arg2) -> None __init__( (object)arg1, (int)arg2, (str)arg3) -> None

__isub__(...): __isub__( (object)arg1, (PyTime)arg2) -> object __isub__( (object)arg1, (int)arg2) -> object

__ne__(...): __ne__( (PyTime)arg1, (PyTime)arg2) -> bool

__reduce__ = (...)

__repr__(...): __repr__( (PyTime)arg1) -> object

__str__(...): __str__( (PyTime)arg1) -> str

__sub__(...): __sub__( (PyTime)arg1, (PyTime)arg2) -> object __sub__( (PyTime)arg1, (int)arg2) -> object

Read-only properties defined here:

frame: Return the absolute frame number.

frame_rate: Return the object frame rate.

relative_frame: Return the relative frame number.

timecode: Return the timecode.

Data and other attributes defined here:

__instance_size__ = 72

class PyTimeline( )

This class represents the Timeline.

Method resolution order:: PyTimeline

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

clip: The associated PyClip or PySequence of the Timeline.

current_effect: The PyTimelineFX currently focused on the timeline.

current_marker: The PyMarker currently focused on the timeline.

current_segment: The PySegment currently focused on the timeline.

current_transition: The PyTransition currently focused on the timeline.

Data descriptors defined here:

type: The type of Timeline currently focused.

class PyTimelineFX(PyFlameObject)

Object representing a TimelineFX.

Method resolution order:: PyTimelineFX; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

flush_maps_cache_media(...): flush_maps_cache_media( (PyTimelineFX)arg1) -> bool : Flush the Timeline FX Maps and ML cached media.

load_setup(...): load_setup( (PyTimelineFX)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_setup(...): save_setup( (PyTimelineFX)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

slide_keyframes(...): slide_keyframes( (PyTimelineFX)arg1, (float)offset) -> None : Slide the keyframes the PySegment. Keywords argument: offset -- Relative offset to slide the keyframes. sync -- Enable to perform the same operation on the segments that belong to the same sync group as the current PySegment.

sync_connected_segments(...): sync_connected_segments( (PyTimelineFX)arg1) -> None : Push the Timeline FX to connected segments.

Read-only properties defined here:

has_maps_cache_media: Return whether the Timeline FX has Maps or ML cached media.

type: Return the type of the Timeline FX.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyTrack(PyFlameObject)

Object representing a Track.

Method resolution order:: PyTrack; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

copy_to_media_panel(...): copy_to_media_panel( (PyTrack)arg1, (PyArchiveEntry)destination [, (str)duplicate_action='add']) -> object : Create a new clip with a copy of the PyObject.

cut(...): cut( (PyTrack)arg1, (PyTime)cut_time [, (bool)sync=False]) -> None : Cut the Track.

insert_transition(...): insert_transition( (PyTrack)arg1, (PyTime)record_time, (str)type [, (int)duration=10 [, (str)alignment='Centred' [, (int)in_offset=0 [, (bool)sync=False]]]]) -> object : Insert a Transition on the Track. Returns the new PyTransition if successful. Keywords argument: record_time -- Time at which the Transition is inserted. type -- Type of the new Transition. duration -- Duration of the new Transition in frames. alignment -- Alignment of the new Transition. in_offset -- Number of frames on left side of the cut in custom alignment. sync -- Perform the operation on all Tracks part of the sync group.

Read-only properties defined here:

segments: Return a list of the Track's segments.

transitions: Return a list of the Track's transitions.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyTransition(PyFlameObject)

Object representing a Transition.

Method resolution order:: PyTransition; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

set_dissolve_to_from_colour(...): set_dissolve_to_from_colour( (PyTransition)arg1 [, (float)r=0.0 [, (float)g=0.0 [, (float)b=0.0]]]) -> None : Make a dissolve transition dissolve to/from a colour.

set_fade_to_from_silence(...): set_fade_to_from_silence( (PyTransition)arg1) -> None : Make a fade dip to/from silence.

set_transition(...): set_transition( (PyTransition)arg1, (str)type [, (int)duration=10 [, (str)alignment='Centred' [, (int)in_offset=0]]]) -> object : Replace the Transition with another type of Transition. Returns the new PyTransition if successful. Keywords argument: type -- Type of the new Transition. duration -- Duration of the new Transition in frames. alignment -- Alignment of the new Transition. in_offset -- Number of frames on left side of the cut in custom alignment.

slide(...): slide( (PyTransition)arg1, (int)offset [, (bool)sync=False]) -> bool : Slide the Transition. Keywords argument: offset -- Amount of frames to slide the Transition with. sync -- Enable to perform the same operation on transitions that belong to the same sync group as the current PyTransition.

Read-only properties defined here:

in_offset: Return the in offset of the Transition.

record_time: Return the record time of Transition focus.

type: Return the Transition type.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyUser( )

Object representing a User.

Method resolution order:: PyUser

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

name: User name.

nickname: User nick name.

Data descriptors defined here:

shortcuts_profile: Keyboard Shortcuts profile. Possible values are: Flame Smoke Classic Smoke (FCP 7) Lustre

class PyUsers( )

Object representing the User manager.

Method resolution order:: PyUsers

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

Read-only properties defined here:

current_user: The PyUser linked to the current User.

class PyVersion(PyFlameObject)

Object representing a Version.

Method resolution order:: PyVersion; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

copy_to_media_panel(...): copy_to_media_panel( (PyVersion)arg1, (PyArchiveEntry)destination [, (str)duplicate_action='add']) -> object : Create a new clip with a copy of the PyObject.

create_track(...): create_track( (PyVersion)arg1 [, (int)track_index=-1 [, (bool)hdr=False]]) -> object : Add a track to the Version.Keywords arguments: track_index -- Index to insert the new track at, -1 to append at the top. hdr -- Set to True to create an HDR track.

import_DolbyVision_xml(...): import_DolbyVision_xml( (PyVersion)arg1, (str)file_name [, (str)mode='Include Frame Based Transitions Trims' [, (int)track_index=-1]]) -> object : Add a track to the Version.Keywords arguments: track_index -- Index to insert the new track at, -1 to append at the top. hdr -- Set to True to create an HDR track.

Read-only properties defined here:

stereo: Return whether or not the Version is stereo.

tracks: Return a list of the Version's Tracks.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyWorkspace(PyArchiveEntry)

Object representing a Workspace.

Method resolution order:: PyWorkspace; PyArchiveEntry; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

create_library(...): create_library( (PyWorkspace)arg1, (str)name) -> object : Create a new Library in a Workspace.

replace_desktop(...): replace_desktop( (PyWorkspace)arg1, (PyDesktop)desktop) -> bool : Replace the Workspace active Desktop with another one.

set_desktop_reels(...): set_desktop_reels( (PyWorkspace)arg1 [, (object)group=None]) -> bool : Set the Desktop Reels view mode.

set_freeform(...): set_freeform( (PyWorkspace)arg1 [, (object)reel=None]) -> bool : Set the Freeform view mode.

Read-only properties defined here:

desktop: Return the current Desktop.

libraries: Return the Workspace Libraries.

Static methods inherited from PyArchiveEntry:

clear_colour(...): clear_colour( (PyArchiveEntry)arg1) -> None : Clear the colour of an object in the Media Panel.

commit(...): commit( (PyArchiveEntry)arg1) -> None : Commit to disk the Media Panel object or its closest container possible.

get_wiretap_node_id(...): get_wiretap_node_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap Node ID of the Flame object, but only if the object is in the Media Panel.

get_wiretap_storage_id(...): get_wiretap_storage_id( (PyArchiveEntry)arg1) -> str : Return the Wiretap server's storage ID for the Flame object, but only if the object is in the Media Panel.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

class PyWriteFileNode(PyRenderNode)

Class derived from PyRenderNode. This class represents a WriteFile node.

Method resolution order:: PyWriteFileNode; PyRenderNode; PyNode; PyFlameObject

Static methods defined here:

__init__(...): Raises an exception This class cannot be instantiated from Python

__reduce__ = (...)

get_resolved_media_path(...): get_resolved_media_path( (PyWriteFileNode)arg1 [, (bool)show_extension=True [, (bool)translate_path=True [, (object)frame=None]]]) -> object : Return the resolved media path. Keyword arguments: show_extension -- Set True to display the extension. translate_path -- Set True to apply the Media Location Path Translation. frame -- Pass a frame number, between range_start and range_end, to get the path for that frame.

Static methods inherited from PyRenderNode:

set_channel_name(...): set_channel_name( (PyRenderNode)arg1, (object)channel, (object)name) -> None : Rename a channel, using its index or front channel name as the index key. Keyword arguments: channel -- The channel to rename. Can be the channel index or the current name of the channel's front socket. name -- The new name of the channel. The type is either a string or a tuple. A Write File node always takes a string. A Render node takes a string or a tuple. In a Render node, a string only sets the name of the channel's front socket; the function creates the name of the matte socket by appending '_alpha' to 'name'. In the UI, the channel is flagged 'Sync'. A Write File node has only one socket per channel, and requires only a string to set a socket name. In a Render node, a tuple sets the names of the front and matte sockets. In the UI, the channel is not flagged 'Sync'. A Write File node does not accept a tuple.

Read-only properties inherited from PyRenderNode:

channels: The channels attribute is a list of tuples, where each tuple is made of a socket name and its channel name.

Static methods inherited from PyNode:

delete(...): delete( (PyFlameObject)arg1 [, (bool)confirm=True]) -> bool : Delete the node.

duplicate(...): duplicate( (PyNode)arg1 [, (bool)keep_node_connections=False]) -> object : Duplicate the node.

load_node_setup(...): load_node_setup( (PyNode)arg1, (str)file_name) -> bool : Load a Node setup. A path and a file name must be defined as arguments.

save_node_setup(...): save_node_setup( (PyNode)arg1, (str)file_name) -> bool : Save a Node setup. A path and a file name must be defined as arguments.

set_context(...): set_context( (PyNode)arg1, (int)index [, (str)socket_name='Default']) -> bool : Set a Context view on a Node socket. An index and a socket name must be defined as arguments.

Read-only properties inherited from PyNode:

input_sockets: Return a list of the node input sockets names.

output_sockets: Return a list of the node output sockets names.

sockets: Return a dictionary of the input/output sockets names and their connections.

Static methods inherited from PyFlameObject:

__getattr__(...): __getattr__( (PyFlameObject)arg1, (str)arg2) -> object

__setattr__(...): __setattr__( (PyFlameObject)arg1, (str)arg2, (object)arg3) -> None

Read-only properties inherited from PyFlameObject:

attributes: The attributes of a python object.

parent: The parent object of this object.

Functions

delete(...): delete( (PyFlameObject)object [, (bool)confirm=True]) -> bool : Delete the target object.

dump(...): dump() -> None

duplicate(...): duplicate( (PyFlameObject)object [, (bool)keep_node_connections=False]) -> object : Duplicate the target object.

duplicate_many(...): duplicate_many( (list)object_list [, (bool)keep_node_connections=False]) -> list : Duplicate the target objects.

execute_command(...): execute_command( (str)command [, (bool)blocking=True [, (bool)shell=False [, (bool)capture_stdout=False [, (bool)capture_stderr=False]]]]) -> tuple : Execute command line through the Autodesk Flame Multi-Purpose Daemon. This way of starting new processes is better since any native python subprocess command (os.system, subprocess, Popen, etc) will call fork() which will duplicate the process memory before calling exec(). This can be costly especially for a process like Flame. command -- Command line to execute. blocking -- If True, will not return until the command line has completed. shell -- Should the command be executed in a sh shell. WARNING Using shell=True can be a security hazard. capture_stdout -- If True, stdout of the command will be captured and returned instead of forwarded to the application stdout. Requires blocking=True capture_stderr -- If True, stdout of the command will be captured and returned instead of forwarded to the application stderr. Requires blocking=True Note: Environment variables will not be forwarded to the executed command.

execute_shortcut(...): execute_shortcut( (str)description [, (bool)update_list=True]) -> bool : Execute the Flame shortcut. description -- The description in the Keyboard Shortcut editor.

exit(...): exit() -> None : Exit the application.

find_by_name(...): find_by_name( (str)name [, (object)parent=None]) -> list : Find a Flame object in the Media Panel by name.

find_by_uid(...): find_by_uid( (str)uid) -> object : Find a Flame object in the Media Panel by UID.

find_by_wiretap_node_id(...): find_by_wiretap_node_id( (str)node_id) -> object : Find a Flame object in the Media Panel by Wiretap Node ID.

get_current_tab(...): get_current_tab() -> str : Get the current tab name.

get_home_directory(...): get_home_directory() -> str : Get the application home directory.

get_init_cfg_path(...): get_init_cfg_path() -> str : Get the application init configuration file.

get_selected_segment(...): get_selected_segment() -> object

get_selected_version(...): get_selected_version() -> object

get_version(...): get_version() -> str : Get the application version.

get_version_major(...): get_version_major() -> str : Get the application major version.

get_version_minor(...): get_version_minor() -> str : Get the application minor version.

get_version_patch(...): get_version_patch() -> str : Get the application patch version.

get_version_stamp(...): get_version_stamp() -> str : Get the application version stamp.

go_to(...): go_to( (str)tab) -> bool : Deprecated / use set_current_tab() instead.

import_clips(...): import_clips( (object)path [, (object)destination=None]) -> list : Import one or many clips from a path. Keyword arguments: path -- The path to the media can be: - A path to a single media file. - A path to a sequence of media files (ie "/dir/clip.[100-2000].dpx"). - A folder containing media files. - A pattern to media files (ie "/dir/{name}_v{version}.{frame}.{extension}"). - A list of paths. destination -- Flame object containing a clip like a reel or a folder object.

press_button(...): press_button( (str)name [, (float)param=0]) -> bool : Press the Flame button or assign a given value to it's variable. name -- The unique name of the menu item. param -- An optional value to be assigned to the button's variable.

schedule_idle_event(...): schedule_idle_event( (object)function [, (int)delay=0]) -> None : Register a function callback that will be called eventually when the application is idle. The function must not block and be quick since it will be executed in the main application thread. Keyword arguments: function -- Callable object to be called. delay -- Minimum time (in seconds) to wait before calling function.

set_current_tab(...): set_current_tab( (str)arg1) -> bool : Set the given tab as the active environment. Keyword arguments: tab -- The tab to set active (MediaHub, Conform, Timeline, Effects, Batch, Tools)

set_render_option(...): set_render_option( (str)render_option [, (str)render_context='']) -> bool : Set the default render option. Keyword arguments: render_option -- Defines the rendering method used. (Foreground, Background Reactor, Background Reactor (Auto), Burn) render_context -- Defines the rendering context. (Timeline, Conform, Effects, BFX, Batch). None for all of them. Note: Batch does not support Background Reactor (Auto) and will default to Background Reactor if (Auto) is passed.

Data
		batch = <flame.PyBatch object> browser = <flame.PyBrowser object> media_panel = <flame.PyMediaPanel object> mediahub = <flame.PyMediaHub object> messages = <flame.PyMessages object> project = <flame.PyProjectSelector object> projects = <flame.PyProjectSelector object> search = <flame.PySearch object> timeline = <flame.PyTimeline object> users = <flame.PyUsers object>

Was this information helpful?