plugins.finalcutpro.text2speech

Text to Speech Plugin.

API Overview

Constants - Useful values which cannot be changed

  • copyToMediaFolder

Variables - Configurable values

  • addCaption
  • addCustomKeyword
  • addKeywordForVoiceName
  • addTextToNotesFieldAfterImport
  • assignClipAudioRoleToVoiceName
  • currentIncrementalNumber
  • customPrefix
  • deleteFileAfterImport
  • enableCustomPrefix
  • includeTextInFilename
  • insertIntoTimeline
  • path
  • recentText
  • replaceSpaceWithUnderscore
  • tag
  • useUnderscore
  • voice

Functions - API calls offered directly by the extension

  • chooseFolder
  • insertFromPasteboard
  • show

API Documentation

Constants

copyToMediaFolder

   
Signature plugins.finalcutpro.text2speech.copyToMediaFolder <cp.prop: boolean; live>
Type Constant
Description Copy to Media Folder Preferences Key.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 52

Variables

addCaption

   
Signature plugins.finalcutpro.text2speech.addCaption
Type Variable
Description Option to Add Text to Notes Field After Importing
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 82

addCustomKeyword

   
Signature plugins.finalcutpro.text2speech.addCustomKeyword
Type Variable
Description Boolean that sets whether or not to add a custom keyword.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 137

addKeywordForVoiceName

   
Signature plugins.finalcutpro.text2speech.addKeywordForVoiceName
Type Variable
Description Boolean that sets whether or not a tag should be added for the voice.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 132

addTextToNotesFieldAfterImport

   
Signature plugins.finalcutpro.text2speech.addTextToNotesFieldAfterImport
Type Variable
Description Option to Add Text to Notes Field After Importing
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 77

assignClipAudioRoleToVoiceName

   
Signature plugins.finalcutpro.text2speech.assignClipAudioRoleToVoiceName
Type Variable
Description Assign Clip Audio Role to Voice Name
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 127

currentIncrementalNumber

   
Signature plugins.finalcutpro.text2speech.currentIncrementalNumber
Type Variable
Description Current Incremental Number as number
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 62

customPrefix

   
Signature plugins.finalcutpro.text2speech.customPrefix
Type Variable
Description String which contains the custom prefix.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 117

deleteFileAfterImport

   
Signature plugins.finalcutpro.text2speech.deleteFileAfterImport
Type Variable
Description Delete File After Import
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 87

enableCustomPrefix

   
Signature plugins.finalcutpro.text2speech.enableCustomPrefix
Type Variable
Description Boolean that sets whether or not a custom prefix for the generated filename is enabled.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 112

includeTextInFilename

   
Signature plugins.finalcutpro.text2speech.includeTextInFilename
Type Variable
Description Includes the entered text in the filename
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 67

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.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 107

path

   
Signature plugins.finalcutpro.text2speech.path
Type Variable
Description Text to Speech Path for generated files.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 92

recentText

   
Signature plugins.finalcutpro.text2speech.recentText
Type Variable
Description Table of recent items in Text to Speech Search.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 57

replaceSpaceWithUnderscore

   
Signature plugins.finalcutpro.text2speech.replaceSpaceWithUnderscore
Type Variable
Description Replace Space with Underscore
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 72

tag

   
Signature plugins.finalcutpro.text2speech.tag
Type Variable
Description Tag that will be added to generated voice overs.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 102

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.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 122

voice

   
Signature plugins.finalcutpro.text2speech.voice
Type Variable
Description Text to Speech Voice.
Notes None
Source src/plugins/finalcutpro/text2speech/init.lua line 97

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.
Notes None
Examples None
Source src/plugins/finalcutpro/text2speech/init.lua line 142

insertFromPasteboard

   
Signature plugins.finalcutpro.text2speech.insertFromPasteboard() -> none
Type Function
Description Inserts Text to Speech by reading the Pasteboard.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/text2speech/init.lua line 1121

show

   
Signature plugins.finalcutpro.text2speech.show() -> none
Type Function
Description Shows the Text to Speech Chooser.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/finalcutpro/text2speech/init.lua line 1063

© Copyright 2026 LateNite Films Pty Ltd. All rights reserved.