willApper

下記の時に発生する。

• StreamDeckアプリケーションが起動したとき
• ユーザーがプロファイルを切り替えたとき
• ユーザーがActionを使おうとキーを設定したとき

var json = {
    "action": "com.elgato.example.action1",
    "event": "willAppear",
    "context": opaqueValue,
    "device": opaqueValue,
    "payload": {
        "settings": {<json data>},
        "coordinates": {
            "column": 3, 
            "row": 1
        },
        "state": 0,
        "isInMultiAction": false
    }
};

メンバー

メンバー	説明
action	action毎の識別子。Multiple Actionをサポートしているなら、どのactionが発生したか？この値を使って見分けます。
event	willAppear
context	An opaque value identifying the instance’s action. You will need to pass this opaque value to several APIs like the setTitle API.
device	認識したデバイスの Opaque 値
payload	jsonオブジェクト

Payload

Payload	説明
settings	固有データが詰まっているjsonオブジェクト
coordinates	actionが発生したとき動作するもの
state	actionが複数のステートを持つとき(manifest.jsonで規定される)だけ有効なパラメータ 0を基底にしたactionの状態変数
isInMultiAction	内部的にMultipul actionのときTRUEとなる。