CommandPost Developer Guide
CommandPost Developer Guide
Download
User Guide
Facebook Group
Introduction
Getting Started
Introduction
Installation & Setup
Lua
Lua Overview
Memory Management
Contributing
Naming Conventions
CommandPost-App
CommandPost
Control CommandPost
AppleScript
URL Handler
Command Line Tool
Plugins
Plugins Overview
Internationalisation
Translating CommandPost
Final Cut Pro
Package Contents
FCPXML
Bundled Extensions
i18n
mimetypes
moses
resty
semver
slaxml
CommandPost API
cp
app
menu
prefs
commandeditor
compressor
finalcutpro
battery
bench
choices
builder
commands
command
englishKeyCodes
shortcut
config
dockIconClickCallback
fileDroppedToDockIconCallback
shutdownCallback
textDroppedToDockIconCallback
history
deferred
developer
dialog
disk
docs
feedback
font
language
languageID
localeID
region
script
idle
ids
is
json
just
lazy
localized
plist
archiver
plistParser
plugins
env
plugin
prop
protect
sourcewatcher
strings
test
text
matcher
flicks
tools
Alert
axutils
Button
CheckBox
Group
MenuButton
notifier
PopUpButton
PropertyRow
RadioButton
RadioGroup
ScrollArea
Slider
SplitGroup
StaticText
Table
TextField
Window
utf16
be
le
watcher
block
generate
html
text
ui
xml
Bundled Plugins API
plugins
Hammerspoon API
hs
Powered by GitBook

languageID

As per Apple's documentation, a language ID is a code which identifies either a language used across multiple regions, a dialect from a specific region, or a script used in multiple regions. See the parse function for details.

When you parse a code with the forCode function, it will result in a table that contains a reference to the approprate cp.i18n.language table, and up to one of either the matching cp.i18n.region or cp.i18n.script tables. These contain the full details for each language/regin/script, as appropriate.

You can also convert the resulting table back to the code via tostring, or the code method.

API Overview

  • Functions - API calls offered directly by the extension

    • ​is​

    • ​parse​

  • 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

API Documentation

Functions

​is​

Signature

cp.i18n.languageID.is(thing) -> boolean

Type

Function

Description

Checks if the thing is a languageID instance.

Parameters

​

Returns

​

​parse​

Signature

cp.i18n.languageID.parse(code) -> string, string, string

Type

Function

Description

Parses a language ID into three possible string components:

Parameters

​

Returns

​

Constructors

​forCode​

Signature

cp.i18n.languageID.forCode(code) -> cp.i18n.languageID, string

Type

Constructor

Description

Creates, or retrieves from the cache, a languageID instance for the specified code.

Parameters

​

Returns

​

​forLocaleID​

Signature

cp.i18n.languageID.forLocaleID(code[, prioritiseScript]) -> cp.i18n.languageID, string

Type

Constructor

Description

Creates, or retrieves from the cache, a languageID instance for the specified cp.i18n.localeID.

Parameters

​

Returns

​

​forParts​

Signature

cp.i18n.languageID.forParts(languageCode[, scriptCode[, regionCode]]) -> cp.i18n.languageID

Type

Constructor

Description

Returns a languageID with the specified parts.

Parameters

​

Returns

​

Fields

​code​

Signature

cp.i18n.languageID.code <string>

Type

Field

Description

The language ID code.

​language​

Signature

cp.i18n.languageID.language <cp.i18n.language>

Type

Field

Description

The matching language details.

​region​

Signature

cp.i18n.languageID.region <cp.i18n.region>

Type

Field

Description

The matching region details, if appropriate. Will be nil if no region was specified in the code.

​script​

Signature

cp.i18n.languageID.script <cp.i18n.script>

Type

Field

Description

The matching script details, if appropriate. Will be nil if no script was specified in the code.

Methods

​toLocaleID​

Signature

cp.i18n.languageID:toLocaleID() -> cp.i18n.localeID

Type

Method

Description

Returns the cp.i18n.localeID equivalent for this languageID.

Parameters

​

Returns

​

Previous
language
Next
localeID
Last updated 1 year ago
Edit on GitHub
Contents
API Overview
API Documentation
Functions
Constructors
Fields
Methods