nizima LIVE にプラグインを登録する。

Name: string,
Developer?: string,
Version?: string,
Icon?: string

• Name: プラグインの名前
• Developer: 開発者名
• Version: プラグインのバージョン
• Icon: Base64 でエンコードされた PNG ファイル。正方形の画像を使用しないと表示が崩れる可能性がある。

Token: string

nizima LIVE に再接続するときに使用する。
RegisterPlugin で登録した Name と、取得した Token を使用する。

Name: string,
Token: string,
Version?: string

Enabled: boolean

プラグインの実行ファイルのパスを指定することで、nizima LIVE からプラグインを起動することができるようになります。
起動できる要件は以下の通りです。

• 絶対パスであること
• パスを登録した時点から実行ファイルのハッシュ値が変化していないこと

起動できなくなった場合でも、再度 SetPluginPath を使用してパスを登録することで、ハッシュが再計算され起動できるようになります。

nizima LIVE からプラグインを起動した際には、プラグインのコマンドライン引数に -l -p <port> が渡されます。
<port> は WebSocket のポート番号です。

PluginPath: string

{}

• InvalidPluginPath

このイベントは Request を送っていなくても通知される。
プラグインが有効になっているかどうかがわかる。

Enabled: boolean

プラグイン開発用の機能。
設定した Delay ミリ秒後に Response が返ってくる。

Delay: number

{}

nizima LIVE への接続状態を取得する。

{}

Established: boolean,
Enabled: boolean

このイベントは Request を送っていなくても通知される。
プラグイン接続中にプラグインマネージャーで起動ボタンがクリックされたときに通知される。

{}

指定したモデルの CubismParameter の値を設定する。
最後に値を設定してから 500ms の間はその値を維持する。
複数のプラグインやスクリプトから同じパラメータの値を設定した場合の動作は未定義。

ModelId: string,
CubismParameterValues: Array<{
  Id: string,
  Value: number
}>

ModelId には Live2D アイテムの ItemId も設定可能。

{}

• InvalidModelId

指定したモデルの CubismParameter の現在値が取得できる。

ModelId: string,
CubismParameterIds?: Array<string>

ModelId には Live2D アイテムの ItemId も設定可能。
CubismParameterIds の指定がない場合はすべてのパラメータを取得する。

CubismParameterValues: Array<{
  Id: string,
  Value: number
}>

• InvalidModelId

指定したモデルの CubismParameter 一覧が取得できる。

ModelId: string

ModelId には Live2D アイテムの ItemId も設定可能。

CubismParameters: Array<{
  Id: string,
  Name: string,
  DefaultValue: number,
  Max: number,
  Min: number
}>

• InvalidModelId

指定したモデルの LiveParameter の値を設定する。
最後に値を設定してから 500ms の間はその値を維持する。
複数のプラグインやスクリプトから同じパラメータの値を設定した場合の動作は未定義。

ModelId?: string,
Overwrite?: bool,
Time?: number,
LiveParameterValues: Array<{
  Id: string,
  Value: number
}>

ModelId には Live2D アイテムの ItemId も設定可能。
ModelId の指定がない場合はすべてのモデルに適用される。
Overwrite が true の場合、ほかの入力を上書きしてこの値を優先的に使用するようになる。複数プラグインが Overwrite した場合の動作は未定義。
Overwrite が false の場合、補正がかかり、ほかの入力と合成して使用される。
Time が存在する場合は補正の参考に使用される。
Overwrite のデフォルト値は true。

{}

• InvalidModelId

指定したモデルの LiveParameter の現在値が取得できる。

ModelId: string,
LiveParameterIds?: Array<string>

ModelId には Live2D アイテムの ItemId も設定可能。
LiveParameterIds の指定がない場合はすべてのパラメータを取得する。

LiveParameterValues: Array<{
  Id: string,
  Value: number
}>

• InvalidModelId

指定したモデルの CubismParameter の値をデフォルト値に戻す。

ModelId: string

ModelId には Live2D アイテムの ItemId も設定可能。

{}

• InvalidModelId

LiveParameter を追加する。
パラメータの追加は nizima LIVE に保存されないので、プラグインを接続するたびにパラメータの追加を行うこと。

LiveParameters: Array<{
  Id: string,
  Group?: string,
  Base: number,
  Max: number,
  Min: number,
  Repeat?: boolean
}>

Id が同じパラメータは存在できないので、nizima LIVE に元からあるパラメータや他のプラグインと被らない Id を使用すること。
また、シンプルな Id は将来的に nizima LIVE が使用することで衝突する可能性があるため、使用しないほうが良い。
Max、Min、Base について、Min < Max かつ Min ≤ Base ≤ Max となっていない場合は InvalidData を返す。
Repeat はパラメータの Max と Min がつながる場合に true を設定する。（角度 0～360 など）

{}

• InvalidData

現在 nizima LIVE 上に存在する LiveParameter の一覧が取得できる。
LiveParameter にはトラッキングの結果などが入る。

{}

LiveParameters: Array<{
  Id: string,
  CreatedBy: string,
  Group: string,
  Base: number,
  Max: number,
  Min: number,
  Repeat: boolean
}>

• CreatedBy: パラメータの作成者が入る。nizima LIVE またはプラグイン名。
• Repead: パラメータの Max と Min がつながる場合に true となる。ハンドトラッキングの角度などが該当する。

描画の更新毎の通知を有効にする。
各モデルのパラメータの現在値が取得できる。

Enabled?: boolean

{}

Models: Array<{
  ModelId: string,
  LiveParameterValues: Array<{
    Id: string,
    Value: number
  }>,
  CubismParameterValues: Array<{
    Id: string,
    Value: number
  }>
}>

すべてのシーンと、それに属するモデルとアイテムの情報を取得する。

{}

Scenes: Array<{
  SceneId: string,
  Models: Array<{
    Local: boolean,
    Name: string,
    ModelId: string,
    SceneId: string,
    ModelPath?: string,
    IconPath?: string,
    PositionX: number,
    PositionY: number,
    Scale: number,
    Rotation: number
  }>,
  Items: Array<{
    Name: string,
    ItemType: "Live2D" | "Animated" | "Still",
    ItemId: string,
    SceneId: string,
    ItemPath: string,
    IconPath: string,
    PositionX: number,
    PositionY: number,
    Scale: number,
    Rotation: number
  }>
}>

• PositionX: ウィンドウの右端が 1、左端が -1
• PositionY: ウィンドウの上端が 1、下端が -1
• Scale: 表示倍率。デフォルトは 1
• Rotation: 度数法で指定する角度。デフォルトは 0 で反時計回りが正

新しいウィンドウでモデルを開いた時やウィンドウを閉じた時など、シーンの数が増減したときの通知を有効にする。

Enabled?: boolean

{}

Scenes: Array<{
  SceneId: string,
  Models: Array<{
    Local: boolean,
    Name: string,
    ModelId: string,
    SceneId: string,
    ModelPath?: string,
    IconPath?: string,
    PositionX: number,
    PositionY: number,
    Scale: number,
    Rotation: number
  }>,
  Items: Array<{
    Name: string,
    ItemType: "Live2D" | "Animated" | "Still",
    ItemId: string,
    SceneId: string,
    ItemPath: string,
    IconPath: string,
    PositionX: number,
    PositionY: number,
    Scale: number,
    Rotation: number
  }>
}>

• PositionX: ウィンドウの右端が 1、左端が -1
• PositionY: ウィンドウの上端が 1、下端が -1
• Scale: 表示倍率。デフォルトは 1
• Rotation: 度数法で指定する角度。デフォルトは 0 で反時計回りが正

最後にフォーカスされたウィンドウの SceneId を取得する。

{}

SceneId: string

• CurrentSceneUnavailable

ウィンドウのフォーカスが変わった際の通知を有効にする。
フォーカスされたウィンドウの SceneId が取得できる。

Enabled?: boolean

{}

SceneId: string

GroupId: string

{}

• InvalidEffectGroupId

GroupId: string

{}

• InvalidEffectGroupId

{}

EffectGroups: Array<{
  Name: string,
  GroupId: string,
  SceneId: string,
  Target: string,
  Enabled: bool
}>

EffectId: string,
EffectParameterValues: Array<{
  Id: string,
  Value: number
}>

{}

• InvalidEffectId

EffectId: string

EffectParameters: Array<{
  Id: string,
  Base: number
}>

• InvalidEffectId

{}

Effects: Array<{
  Name: string,
  EffectId: string,
  SceneId: string,
  Target: string,
  Enabled: bool
}>

画面上に表示されているモデルを指定して削除する。

ModelId: string

{}

• InvalidModelId

指定したモデルを別のモデルに変更する。

ModelId: string,
ModelPath: string

ModelId: string

• InvalidModelId
• InvalidModelPath

指定したモデルを、指定したシーンに追加する。

SceneId?: string,
ModelPath: string

SceneId を指定しない場合は新規ウィンドウで表示する。

ModelId: string

• InvalidModelPath

nizima LIVE にモデルを登録する。

ModelPath: string,
IconPath?: string

ModelPath: string

• InvalidModelPath

指定したモデルのアイコンデータを取得する。

ModelPaths: Array<string>

RegisteredModelIcons: Array<{
  ModelPath: string,
  Icon: string
}>

• Icon: Base64 でエンコードされたアイコン画像

nizima LIVE に登録されているモデルの一覧を取得する。

{}

RegisteredModels: Array<{
  Name: string,
  ModelPath: string,
  IconPath: string,
}>

選択したモデルの Pose をリセットする。

ModelId: string

ModelId には Live2D アイテムの ItemId も設定可能。

{}

• InvalidModelId

表示されているモデルの一覧を取得する。

{}

Models: Array<{
  Local: boolean,
  Name: string,
  ModelId: string,
  SceneId: string,
  ModelPath?: string,
  IconPath?: string,
  PositionX: number,
  PositionY: number,
  Scale: number,
  Rotation: number
}>

• Local: コラボモデルの時 false になる
• PositionX: ウィンドウの右端が 1、左端が -1
• PositionY: ウィンドウの上端が 1、下端が -1
• Scale: 表示倍率。デフォルトは 1
• Rotation: 度数法で指定する角度。デフォルトは 0 で反時計回りが正

画面上のモデルが追加・削除された際の通知を有効にする。

Enabled?: boolean

{}

Models: Array<{
  Local: boolean,
  Name: string,
  ModelId: string,
  SceneId: string,
  ModelPath?: string,
  IconPath?: string,
  PositionX: number,
  PositionY: number,
  Scale: number,
  Rotation: number
}>

• Local: コラボモデルの時 false になる
• PositionX: ウィンドウの右端が 1、左端が -1
• PositionY: ウィンドウの上端が 1、下端が -1
• Scale: 表示倍率。デフォルトは 1
• Rotation: 度数法で指定する角度。デフォルトは 0 で反時計回りが正

指定したモデルを移動する。

ModelId: string,
Absolute?: boolean,
PositionX?: number,
PositionY?: number,
Scale?: number,
Rotation?: number,
Delay?: number,
InterpolationType?: string

• Absolute: 未指定の場合 false
  • true の場合、ウィンドウ上の絶対的な座標や回転を指定して移動する
  • false の場合、現在の位置から相対的に移動する
• PositionX: ウィンドウの右端が 1、左端が -1
• PositionY: ウィンドウの上端が 1、下端が -1
• Scale: 表示倍率。デフォルトは 1
• Rotation: 度数法で指定する角度。デフォルトは 0 で反時計回りが正
• Delay: モデルの移動時間（秒）
  • コラボモデルでは 0 に固定される
• InterpolationType: 移動時の補間方法を指定する。デフォルトは Linear
  • https://doc.qt.io/qt-6/qeasingcurve.html#Type-enum

{}

• InvalidModelId

指定したモデルの Drawable の色を変更する。

ModelId: string,
DrawableIds: Array<string>,
MultiplyColor?: {
  Float?: boolean,
  Red: number,
  Green: number,
  Blue: number,
  Alpha?: number
},
ScreenColor?: {
  Float?: boolean,
  Red: number,
  Green: number,
  Blue: number,
  Alpha?: number
}

ModelId には Live2D アイテムの ItemId も設定可能。
MultiplyColor や ScreenColor の指定がない場合は素の状態に戻る。
Color について

• Float が null または false のとき
  • RGBA は 0-255 の値で指定する
• Float が true のとき
  • RGBA は 0-1 の値で指定する

{}

• InvalidModelId

指定したモデルの Part の色を変更する。

ModelId: string,
PartIds: Array<string>,
MultiplyColor?: {
  Float?: boolean,
  Red: number,
  Green: number,
  Blue: number,
  Alpha?: number
},
ScreenColor?: {
  Float?: boolean,
  Red: number,
  Green: number,
  Blue: number,
  Alpha?: number
}

ModelId には Live2D アイテムの ItemId も設定可能。
MultiplyColor や ScreenColor の指定がない場合は素の状態に戻る。
Color について

• Float が null または false のとき
  • RGBA は 0-255 の値で指定する
• Float が true のとき
  • RGBA は 0-1 の値で指定する

{}

• InvalidModelId

指定したモデルの色を変更する。

ModelId: string,
MultiplyColor?: {
  Float?: boolean,
  Red: number,
  Green: number,
  Blue: number,
  Alpha?: number
},
ScreenColor?: {
  Float?: boolean,
  Red: number,
  Green: number,
  Blue: number,
  Alpha?: number
}

ModelId には Live2D アイテムの ItemId も設定可能。
MultiplyColor や ScreenColor の指定がない場合は素の状態に戻る。
Color について

• Float が null または false のとき
  • RGBA は 0-255 の値で指定する
• Float が true のとき
  • RGBA は 0-1 の値で指定する

{}

• InvalidModelId

モデルの Drawable 一覧を取得する。

ModelId: string

ModelId には Live2D アイテムの ItemId も設定可能。

Drawables: Array<{
  Id: string
}>

• InvalidModelId

モデルの Part 一覧を取得する。

ModelId: string

ModelId には Live2D アイテムの ItemId も設定可能。

Parts: Array<{
  Id: string,
  Name: string
}>

• InvalidModelId

モデルを根として Part と Drawable を木構造にしたものを取得する。

ModelId: string

ModelId には Live2D アイテムの ItemId も設定可能。

PartNode: {
  Id: string,
  Name: string,
  Type: "Model" | "Part" | "Drawable",
  Children: Array<typeof PartNode>
}

• InvalidModelId

最後に選択されたモデルの ModelId を取得する。

{}

SceneId: string,
ModelId: string

• CurrentSceneUnavailable
• CurrentModelUnavailable

GetCurrentModelId で取得できる ModelId が変更されたことの通知を有効にする。

Enabled?: boolean

{}

ModelId: string

画面上に表示されているアイテムを指定して削除する。

ItemId: string

{}

• InvalidItemId

指定したアイテムを、指定したシーンに追加する。

SceneId: string,
ItemPath: string

• ItemPath: 以下のいずれかのパス
  • Live2D アイテムの model3.json のパス
  • アニメーションアイテムのディレクトリのパス
  • 静止画アイテムの画像のパス

{}

• InvalidSceneId
• InvalidItemPath

nizima LIVE に登録されているアイテムの一覧を取得する。

{}

RegisteredItems: Array<{
  Name: string,
  ItemType: "Live2D" | "Still" | "Animated",
  ItemPath: string,
  IconPath: string,
  Description: string,
  Favorite: boolean,
  EffectorWeight: number,
  Fps: number
}>

• ItemPath: 以下のいずれかのパス
  • Live2D アイテムの model3.json のパス
  • アニメーションアイテムのディレクトリのパス
  • 静止画アイテムの画像のパス

表示されているアイテムの一覧を取得する。

{}

Items: Array<{
  Name: string,
  ItemType: "Live2D" | "Still" | "Animated",
  ItemId: string,
  SceneId: string,
  ItemPath: string,
  IconPath: string,
  PositionX: number,
  PositionY: number,
  Scale: number,
  Rotation: number
}>

• PositionX: ウィンドウの右端が 1、左端が -1
• PositionY: ウィンドウの上端が 1、下端が -1
• Scale: 表示倍率。デフォルトは 1
• Rotation: 度数法で指定する角度。デフォルトは 0 で反時計回りが正

画面上のアイテムが追加・削除された際の通知を有効にする。

Enabled?: boolean

{}

Items: Array<{
  Name: string,
  ItemType: "Live2D" | "Animated" | "Still",
  ItemId: string,
  SceneId: string,
  ItemPath: string,
  IconPath: string,
  PositionX: number,
  PositionY: number,
  Scale: number,
  Rotation: number
}>

• PositionX: ウィンドウの右端が 1、左端が -1
• PositionY: ウィンドウの上端が 1、下端が -1
• Scale: 表示倍率。デフォルトは 1
• Rotation: 度数法で指定する角度。デフォルトは 0 で反時計回りが正

指定したアイテムを移動する。

ItemId: string,
Absolute?: boolean,
PositionX?: number,
PositionY?: number,
Scale?: number,
Rotation?: number,
Delay?: number,
InterpolationType?: string

• Absolute: 未指定の場合 false
  • true の場合、ウィンドウ上の絶対的な座標や回転を指定して移動する
  • false の場合、現在の位置から相対的に移動する
• PositionX: ウィンドウの右端が 1、左端が -1
• PositionY: ウィンドウの上端が 1、下端が -1
• Scale: 表示倍率。デフォルトは 1
• Rotation: 度数法で指定する角度。デフォルトは 0 で反時計回りが正
• Delay: モデルの移動時間（秒）
• InterpolationType: 移動時の補間方法を指定する。デフォルトは Linear
  • https://doc.qt.io/qt-6/qeasingcurve.html#Type-enum

{}

• InvalidItemId

指定したモデルのモーションを停止する。
モーション再生前の状態に戻したい場合は ResetPose と ResetCubismParameterValues を使用する。

ModelId: string

ModelId には Live2D アイテムの ItemId も設定可能。

{}

• InvalidModelId

指定したモデルのモーションを再生する。

ModelId: string,
MotionPath: string

ModelId には Live2D アイテムの ItemId も設定可能。

{}

• InvalidModelId
• InvalidMotionPath

指定したモデルのモーション一覧を取得する。

ModelId: string

ModelId には Live2D アイテムの ItemId も設定可能。

Motions: Array<{
  Name: string,
  MotionPath: string
}>

• InvalidModelId

指定したモデルの表情をすべてオフにする。

ModelId: string

ModelId には Live2D アイテムの ItemId も設定可能。

{}

• InvalidModelId

指定したモデルの表情をオフにする。

ModelId: string,
ExpressionPath: string

ModelId には Live2D アイテムの ItemId も設定可能。

{}

• InvalidModelId
• InvalidExpressionPath

指定したモデルの表情を再生する。

ModelId: string,
ExpressionPath: string

ModelId には Live2D アイテムの ItemId も設定可能。

{}

• InvalidModelId
• InvalidExpressionPath

指定したモデルの表情一覧を取得する。

ModelId: string

ModelId には Live2D アイテムの ItemId も設定可能。

Expressions: Array<{
  Name: string,
  ExpressionPath: string,
  Active: boolean
}>

• InvalidModelId