# plugins.finalcutpro.hud.panels.rename

Batch Rename Panel for the Final Cut Pro HUD.

---

## API Overview
**Variables** - _Configurable values_
 * [code](#code)
 * [codeProcessing](#codeprocessing)
 * [find](#find)
 * [keepOriginal](#keeporiginal)
 * [padding](#padding)
 * [prefix](#prefix)
 * [replace](#replace)
 * [sequence](#sequence)
 * [startWith](#startwith)
 * [stepValue](#stepvalue)
 * [suffix](#suffix)

**Functions** - _API calls offered directly by the extension_
 * [updateInfo](#updateinfo)

---

## API Documentation

#### Variables

### [code](#code)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.code <cp.prop: string>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Code                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 84](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L84) |

---

### [codeProcessing](#codeprocessing)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.codeProcessing <cp.prop: boolean>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Code Processing                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 79](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L79) |

---

### [find](#find)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.find <cp.prop: string>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Find Preference                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 44](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L44) |

---

### [keepOriginal](#keeporiginal)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.keepOriginal <cp.prop: boolean>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Keep Original Preference                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 54](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L54) |

---

### [padding](#padding)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.padding <cp.prop: number>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Padding                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 74](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L74) |

---

### [prefix](#prefix)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.prefix <cp.prop: string>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Prefix Preference                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 34](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L34) |

---

### [replace](#replace)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.replace <cp.prop: string>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Replace Preference                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 49](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L49) |

---

### [sequence](#sequence)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.sequence <cp.prop: string>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Sequence mode                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 59](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L59) |

---

### [startWith](#startwith)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.startWith <cp.prop: number>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Start with                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 64](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L64) |

---

### [stepValue](#stepvalue)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.stepValue <cp.prop: number>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Start with                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 69](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L69) |

---

### [suffix](#suffix)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.suffix <cp.prop: string>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Suffix Preference                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 39](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L39) |

---

#### Functions

### [updateInfo](#updateinfo)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.hud.panels.rename.updateInfo() -> none`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Update the Buttons Panel HTML content.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/hud/panels/rename/init.lua line 106](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/hud/panels/rename/init.lua#L106) |

---

---

<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>