cp.apple.motion.md

docs » cp.apple.motion

---

Represents the Motion application, providing functions that allow different tasks to be accomplished.

Submodules

• cp.apple.motion.app

API Overview

• Constants - Useful values which cannot be changed
• BUNDLE_ID
• Methods - API calls which can only be made on an object returned by a constructor
• bundleID
• doRestart
• hide
• launch
• notifier
• path
• quit
• show

API Documentation

Constants

BUNDLE_ID

Signature	cp.apple.motion.BUNDLE_ID
Type	Constant
Description	Compressor's Bundle ID

Methods

bundleID

Signature	cp.apple.motion:bundleID() -> string
Type	Method
Description	Returns the Compressor Bundle ID
Parameters	None
Returns	A string of the Compressor Bundle ID

doRestart

Signature	cp.apple.motion:doRestart() -> cp.rx.go.Statement
Type	Method
Description	Returns a Statement that will restart the application.
Parameters	None
Returns	true if the application was running and restarted successfully.

hide

Signature	cp.apple.motion:hide() -> self
Type	Method
Description	Hides Compressor
Parameters	None
Returns	The motion instance.

launch

Signature	cp.apple.motion:launch([waitSeconds]) -> self
Type	Method
Description	Launches Compressor, or brings it to the front if it was already running.
Parameters	waitSeconds - if provided, we will wait for up to the specified seconds for the launch to complete.
Returns	true if Compressor was either launched or focused, otherwise false (e.g. if Compressor doesn't exist)

notifier

Signature	cp.apple.motion:notifier() -> cp.ui.notifier
Type	Method
Description	Returns a notifier that is tracking the application UI element. It has already been started.
Parameters	None
Returns	The notifier.

path

Signature	cp.apple.motion:path() -> string or nil
Type	Method
Description	Path to Compressor Application
Parameters	None
Returns	A string containing Compressor's filesystem path, or nil if the bundle identifier could not be located

quit

Signature	cp.apple.motion:quit([waitSeconds]) -> self
Type	Method
Description	Quits Compressor
Parameters	waitSeconds - if provided, we will wait for the specified time for the quit to complete before returning.
Returns	The motion instance.

show

Signature	cp.apple.motion:show() -> self
Type	Method
Description	Activate Compressor
Parameters	None
Returns	The motion instance.