# 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](#addspaceaftersequence)
 * [duration](#duration)
 * [mergeWithExistingEvent](#mergewithexistingevent)
 * [padding](#padding)
 * [prefix](#prefix)
 * [removeProjectFromEvent](#removeprojectfromevent)
 * [replaceCommasWithAlternativeCommas](#replacecommaswithalternativecommas)
 * [startOrEnd](#startorend)
 * [startWith](#startwith)
 * [stepValue](#stepvalue)
 * [suffix](#suffix)
 * [textEditor](#texteditor)
 * [textEditorTwo](#texteditortwo)
 * [treatFavoriteAndRejectAsRatingsInsteadOfKeywords](#treatfavoriteandrejectasratingsinsteadofkeywords)
 * [useTitleContentsInsteadOfTitleName](#usetitlecontentsinsteadoftitlename)

---

## API Documentation

#### Fields

### [addSpaceAfterSequence](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L54) |

---

### [duration](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L114) |

---

### [mergeWithExistingEvent](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L74) |

---

### [padding](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L124) |

---

### [prefix](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L94) |

---

### [removeProjectFromEvent](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L69) |

---

### [replaceCommasWithAlternativeCommas](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L64) |

---

### [startOrEnd](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L104) |

---

### [startWith](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L109) |

---

### [stepValue](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L119) |

---

### [suffix](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L99) |

---

### [textEditor](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L84) |

---

### [textEditorTwo](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L89) |

---

### [treatFavoriteAndRejectAsRatingsInsteadOfKeywords](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L59) |

---

### [useTitleContentsInsteadOfTitleName](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/toolbox/titlestokeywords/init.lua#L79) |

---

---

<script src="https://giscus.app/client.js"
        data-repo="CommandPost/CommandPost"
        data-repo-id="MDEwOlJlcG9zaXRvcnk3NDY0NTk2NQ=="
        data-category="Website Discussion"
        data-category-id="DIC_kwDOBHMBzc4CXFFA"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="dark"
        data-lang="en"
        crossorigin="anonymous"
        async>
</script>