docs » plugins.finalcutpro.os.voice


Voice Command Plugin.

API Overview

API Documentation

Variables

announcementsEnabled

Signature plugins.finalcutpro.os.voice.announcementsEnabled <cp.prop: boolean>
Type Variable
Description Announcements Enabled?

commandsByTitle

Signature plugins.finalcutpro.os.voice.commandsByTitle -> table
Type Variable
Description Command By Title

commandTitles

Signature plugins.finalcutpro.os.voice.commandTitles -> table
Type Variable
Description Command Titles

enabled

Signature plugins.finalcutpro.os.voice.enabled <cp.prop: boolean>
Type Variable
Description Are Voice Commands Enabled?

listening

Signature plugins.finalcutpro.os.voice.listening <cp.prop: boolean>
Type Variable
Description Is the listener listening?

visualAlertsEnabled

Signature plugins.finalcutpro.os.voice.visualAlertsEnabled <cp.prop: boolean>
Type Variable
Description Visual Alerts Enabled?

Functions

activateCommand

Signature plugins.finalcutpro.os.voice.activateCommand(title) -> none
Type Function
Description Activate Command
Parameters
  • title - The title as a string
Returns
  • None

getCommandTitles

Signature plugins.finalcutpro.os.voice.getCommandTitles() -> table
Type Function
Description Gets the Command Titles
Parameters
  • None
Returns
  • The command titles as a table.

new

Signature plugins.finalcutpro.os.voice.new() -> none
Type Function
Description Creates a new listener.
Parameters
  • None
Returns
  • `true` if successful otherwise `false` if an errors occurs.

openDictationSystemPreferences

Signature plugins.finalcutpro.os.voice.openDictationSystemPreferences() -> none
Type Function
Description Open Dictation System Preferences
Parameters
  • None
Returns
  • None

pause

Signature plugins.finalcutpro.os.voice.pause() -> none
Type Function
Description Stops the listener.
Parameters
  • None
Returns
  • None

registerCommands

Signature plugins.finalcutpro.os.voice.registerCommands(commands) -> none
Type Function
Description Register Commands.
Parameters
  • commands - A table of commands.
Returns
  • The command titles as a table.

start

Signature plugins.finalcutpro.os.voice.start() -> none
Type Function
Description Starts the listener.
Parameters
  • None
Returns
  • `true` if successful otherwise `false` if an errors occurs.

stop

Signature plugins.finalcutpro.os.voice.stop() -> none
Type Function
Description Stops the listener.
Parameters
  • None
Returns
  • None

update

Signature plugins.finalcutpro.os.voice.update() -> none
Type Function
Description Starts or stops the listener.
Parameters
  • None
Returns
  • None

results matching ""

    No results matching ""