# plugins.finalcutpro.timeline.matchframe

Match Frame Tools for Final Cut Pro.

---

## API Overview
**Variables** - _Configurable values_
 * [hiddenKeywords](#hiddenkeywords)

**Functions** - _API calls offered directly by the extension_
 * [getMulticamAngleFromSelectedClip](#getmulticamanglefromselectedclip)
 * [matchFrame](#matchframe)
 * [multicamMatchFrame](#multicammatchframe)

---

## API Documentation

#### Variables

### [hiddenKeywords](#hiddenkeywords)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.timeline.matchframe.hiddenKeywords <cp.prop: table>`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Favourite Keywords                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/timeline/matchframe.lua line 37](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/timeline/matchframe.lua#L37) |

---

#### Functions

### [getMulticamAngleFromSelectedClip](#getmulticamanglefromselectedclip)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.timeline.matchframe.getMulticamAngleFromSelectedClip() -> angle | boolean`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Get Multicam Angle From Selected Clip                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>Angle or `false` on error</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/timeline/matchframe.lua line 153](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/timeline/matchframe.lua#L153) |

---

### [matchFrame](#matchframe)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.timeline.matchframe.matchFrame() -> none`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Performs a Single Match Frame.                                                                     |
| **Parameters**                              | <ul><li>`focus`  - If set to `true`, the library will search for the matched clip title</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/timeline/matchframe.lua line 291](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/timeline/matchframe.lua#L291) |

---

### [multicamMatchFrame](#multicammatchframe)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.timeline.matchframe.multicamMatchFrame(goBackToTimeline) -> none`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Multicam Match Frame                                                                     |
| **Parameters**                              | <ul><li>goBackToTimeline - `true` if you want to go back to the timeline after opening the clip in the Multicam Editor</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/timeline/matchframe.lua line 42](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/timeline/matchframe.lua#L42) |

---

---

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