# cp.apple.finalcutpro.main.PrimaryWindow Primary Window Module. --- ## API Overview **Functions** - _API calls offered directly by the extension_ * [matches](#matches) **Constructors** - _API calls which return an object, typically one that offers API methods_ * [PrimaryWindow](#primarywindow) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [alert](#alert) * [bottomGroupUI](#bottomgroupui) * [browserGroupUI](#browsergroupui) * [colorBoard](#colorboard) * [doShow](#doshow) * [frame](#frame) * [hsWindow](#hswindow) * [inspector](#inspector) * [isFullScreen](#isfullscreen) * [isShowing](#isshowing) * [leftGroupUI](#leftgroupui) * [rightGroupUI](#rightgroupui) * [rootGroupUI](#rootgroupui) * [timelineGroupUI](#timelinegroupui) * [toolbar](#toolbar) * [topGroupUI](#topgroupui) * [UI](#ui) * [viewerGroupUI](#viewergroupui) * [window](#window) **Methods** - _API calls which can only be made on an object returned by a constructor_ * [app](#app) * [show](#show) --- ## API Documentation #### Functions ### [matches](#matches) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.matches(w) -> boolean` | | **Type** | Function | | **Description** | Checks to see if a window matches the PrimaryWindow requirements | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 24](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L24) | --- #### Constructors ### [PrimaryWindow](#primarywindow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow(app) -> PrimaryWindow object` | | **Type** | Constructor | | **Description** | Creates a new PrimaryWindow. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 41](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L41) | --- #### Fields ### [alert](#alert) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.alert ` | | **Type** | Field | | **Description** | Provides access to any 'Alert' windows on the PrimaryWindow. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 335](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L335) | --- ### [bottomGroupUI](#bottomgroupui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow:bottomGroupUI ` | | **Type** | Field | | **Description** | Returns the bottom group UI as a `hs.axuielement` object. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 201](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L201) | --- ### [browserGroupUI](#browsergroupui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.browserGroupUI ` | | **Type** | Field | | **Description** | Returns the UI which contains the Browser. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 252](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L252) | --- ### [colorBoard](#colorboard) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.colorBoard ` | | **Type** | Field | | **Description** | The ColorBoard object. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 309](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L309) | --- ### [doShow](#doshow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow:doShow() -> PrimaryWindow` | | **Type** | Field | | **Description** | A [Statement](cp.rx.go.Statement.md) that attempts to show the Primary Window. | | **Returns** |
  • The `Statement`, which resolves as either `true` or sends an error.
| | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 276](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L276) | --- ### [frame](#frame) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.frame ` | | **Type** | Field | | **Description** | The current position (x, y, width, height) of the window. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 107](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L107) | --- ### [hsWindow](#hswindow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.hsWindow ` | | **Type** | Field | | **Description** | The `hs.window` instance for the window, or `nil` if it can't be found. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 86](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L86) | --- ### [inspector](#inspector) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.inspector ` | | **Type** | Field | | **Description** | The Inspector object. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 296](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L296) | --- ### [isFullScreen](#isfullscreen) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.isFullScreen ` | | **Type** | Field | | **Description** | Is `true` if the window is full-screen. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 100](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L100) | --- ### [isShowing](#isshowing) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.isShowing ` | | **Type** | Field | | **Description** | Is `true` if the window is visible. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 93](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L93) | --- ### [leftGroupUI](#leftgroupui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.leftGroupUI ` | | **Type** | Field | | **Description** | Returns the left group UI as a `hs.axuielement` object | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 125](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L125) | --- ### [rightGroupUI](#rightgroupui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.rightGroupUI ` | | **Type** | Field | | **Description** | Returns the right group UI as a `hs.axuielement` object. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 145](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L145) | --- ### [rootGroupUI](#rootgroupui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.rootGroupUI() ` | | **Type** | Field | | **Description** | Returns the top AXSplitGroup as a `hs.axuielement` object | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 114](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L114) | --- ### [timelineGroupUI](#timelinegroupui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.timelineGroupUI ` | | **Type** | Field | | **Description** | Returns the UI that contains the `Timeline`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 245](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L245) | --- ### [toolbar](#toolbar) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.toolbar ` | | **Type** | Field | | **Description** | The PrimaryToolbar element. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 322](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L322) | --- ### [topGroupUI](#topgroupui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.topGroupUI ` | | **Type** | Field | | **Description** | Returns the top group UI as a `hs.axuielement` object. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 162](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L162) | --- ### [UI](#ui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.UI ` | | **Type** | Field | | **Description** | The main `axuielement` for the window. May be `nil` if not currently available. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 74](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L74) | --- ### [viewerGroupUI](#viewergroupui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.viewerGroupUI ` | | **Type** | Field | | **Description** | Returns the UI that contains the `Viewer`. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 238](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L238) | --- ### [window](#window) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow.window ` | | **Type** | Field | | **Description** | The `Window` instance. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 67](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L67) | --- #### Methods ### [app](#app) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow:app() -> cp.apple.finalcutpro` | | **Type** | Method | | **Description** | Returns the application the display belongs to. | | **Parameters** |
  • None
| | **Returns** |
  • The app instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 54](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L54) | --- ### [show](#show) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.main.PrimaryWindow:show() -> PrimaryWindow` | | **Type** | Method | | **Description** | Shows the Primary Window. | | **Parameters** |
  • None
| | **Returns** |
  • The `PrimaryWindow` instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua line 259](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/main/PrimaryWindow.lua#L259) | --- ---