voice

Last updated 2 months ago

Voice Command Plugin.

API Overview

API Documentation

Variables

active

Signature

plugins.finalcutpro.os.voice.active <cp.prop: boolean; read-only>

Type

Variable

Description

Are Voice Commands active? This will be true if they are both enabled and FCP is frontmost.

Signature

plugins.finalcutpro.os.voice.announcementsEnabled <cp.prop: boolean>

Type

Variable

Description

Announcements Enabled?

Signature

plugins.finalcutpro.os.voice.commandsByTitle -> table

Type

Variable

Description

Command By Title

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?

Signature

plugins.finalcutpro.os.voice.visualAlertsEnabled <cp.prop: boolean>

Type

Variable

Description

Visual Alerts Enabled?

Functions

Signature

plugins.finalcutpro.os.voice.activateCommand(title) -> none

Type

Function

Description

Activate Command

Parameters

Returns

Signature

plugins.finalcutpro.os.voice.getCommandTitles() -> table

Type

Function

Description

Gets the Command Titles

Parameters

Returns

new

Signature

plugins.finalcutpro.os.voice.new() -> none

Type

Function

Description

Creates a new listener.

Parameters

Returns

Signature

plugins.finalcutpro.os.voice.openDictationSystemPreferences() -> none

Type

Function

Description

Open Dictation System Preferences

Parameters

Returns

pause

Signature

plugins.finalcutpro.os.voice.pause() -> none

Type

Function

Description

Stops the listener.

Parameters

Returns

Signature

plugins.finalcutpro.os.voice.registerCommands(commands) -> none

Type

Function

Description

Register Commands.

Parameters

Returns

start

Signature

plugins.finalcutpro.os.voice.start() -> none

Type

Function

Description

Starts the listener.

Parameters

Returns

stop

Signature

plugins.finalcutpro.os.voice.stop() -> none

Type

Function

Description

Stops the listener.

Parameters

Returns

update

Signature

plugins.finalcutpro.os.voice.update() -> none

Type

Function

Description

Starts or stops the listener.

Parameters

Returns