Skip to content

Commit

Permalink
fix header name
Browse files Browse the repository at this point in the history
  • Loading branch information
rendertom committed Aug 18, 2020
1 parent 1c18f56 commit 1124fab
Showing 1 changed file with 41 additions and 41 deletions.
82 changes: 41 additions & 41 deletions 3 - Project object/project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,47 @@ Returns 0 if successful.

----

.. _project.exportOMF:

exportOMF()
*********************************************

``project.exportOMF(sequence, outputPath, omfTitle, sampleRate, bitsPerSample, audioEncapsulated, audioFileFormat, trimAudioFiles, handleFrames, includePan)``

**Description**

Exports an OMF file of the specified sequence, using the specified settings.

**Parameters**

+----------------------------+---------------------------------------------------+
| ``sequence`` | Specifies the sequence to be output. |
+----------------------------+---------------------------------------------------+
| ``filePath`` | Complete output path for .omf file. |
+----------------------------+---------------------------------------------------+
| ``omfTitle`` | **String** with which to title the OMF. |
+----------------------------+---------------------------------------------------+
| ``sampleRate`` | Specifies the sample rate of output audio. |
+----------------------------+---------------------------------------------------+
| ``bitsPerSample`` | Specifies the bits per sample of audio output. |
+----------------------------+---------------------------------------------------+
| ``audioEncapsulated`` | If **1**, audio is embedded, if **0**, external. |
+----------------------------+---------------------------------------------------+
| ``audioFileFormat`` | **0** is AIFF, **1** is WAV. |
+----------------------------+---------------------------------------------------+
| ``trimAudioFiles`` | **1** means yes, trim audio files. |
+----------------------------+---------------------------------------------------+
| ``handleFrames`` | Number of handle frames (from 0 to 1000). |
+----------------------------+---------------------------------------------------+
| ``includePan`` | **1** means include pan info; **0** means don't. |
+----------------------------+---------------------------------------------------+

**Returns**

Returns **0** if successful.

----

.. _project.exportTimeline:

exportTimeline()
Expand Down Expand Up @@ -678,47 +719,6 @@ Returns **0** if successful.

----

.. _project.exportOMF:

project.exportOMF()
*********************************************

``project.exportOMF(sequence, outputPath, omfTitle, sampleRate, bitsPerSample, audioEncapsulated, audioFileFormat, trimAudioFiles, handleFrames, includePan)``

**Description**

Exports an OMF file of the specified sequence, using the specified settings.

**Parameters**

+----------------------------+---------------------------------------------------+
| ``sequence`` | Specifies the sequence to be output. |
+----------------------------+---------------------------------------------------+
| ``filePath`` | Complete output path for .omf file. |
+----------------------------+---------------------------------------------------+
| ``omfTitle`` | **String** with which to title the OMF. |
+----------------------------+---------------------------------------------------+
| ``sampleRate`` | Specifies the sample rate of output audio. |
+----------------------------+---------------------------------------------------+
| ``bitsPerSample`` | Specifies the bits per sample of audio output. |
+----------------------------+---------------------------------------------------+
| ``audioEncapsulated`` | If **1**, audio is embedded, if **0**, external. |
+----------------------------+---------------------------------------------------+
| ``audioFileFormat`` | **0** is AIFF, **1** is WAV. |
+----------------------------+---------------------------------------------------+
| ``trimAudioFiles`` | **1** means yes, trim audio files. |
+----------------------------+---------------------------------------------------+
| ``handleFrames`` | Number of handle frames (from 0 to 1000). |
+----------------------------+---------------------------------------------------+
| ``includePan`` | **1** means include pan info; **0** means don't. |
+----------------------------+---------------------------------------------------+

**Returns**

Returns **0** if successful.

----

.. _project.save:

save()
Expand Down

0 comments on commit 1124fab

Please sign in to comment.