#cp.apple.finalcutpro.main.FullScreenPlayer

Full Screen Window Player.

Triggered by the "View > Playback > Play Full Screen" menubar item.

#API Overview

Functions - API calls offered directly by the extension

Constructors - API calls which return an object, typically one that offers API methods

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

Methods - API calls which can only be made on an object returned by a constructor


Signature	`cp.apple.finalcutpro.main.FullScreenPlayer.matches(element) -> boolean`
Type	Function
Description	Checks to see if an element matches what we think it should be.
Parameters	element - An `axuielementObject` to check.
Returns	`true` if matches otherwise `false`
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/FullScreenPlayer.lua line 41


Signature	`cp.apple.finalcutpro.main.FullScreenPlayer(app) -> FullScreenPlayer`
Type	Constructor
Description	Creates a new FCPX `FullScreenPlayer` instance.
Parameters	app - The FCP app instance.
Returns	The new `FullScreenPlayer`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/FullScreenPlayer.lua line 58


Signature	`cp.apple.finalcutpro.main.FullScreenPlayer.isFullScreen <cp.prop; boolean; read-only; live>`
Type	Field
Description	Checks if the window is full-screen.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FullScreenPlayer.lua line 112


Signature	`cp.apple.finalcutpro.main.FullScreenPlayer.rootGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	The root `AXGroup`.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FullScreenPlayer.lua line 79


Signature	`cp.apple.finalcutpro.main.FullScreenPlayer.viewerGroupUI <cp.prop: hs.axuielement; read-only; live>`
Type	Field
Description	The Viewer's group UI element.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/main/FullScreenPlayer.lua line 91


Signature	`cp.apple.finalcutpro.main.FullScreenPlayer:doShow() -> <cp.rx.go.Statement>`
Type	Method
Description	A `Statement` that attempts to show the full screen window.
Parameters	None
Returns	The `Statement` to execute.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/FullScreenPlayer.lua line 155


Signature	`cp.apple.finalcutpro.main.FullScreenPlayer:show() -> cp.apple.finalcutpro`
Type	Method
Description	Attempts to show the full screen window.
Parameters	None
Returns	The window instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/main/FullScreenPlayer.lua line 141