Skip to content

Commit

Permalink
Updated API References
Browse files Browse the repository at this point in the history
  • Loading branch information
latenitefilms committed Jun 9, 2023
1 parent 4fe8be7 commit da0863c
Show file tree
Hide file tree
Showing 792 changed files with 848 additions and 1,623 deletions.
9 changes: 0 additions & 9 deletions docs/api-reference/cp/cp.blackmagic.resolve.color.Tracker.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/api-reference/cp/index.yml

This file was deleted.

3 changes: 0 additions & 3 deletions docs/api-reference/extensions.yml

This file was deleted.

3 changes: 0 additions & 3 deletions docs/api-reference/hammerspoon.yml

This file was deleted.

1 change: 0 additions & 1 deletion docs/api-reference/hs/index.yml

This file was deleted.

3 changes: 0 additions & 3 deletions docs/api-reference/plugins.yml

This file was deleted.

1 change: 0 additions & 1 deletion docs/api-reference/plugins/index.yml

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

2 changes: 2 additions & 0 deletions docs/api-references/commandpost.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
label: CommandPost API
expanded: false
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.18n
---
# cp.18n

CommandPost's Internationalisation & Localisation Manger.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.adobe.aftereffects.app
---
# cp.adobe.aftereffects.app

The `cp.app` for Adobe After Effects.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.adobe.aftereffects
---
# cp.adobe.aftereffects

Adobe After Effects Extension

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.adobe.aftereffects.shortcuts
---
# cp.adobe.aftereffects.shortcuts

Translations between After Effects shortcuts and Hammerspoon-friendly shortcuts.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.app
---
# cp.app

This class assists with working with macOS apps. It provides functions for
finding, checking the running status, version number, path, and many other
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.app.menu
---
# cp.app.menu

Represents an app's menu bar, providing multi-lingual access to find and
trigger menu items.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.app.prefs
---
# cp.app.prefs

Provides access to application preferences, typically stored via `NSUserDefaults` or `CFProperties`.
To access the preferences, simply pass in the Bundle ID (eg. "com.apple.Preview") and it will return
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.commandeditor
---
# cp.apple.commandeditor

Functions to control and manage Apple's Command Editor - used in Final Cut Pro,
Motion and Compressor.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.compressor.app
---
# cp.apple.compressor.app

The `cp.app` for Apple's Compressor.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.compressor
---
# cp.apple.compressor

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.fcpxml
---
# cp.apple.fcpxml

A collection of tools for handling FCPXML Documents.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.fcpxml.time
---
# cp.apple.fcpxml.time

Allows you to convert time string values found in a FCPXML document into Lua objects,
that do all the operations using rational numbers.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.fcpxml.timecode
---
# cp.apple.fcpxml.timecode

Functions for working with timecode in Final Cut Pro XML. Note that
a timecode does not have any concept of a frame rate, so it is
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.app
---
# cp.apple.finalcutpro.app

The [cp.app](cp.app.md) for Final Cut Pro. Will automatically determine
if only the trial version of FCPX is installed and use that instead.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.browser.AppearanceAndFiltering
---
# cp.apple.finalcutpro.browser.AppearanceAndFiltering

Clip Appearance & Filtering Menu Popover

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.browser.Columns
---
# cp.apple.finalcutpro.browser.Columns

Final Cut Pro Browser List View Columns

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.cmd.CommandDetail
---
# cp.apple.finalcutpro.cmd.CommandDetail

This class provides a UI for displaying the details of a command when it is selected on the `CommandList`.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.cmd.CommandEditor
---
# cp.apple.finalcutpro.cmd.CommandEditor

Command Editor Module.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.cmd.CommandGroups
---
# cp.apple.finalcutpro.cmd.CommandGroups

Represents the list of Command Groups in the [CommandList](cp.apple.finalcutpro.cmd.CommandList.md).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.cmd.CommandList
---
# cp.apple.finalcutpro.cmd.CommandList

A list of commands available in the [CommandEditor](cp.apple.finalcutpro.cmd.CommandEditor.md).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.cmd.Commands.Header
---
# cp.apple.finalcutpro.cmd.Commands.Header

The header of the Commands.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.cmd.Commands.Row
---
# cp.apple.finalcutpro.cmd.Commands.Row

Commands Row.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.cmd.Commands
---
# cp.apple.finalcutpro.cmd.Commands

The list of available commands (depending on search and/or [CommandGroup](cp.apple.finalcutpro.cmd.CommandGroups.md])
that can be mapped to a keyboard shortcut.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.cmd.KeyDetail
---
# cp.apple.finalcutpro.cmd.KeyDetail

This class provides a UI for displaying the details of a key when it is selected on the keyboard layout.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.content.Clip
---
# cp.apple.finalcutpro.content.Clip

Represents a clip of media inside FCP.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.export.ExportDialog
---
# cp.apple.finalcutpro.export.ExportDialog

Export Dialog Module.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.export.GoToPrompt
---
# cp.apple.finalcutpro.export.GoToPrompt

Go To Prompt.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.export.ReplaceAlert
---
# cp.apple.finalcutpro.export.ReplaceAlert

Replace Alert

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.export.SaveSheet
---
# cp.apple.finalcutpro.export.SaveSheet

Save Sheet

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.export.destinations
---
# cp.apple.finalcutpro.export.destinations

Provides access to the list of Share Destinations configured for the user.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.import.MediaImport
---
# cp.apple.finalcutpro.import.MediaImport

Media Import

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.inspector.BaseMotionPanel
---
# cp.apple.finalcutpro.inspector.BaseMotionPanel

A base class for [Inspector](cp.apple.finalcutpro.inspector.Inspector.md) panels
that publish Motion parameters.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.inspector.BasePanel
---
# cp.apple.finalcutpro.inspector.BasePanel

A base class for the different panels in the [Inspector](cp.apple.finalcutpro.inspector.Inspector.md).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.inspector.Inspector
---
# cp.apple.finalcutpro.inspector.Inspector

Inspector

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.inspector.InspectorProperty
---
# cp.apple.finalcutpro.inspector.InspectorProperty

`InspectorProperty` contains helper functions for handling common property
types that occur in various `Inspectors` in FCP.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.inspector.audio.AudioComponent
---
# cp.apple.finalcutpro.inspector.audio.AudioComponent

The Audio Configuration section of the Audio Inspector.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.inspector.audio.AudioConfiguration
---
# cp.apple.finalcutpro.inspector.audio.AudioConfiguration

The Audio Configuration section of the Audio Inspector.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# [docs](index.md) » cp.apple.finalcutpro.inspector.audio.AudioInspector
---
# cp.apple.finalcutpro.inspector.audio.AudioInspector

Audio Inspector Module.

Expand Down

0 comments on commit da0863c

Please sign in to comment.