didReceiveSettings

getSettings() APIを呼んだあとデータを受け取った時に発生する。

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

メンバー

メンバー	説明
action	固有のアクションID
event	didReceiveSettings
context	An opaque value identifying the instance’s action.
device	認識したデバイスの Opaque 値
payload	jsonオブジェクト

Payload

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

---

このAPIは、StreamDeck 4.1で導入された。