Python API

2D Histogram

Command	Type	Description
<PyNode>.lift	Attribute	Used to get or set the lift parameter of a 2D Histogram node. A float value between -5000.0 and 5000.0 must be passed as an argument when the attribute is set.
<PyNode>.gain	Attribute	Used to get or set the gain parameter of a 2D Histogram node. A float value between 0.0 and 10.0 must be passed as an argument when the attribute is set. Note: In the user interface, the gain value is presented between 0.0 and 1000.0 because the value is multiplied by 100 before it is displayed.
<PyNode>.min_input	Attribute	Used to get or set the minimum input parameter of a 2D Histogram node. A float value must be passed as an argument when the attribute is set. The value range depends on the bit depth of the Front input. 8-bit: A float value between 0.0 and 255.0 must be passed. All other bit depths: A float value between -65504.0 and 65504.0 must be passed.
<PyNode>.max_input	Attribute	Used to get or set the maximum input parameter of a 2D Histogram node. A float value must be passed as an argument when the attribute is set. The value range depends on the bit depth of the Front input. 8-bit: A float value between 0.0 and 255.0 must be passed. All other bit depths: A float value between -65504.0 and 65504.0 must be passed.
<PyNode>.min_output	Attribute	Used to get or set the minimum output parameter of a 2D Histogram node. A float value must be passed as an argument when the attribute is set. The value range depends on the bit depth of the Front input. 8-bit: A float value between 0.0 and 255.0 must be passed. All other bit depths: A float value between -65504.0 and 65504.0 must be passed.
<PyNode>.max_output	Attribute	Used to get or set the maximum output parameter of a 2D Histogram node. A float value must be passed as an argument when the attribute is set. The value range depends on the bit depth of the Front input. 8-bit: A float value between 0.0 and 255.0 must be passed. All other bit depths: A float value between -65504.0 and 65504.0 must be passed.
<PyNode>.clamp_output	Attribute	Used to get or set the clamp output parameter of a 2D Histogram node. One of the following must be passed as an argument when the attribute is set. No Clamp Clamp Neg Clamp
<PyNode>.zoom	Attribute	Used to get or set the histogram zoom parameter of a 2D Histogram node. An integer value between 0 and 100 must be passed as an argument when the attribute is set.

Blur

Attributes

Attribute	Type	Description	Values
<PyNode>.blend_mode	String	The Blend Mode option.	Blend Non Additive Inv Non Add Min/Darken Multiply Max/Lighten Screen Add Overlay Soft Light Hard Light Difference Exclusion Subtract Divide And Nand AndRev AndInv Or Nor OrRev OrInv Xor Xnor
<PyNode>.blooming_amount	Float	The Blooming Amount value of the Defocus Blur Type option.	In Basic Blooming: Minimum = 0.10 Maximum = 10.0 In Additive Blooming: Minimum = 0.0 Maximum = 100.0
<PyNode>.blooming_option	String	The Blooming option of the Defocus Blur Type option.	Basic Additive
<PyNode>.blue_pos_x	Float	The Blue Position X value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.blue_pos_y	Float	The Blue Position Y value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.blue_weight	Float	The Blue Weight value.	Minimum = 0.0 Maximum = 100.0
<PyNode>.blur_colour_space	String	The Colour Space option.	RGB YUV
<PyNode>.blur_type	String	The Blur Type option.	Box Gaussian Defocus Directional Radial Radial Stamp
<PyNode>.bokeh_blur_amount	Float	The Bokeh Blur Amount value of the Defocus Blur Type option.	Minimum = 0.0 Maximum = 100.0
<PyNode>.bokeh_type	Bool	The Bokeh Type option of the Defocus Blur Type option.	True False
<PyNode>.centre_x	Float	The Centre X value of the Radial and Radial Stamp Blur Type options.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.centre_y	Float	The Centre Y value of the Radial and Radial Stamp Blur Type options.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.clamp	Bool	Whether to clamp 16-bit floating-point input values.	True False
<PyNode>.clamp_render	String	The Clamp Render option.	No Clamp Clamp Negative Clamp
<PyNode>.defocus_height	Float	The Height value of the Defocus Blur Type option.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.defocus_kernel_curvature	Float	The Kernel Curvature value of the Defocus Blur Type option.	Minimum = -1.0 Maximum = 1.0
<PyNode>.defocus_kernel_rotation	Float	The Kernel Rotation value of the Defocus Blur Type option.	Minimum = -360.0 Maximum = 360.0
<PyNode>.defocus_kernel_sides	Float	The Kernel Sides value of the Defocus Blur Type option.	Minimum = 3.0 Maximum = 30.0
<PyNode>.defocus_matte_height	Float	The Matte Height value of the Defocus Blur Type option.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.defocus_matte_width	Float	The Matte Width value of the Defocus Blur Type option.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.defocus_rendering	String	The Defocus Rendering option.	Horizontal Vertical
<PyNode>.defocus_width	Float	The Width value of the Defocus Blur Type option.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.directional_angle	Float	The Directional Angle value of the Directional Blur Type option.	Minimum = -10000.0 Maximum = 10000.0
<PyNode>.directional_bias	Float	The Bias value of the Directional Blur Type option.	Minimum = -1.0 Maximum = 1.0
<PyNode>.directional_length	Float	The Directional Length value of the Directional Blur Type option.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.directional_matte_angle	Float	The Matte Angle value of the Directional Blur Type option.	Minimum = -10000.0 Maximum = 10000.0
<PyNode>.directional_matte_length	Float	The Matte Length value of the Directional Blur Type option.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.gain	Integer	The Gain value.	Minimum = 0.0 Maximum = 1000.0
<PyNode>.green_pos_x	Float	The Green Position X value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.green_pos_y	Float	The Green Position Y value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.green_weight	Float	The Green Weight value.	Minimum = 0.0 Maximum = 100.0
<PyNode>.height	Float	The Height value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.invert_matte	Bool	Whether to invert the matte, blurring the region outside it.	True False
<PyNode>.lock_to_front	Bool	Whether to keep the matte values the same as the front clip's values.	True False
<PyNode>.matte_height	Float	The Matte Height value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.matte_width	Float	The Matte Width value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.offset	Float	The Offset value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.offset_x	Float	The Offset X value of the Radial and Radial Stamp Blur Type options.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.offset_y	Float	The Offset Y value of the Radial and Radial Stamp Blur Type options.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.radial_amount	Float	The Radial Amount value of the Radial and Radial Stamp Blur Type options.	Minimum = -500.0 Maximum = 500.0
<PyNode>.radial_matte_amount	Float	The Matte Amount value of the Radial and Radial Stamp Blur Type options.	Minimum = -500.0 Maximum = 500.0
<PyNode>.radial_matte_rotation	Float	The Matte Rotation value of the Radial and Radial Stamp Blur Type options.	Minimum = -10000.0 Maximum = 10000.0
<PyNode>.radial_mode	String	The Radial Mode option of the Radial Blur Type option.	Twist Spin
<PyNode>.radial_rotation	Float	The Radial Rotation value of the Radial and Radial Stamp Blur Type options.	Minimum = -10000.0 Maximum = 10000.0
<PyNode>.radial_rotation_bias	Float	The Bias value of the Radial Stamp Blur Type option.	Minimum = -1.0 Maximum = 1.0
<PyNode>.radial_samples	Integer	The Samples value of the Radial Stamp Blur Type option.	Minimum = 1 Maximum = 500
<PyNode>.red_pos_x	Float	The Red Position X value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.red_pos_y	Float	The Red Position Y value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.red_weight	Float	The Red Weight value.	Minimum = 0.0 Maximum = 100.0
<PyNode>.regen	Bool	Whether to update the image as a parameter is modified.	True False
<PyNode>.rendering_mode	String	The Rendering Mode option.	Progressive Interlaced Auto
<PyNode>.transparency	Float	The Transparency value.	Minimum = 0.0 Maximum = 100.0
<PyNode>.u_weight	Float	The U Weight value.	Minimum = 0.0 Maximum = 100.0
<PyNode>.use_matte	Bool	Whether to apply the blur within the matte area.	True False
<PyNode>.v_weight	Float	The V Weight value.	Minimum = 0.0 Maximum = 100.0
<PyNode>.width	Float	The Width value.	The Minimum and Maximum values depend on the resolution of the input.
<PyNode>.y_weight	Float	The Y Weight value.	Minimum = 0.0 Maximum = 100.0
<PyNode>.yuv_option	String	The YUV Colour option.	Affect Chroma & Luma Affect Chroma Only Affect Luma Only

Colour Correct

Command	Type	Description
<PyNode>.range	Attribute	Used to get or set the Range parameter of a Colour Correct node. One of the following must be passed as an argument when the attribute is set: Master Shadows Midtones Highlights
<PyNode>.rewire_mode	Attribute	Used to get or set the Rewire mode of a Colour Correct node. One of the following must be passed as an argument when the attribute is set: Rewire Mono Negative
<PyNode>.rewire_red	Attribute	Used to get or set the Red Channel's Rewire mode of a Colour Correct node. One of the following must be passed as an argument when the attribute is set: R <- R R <- G R <- B R <- Y R <- 1-R
<PyNode>.rewire_green	Attribute	Used to get or set the Green Channel's Rewire mode of a Colour Correct node. One of the following must be passed as an argument when the attribute is set: G <- R G <- G G <- B G <- Y G <- 1-G
<PyNode>.rewire_blue	Attribute	Used to get or set the Blue Channel's Rewire mode of a Colour Correct node. One of the following must be passed as an argument when the attribute is set: B <- R B <- G B <- B B <- Y B <- 1-B
<PyNode>.hue	Attribute	Used to get or set the Hue parameter of a Colour Correct node. An integer number between -9999 and 9999 must be passed as an argument when the attribute is set.
<PyNode>.saturation	Attribute	Used to get or set the Saturation parameter of a Colour Correct node. A float number between -1000.0 and 1000.0 must be passed as an argument when the attribute is set.
<PyNode>.pivot	Attribute	Used to get or set the Pivot parameter of a Colour Correct node. A float number between 0.0 and 100.0 must be passed as an argument when the attribute is set.
<PyNode>.balance_gain	Attribute	Used to get or set the Balance Gain parameter of a Colour Correct node. A float number between 0.0 and 10000.0 must be passed as an argument when the attribute is set.
<PyNode>.balance_hue	Attribute	Used to get or set the Balance Hue parameter of a Colour Correct node. An integer number between -9999 and 9999 must be passed as an argument when the attribute is set.
<PyNode>.gamma	Attribute	Used to get or set the RGB Gamma parameter of a Colour Correct node. A float number between 0.1 and 10.0 must be passed as an argument when the attribute is set.
<PyNode>.red_gamma	Attribute	Used to get or set the Red Gamma parameter of a Colour Correct node. A float number between 0.1 and 10.0 must be passed as an argument when the attribute is set.
<PyNode>.green_gamma	Attribute	Used to get or set the Green Gamma parameter of a Colour Correct node. A float number between 0.1 and 10.0 must be passed as an argument when the attribute is set.
<PyNode>.blue_gamma	Attribute	Used to get or set the Blue Gamma parameter of a Colour Correct node. A float number between 0.1 and 10.0 must be passed as an argument when the attribute is set.
<PyNode>.gain	Attribute	Used to get or set the RGB Gain parameter of a Colour Correct node. A float number between 0.0 and 10000.0 must be passed as an argument when the attribute is set.
<PyNode>.red_gain	Attribute	Used to get or set the Red Gain parameter of a Colour Correct node. A float number between 0.0 and 10000.0 must be passed as an argument when the attribute is set.
<PyNode>.green_gain	Attribute	Used to get or set the Green Gain parameter of a Colour Correct node. A float number between 0.0 and 10000.0 must be passed as an argument when the attribute is set.
<PyNode>.blue_gain	Attribute	Used to get or set the Blue Gain parameter of a Colour Correct node. A float number between 0.0 and 10000.0 must be passed as an argument when the attribute is set.
<PyNode>.offset	Attribute	Used to get or set the RGB Offset parameter of a Colour Correct node. A float number must be passed as an argument. The minimum and maximum values depend on the bit depth of the clip connected to the Front input.
<PyNode>.red_offset	Attribute	Used to get or set the Red Offset parameter of a Colour Correct node. A float number must be passed as an argument. The minimum and maximum values depend on the bit depth of the clip connected to the Front input.
<PyNode>.green_offset	Attribute	Used to get or set the Green Offset parameter of a Colour Correct node. A float number must be passed as an argument. The minimum and maximum values depend on the bit depth of the clip connected to the Front input.
<PyNode>.blue_offset	Attribute	Used to get or set the Blue Offset parameter of a Colour Correct node. A float number must be passed as an argument. The minimum and maximum values depend on the bit depth of the clip connected to the Front input.
<PyNode>.contrast	Attribute	Used to get or set the RGB Contrast parameter of a Colour Correct node. A float number between -1000.0 and 1000.0 must be passed as an argument when the attribute is set.
<PyNode>.red_contrast	Attribute	Used to get or set the Red Contrast parameter of a Colour Correct node. A float number between -1000.0 and 1000.0 must be passed as an argument when the attribute is set.
<PyNode>.green_contrast	Attribute	Used to get or set the Green Contrast parameter of a Colour Correct node. A float number between -1000.0 and 1000.0 must be passed as an argument when the attribute is set.
<PyNode>.blue_contrast	Attribute	Used to get or set the Blue Contrast parameter of a Colour Correct node. A float number between -1000.0 and 1000.0 must be passed as an argument when the attribute is set.
<PyNode>.suppress_red	Attribute	Used to get or set the Red Suppression parameter of a Colour Correct node. True or False must be passed as an argument when the attribute is set.
<PyNode>.suppress_green	Attribute	Used to get or set the Green Suppression parameter of a Colour Correct node. True or False must be passed as an argument when the attribute is set.
<PyNode>.suppress_blue	Attribute	Used to get or set the Blue Suppression parameter of a Colour Correct node. True or False must be passed as an argument when the attribute is set.
<PyNode>.suppress_cyan	Attribute	Used to get or set the Cyan Suppression parameter of a Colour Correct node. True or False must be passed as an argument when the attribute is set.
<PyNode>.suppress_magenta	Attribute	Used to get or set the Magenta Suppression parameter of a Colour Correct node. True or False must be passed as an argument when the attribute is set.
<PyNode>.suppress_yellow	Attribute	Used to get or set the Yellow Suppression parameter of a Colour Correct node. True or False must be passed as an argument when the attribute is set.
<PyNode>.min_input	Attribute	Used to get or set the Histogram's Minimum Input parameter of a Colour Correct node. A float number must be passed as an argument. The minimum and maximum values depend on the bit depth of the clip connected to the Front input.
<PyNode>.min_output	Attribute	Used to get or set the Histogram's Minimum Output parameter of a Colour Correct node. A float number must be passed as an argument. The minimum and maximum values depend on the bit depth of the clip connected to the Front input.
<PyNode>.max_input	Attribute	Used to get or set the Histogram's Maximum Input parameter of a Colour Correct node. A float number must be passed as an argument. The minimum and maximum values depend on the bit depth of the clip connected to the Front input.
<PyNode>.max_output	Attribute	Used to get or set the Histogram's Maximum Output parameter of a Colour Correct node. A float number must be passed as an argument. The minimum and maximum values depend on the bit depth of the clip connected to the Front input.
<PyNode>.out_range	Attribute	Used to get or set the Out Range parameter of a Colour Correct node. One of the following must be passed as an argument when the attribute is set: No Clamp Clamp Neg Clamp
<PyNode>.regen	Attribute	Used to get or set the Regen parameter of a Colour Correct node. True or False must be passed as an argument when the attribute is set.
<PyNode>.invert_matte	Attribute	Used to get or set the Invert Matte parameter of a Colour Correct node. True or False must be passed as an argument when the attribute is set.

Colour Source

Command	Type	Description	Values
<PyNode>.colour_space	Attribute	The Tagged Colour Space.	A string corresponding to a valid colour space.

Field Merge

Command	Type	Description
<PyNode>.level	Attribute	Used to get or set the Level parameter of a Field Merge node. An integer number between 0 and 100 must be passed as an argument when the attribute is set.

Flip

Command	Type	Description
<PyNode>.orientation	Attribute	Used to get or set the Orientation parameter of a Flip node. One of the following must be passed as an argument when the attribute is set. Flip Flop Flip Flop
<PyNode>.dominance	Attribute	Used to get or set the Dominance parameter of a Flip node. One of the following must be passed as an argument when the attribute is set. Reverse Shift Lines

Interlace

Command	Type	Description
<PyNode>.dominance	Attribute	Used to get or set the Dominance parameter of an Interlace node. One of the following must be passed as an argument when the attribute is set. Field 1 Field 2

Pixel Expression

Attributes

Attribute	Type	Description	Values
<PyNode>.blue_expression	String	The Blue channel GLSL expression. For a multiline string, the last line is the expression; any preceding lines form the declaration block.
<PyNode>.centre_x_normalize	Float	The Centre X value, normalised 0-1 relative to the output width.	Minimum = -10.0 Maximum = 10.0
<PyNode>.centre_x_pixel	Float	The Centre X value, in pixels.	Minimum = -1000000.0 Maximum = 1000000.0
<PyNode>.centre_y_normalize	Float	The Centre Y value, normalised 0-1 relative to the output height.	Minimum = -10.0 Maximum = 10.0
<PyNode>.centre_y_pixel	Float	The Centre Y value, in pixels.	Minimum = -1000000.0 Maximum = 1000000.0
<PyNode>.formula_1_expression	String	The GLSL expression for the Formula at slot 1.
<PyNode>.formula_1_name	String	The Formula name at slot 1.
<PyNode>.formula_1_type	String	The Formula option at slot 1.	float vec2 vec3 vec4
<PyNode>.formula_2_expression	String	The GLSL expression for the Formula at slot 2.
<PyNode>.formula_2_name	String	The Formula name at slot 2.
<PyNode>.formula_2_type	String	The Formula option at slot 2.	float vec2 vec3 vec4
<PyNode>.formula_3_expression	String	The GLSL expression for the Formula at slot 3.
<PyNode>.formula_3_name	String	The Formula name at slot 3.
<PyNode>.formula_3_type	String	The Formula option at slot 3.	float vec2 vec3 vec4
<PyNode>.formula_4_expression	String	The GLSL expression for the Formula at slot 4.
<PyNode>.formula_4_name	String	The Formula name at slot 4.
<PyNode>.formula_4_type	String	The Formula option at slot 4.	float vec2 vec3 vec4
<PyNode>.green_expression	String	The Green channel GLSL expression. For a multiline string, the last line is the expression; any preceding lines form the declaration block.
<PyNode>.matte_expression	String	The Matte channel GLSL expression. For a multiline string, the last line is the expression; any preceding lines form the declaration block.
<PyNode>.red_expression	String	The Red channel GLSL expression. For a multiline string, the last line is the expression; any preceding lines form the declaration block.
<PyNode>.show_icon	Bool	Whether the Centre manipulator is shown in the viewer.	True False
<PyNode>.variable_1_name	String	The Custom Variable name at slot 1. An empty string ("") removes the variable.
<PyNode>.variable_1_value	Float	The Custom Variable value at slot 1. Raises an exception if the corresponding name has not been set.	Minimum = -5000.0 Maximum = 5000.0
<PyNode>.variable_2_name	String	The Custom Variable name at slot 2. An empty string ("") removes the variable.
<PyNode>.variable_2_value	Float	The Custom Variable value at slot 2. Raises an exception if the corresponding name has not been set.	Minimum = -5000.0 Maximum = 5000.0
<PyNode>.variable_3_name	String	The Custom Variable name at slot 3. An empty string ("") removes the variable.
<PyNode>.variable_3_value	Float	The Custom Variable value at slot 3. Raises an exception if the corresponding name has not been set.	Minimum = -5000.0 Maximum = 5000.0
<PyNode>.variable_4_name	String	The Custom Variable name at slot 4. An empty string ("") removes the variable.
<PyNode>.variable_4_value	Float	The Custom Variable value at slot 4. Raises an exception if the corresponding name has not been set.	Minimum = -5000.0 Maximum = 5000.0
<PyNode>.variable_5_name	String	The Custom Variable name at slot 5. An empty string ("") removes the variable.
<PyNode>.variable_5_value	Float	The Custom Variable value at slot 6. Raises an exception if the corresponding name has not been set.	Minimum = -5000.0 Maximum = 5000.0
<PyNode>.variable_6_name	String	The Custom Variable name at slot 6. An empty string ("") removes the variable.
<PyNode>.variable_6_value	Float	The Custom Variable value at slot 6. Raises an exception if the corresponding name has not been set.	Minimum = -5000.0 Maximum = 5000.0
<PyNode>.variable_7_name	String	The Custom Variable name at slot 7. An empty string ("") removes the variable.
<PyNode>.variable_7_value	Float	The Custom Variable value at slot 7. Raises an exception if the corresponding name has not been set.	Minimum = -5000.0 Maximum = 5000.0
<PyNode>.variable_8_name	String	The Custom Variable name at slot 8. An empty string ("") removes the variable.
<PyNode>.variable_8_value	Float	The Custom Variable value at slot 8. Raises an exception if the corresponding name has not been set.	Minimum = -5000.0 Maximum = 5000.0

Posterize

Command	Type	Description
<PyNode>.levels	Attribute	Used to get or set the Levels parameter of a Posterize node. An integer number between 1 and 255 must be passed as an argument when the attribute is set.
<PyNode>.channel	Attribute	Used to get or set the Channel parameter of a Posterize node. One of the following must be passed as an argument when the attribute is set. Chroma Luma Luma & Chroma

PyClip / PySequence

Command	Type	Description
<PySegment>.hard_commit_selection()	Function	Used to hard commit a contiguous selection of timeline segments into a single segment.

PyMarker

Command	Type	Description
<PyMarker>.sync_connected_segments()	Function	Use the scope argument to select which sequences are affected by the Sync Connected Segments operation. One of the following must be passed as an argument: All Reels in Reel Group Current Reel Opened Sequences Current Sequence Selected Sequences

PySegment

Command	Type	Description
<PySegment>.consolidate()	Function	Used to consolidate the handles of a timeline segment. One mandatory and one optional arguments must be passed. amount (mandatory): An integer number between 0 and 10 000 representing the amount of handles to keep. sync (optional): A bool dictating if the timeline segments part of the same sync group are affected or not. True or False must be passed.
<PySegment>.hard_commit()	Function	Used to hard commit a timeline segment.

PyTimelineFX

Command	Type	Description
<PyTimelineFX>.sync_connected_segments()	Function	Use the scope argument to select which sequences are affected by the Sync Connected Segments operation. One of the following must be passed as an argument: All Reels in Reel Group Current Reel Opened Sequences Current Sequence Selected Sequences

flame.timeline

Command	Type	Description
flame.timeline.home()	Function	Used to change the framing of the segments in the timeline. One of the following can be passed as the mode argument. Home Reset Height Fit to Width Fit Selection When no argument is set, Home is performed.