Auto-reframe sequence

Added documentation for autoReframeSequence().
docsforadobe · Apr 30, 2020 · 6e4cc0f · 6e4cc0f
1 parent b8d8c04
commit 6e4cc0f
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/5 - Sequence object/sequence.rst b/5 - Sequence object/sequence.rst
@@ -753,3 +753,34 @@ Performs cut detection on the sequence selection.
 **Returns**
 
 Returns `true` if successful.
+
+----
+
+.. _sequence.autoReframeSequence:
+
+autoReframeSequence()
+*******************************************************************************************************
+
+``sequence.autoReframeSequence(numerator, denominator, motionPreset, newName, useNestedSequences);``
+
+**Description**
+
+Generates a new, auto-reframed sequence. 
+
+**Parameters**
+
++----------------------------+------------------------------------------------------------------------+
+| ``numerator``              | Numerator of desired frame aspect ratio.                               |
++----------------------------+------------------------------------------------------------------------+
+| ``denominator``            | Denominator of desired frame aspect ratio.                             |
++----------------------------+------------------------------------------------------------------------+
+| ``motionPreset``           | Valid values: `'slower'`, `'default'`, or `'faster'` motion.           |
++----------------------------+------------------------------------------------------------------------+
+| ``newName``                | Name for newly-created sequence.                                       |
++----------------------------+------------------------------------------------------------------------+
+| ``useNestedSequences``     | Boolean indicating whether to honor nested sequence.                   |
++----------------------------+------------------------------------------------------------------------+
+
+**Returns**
+
+Returns the new Sequence object, if successful; `0` if unsuccessful.