# plugins.finalcutpro.toolbox.titlestokeywords

Converts Titles to Keywords


# API Overview

Fields - Variables which can only be accessed from an object returned by a constructor

  • addSpaceAfterSequence
  • duration
  • mergeWithExistingEvent
  • padding
  • prefix
  • removeProjectFromEvent
  • replaceCommasWithAlternativeCommas
  • startOrEnd
  • startWith
  • stepValue
  • suffix
  • textEditor
  • textEditorTwo
  • treatFavoriteAndRejectAsRatingsInsteadOfKeywords
  • useTitleContentsInsteadOfTitleName

# API Documentation

# Fields

# addSpaceAfterSequence

Signature plugins.finalcutpro.toolbox.titlestokeywords.addSpaceAfterSequence <cp.prop: boolean>
Type Field
Description Add Space After Sequence
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 54

# duration

Signature plugins.finalcutpro.toolbox.titlestokeywords.duration <cp.prop: string>
Type Field
Description Duration of the titles created by "Create Titles from Text"
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 114

# mergeWithExistingEvent

Signature plugins.finalcutpro.toolbox.titlestokeywords.mergeWithExistingEvent <cp.prop: boolean>
Type Field
Description Merge With Existing Event?
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 74

# padding

Signature plugins.finalcutpro.toolbox.titlestokeywords.padding <cp.prop: string>
Type Field
Description Last Padding Value
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 124

# prefix

Signature plugins.finalcutpro.toolbox.titlestokeywords.prefix <cp.prop: string>
Type Field
Description Last Prefix Value
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 94

# removeProjectFromEvent

Signature plugins.finalcutpro.toolbox.titlestokeywords.removeProjectFromEvent <cp.prop: boolean>
Type Field
Description Remove Project from Event
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 69

# replaceCommasWithAlternativeCommas

Signature plugins.finalcutpro.toolbox.titlestokeywords.replaceCommasWithAlternativeCommas <cp.prop: boolean>
Type Field
Description Remove Project from Event
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 64

# startOrEnd

Signature plugins.finalcutpro.toolbox.titlestokeywords.startOrEnd <cp.prop: string>
Type Field
Description Last Start or End Value
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 104

# startWith

Signature plugins.finalcutpro.toolbox.titlestokeywords.startWith <cp.prop: string>
Type Field
Description Last Start With Value
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 109

# stepValue

Signature plugins.finalcutpro.toolbox.titlestokeywords.stepValue <cp.prop: string>
Type Field
Description Last Step With Value
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 119

# suffix

Signature plugins.finalcutpro.toolbox.titlestokeywords.suffix <cp.prop: string>
Type Field
Description Last Suffix Value
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 99

# textEditor

Signature plugins.finalcutpro.toolbox.titlestokeywords.textEditor <cp.prop: string>
Type Field
Description Last Text Editor Value
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 84

# textEditorTwo

Signature plugins.finalcutpro.toolbox.titlestokeywords.textEditorTwo <cp.prop: string>
Type Field
Description Last Text Editor Two Value
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 89

# treatFavoriteAndRejectAsRatingsInsteadOfKeywords

Signature plugins.finalcutpro.toolbox.titlestokeywords.treatFavoriteAndRejectAsRatingsInsteadOfKeywords <cp.prop: boolean>
Type Field
Description Treat FAVORITE and REJECT as ratings instead of keywords
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 59

# useTitleContentsInsteadOfTitleName

Signature plugins.finalcutpro.toolbox.titlestokeywords.useTitleContentsInsteadOfTitleName <cp.prop: boolean>
Type Field
Description Use Title Contents Instead of Title Name?
Notes None
Source src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua line 79