docs » plugins.finalcutpro.text2speech


Text to Speech Plugin.

API Overview

API Documentation

Constants

COPY_TO_MEDIA_FOLDER

Signature plugins.finalcutpro.text2speech.COPY_TO_MEDIA_FOLDER
Type Constant
Description Copy to Media Folder Preferences Key.

DELETE_DELAY

Signature plugins.finalcutpro.text2speech.DELETE_DELAY
Type Constant
Description How long before a file is deleted in seconds.

Variables

addTextToNotesFieldAfterImport

Signature plugins.finalcutpro.text2speech.addTextToNotesFieldAfterImport
Type Variable
Description Option to Add Text to Notes Field After Importing

createRoleForVoice

Signature plugins.finalcutpro.text2speech.createRoleForVoice
Type Variable
Description Boolean that sets whether or not a tag should be added for the voice.

currentIncrementalNumber

Signature plugins.finalcutpro.text2speech.currentIncrementalNumber
Type Variable
Description Current Incremental Number as number

customPrefix

Signature plugins.finalcutpro.text2speech.customPrefix
Type Variable
Description String which contains the custom prefix.

deleteFileAfterImport

Signature plugins.finalcutpro.text2speech.deleteFileAfterImport
Type Variable
Description Delete File After Import

enableCustomPrefix

Signature plugins.finalcutpro.text2speech.enableCustomPrefix
Type Variable
Description Boolean that sets whether or not a custom prefix for the generated filename is enabled.

includeTextInFilename

Signature plugins.finalcutpro.text2speech.includeTextInFilename
Type Variable
Description Includes the entered text in the filename

insertIntoTimeline

Signature plugins.finalcutpro.text2speech.insertIntoTimeline
Type Variable
Description Boolean that sets whether or not new generated voice file are automatically added to the timeline or not.

path

Signature plugins.finalcutpro.text2speech.path
Type Variable
Description Text to Speech Path for generated files.

recentText

Signature plugins.finalcutpro.text2speech.recentText
Type Variable
Description Table of recent items in Text to Speech Search.

replaceSpaceWithUnderscore

Signature plugins.finalcutpro.text2speech.replaceSpaceWithUnderscore
Type Variable
Description Replace Space with Underscore

tag

Signature plugins.finalcutpro.text2speech.tag
Type Variable
Description Tag that will be added to generated voice overs.

useUnderscore

Signature plugins.finalcutpro.text2speech.useUnderscore
Type Variable
Description If true then an underscore will be used in the Custom Prefix filename otherwise a dash will be used.

voice

Signature plugins.finalcutpro.text2speech.voice
Type Variable
Description Text to Speech Voice.

Functions

chooseFolder

Signature plugins.finalcutpro.text2speech.chooseFolder() -> string or false
Type Function
Description Prompts the user to choose a folder for the Text to Speech Tool.
Parameters
  • None
Returns
  • A string of the selected path or `false` if cancelled.

insertFromPasteboard

Signature plugins.finalcutpro.text2speech.insertFromPasteboard() -> none
Type Function
Description Inserts Text to Speech by reading the Pasteboard.
Parameters
  • None
Returns
  • None

show

Signature plugins.finalcutpro.text2speech.show() -> none
Type Function
Description Shows the Text to Speech Chooser.
Parameters
  • None
Returns
  • None

results matching ""

    No results matching ""