VirtualCast公式わんコメOSCプラグイン#
VirtualCast公式わんコメOSCプラグインとは、ニコ生やYouTubeLiveへのコメントをOSC通信で転送する機能を提供するために、バーチャルキャストがわんコメ向けに開発したプラグインです。
このページでは、本プラグインがOSCでどのようなデータを転送するのかを説明します。
利用可能な情報#
OSC通信は localhost 宛に送信され、ポート番号は 19100 を使います。
API の OSC Address は /vc-official/onecomme で始まり、各APIの名前が続きます。以下の4つのAPIを提供します：
API |
OSC Adress |
|---|---|
|
|
|
|
|
|
|
VCIから利用するのであれば、 ExportOsc.RegisterMethod() を使用して上記のAPIを監視することで、情報を受け取ることができます。
OSCフォーマット#
OSCで送られてきたデータを解釈するためには、本プラグインが転送するデータの構造を理解する必要があります。
本プラグインでは、以下の方針に従った形式で転送するデータを決めています：
JSON形式のひとかたまりの文字列として、OSCで転送する。
わんコメから提供されたデータ構造と一致させ、値もなるべく加工しない。
データの種別によっては、OSCフォーマット用に変換をかけるものがある(後述)。
1回の通信に1つのコメントだけを含める。
OSCの容量制限 4KB を超えないようにする。特に、画像データは容量が大きいため転送しない。
JSON文字列としてOSCで転送するため、利用する際には例えばLuaの json.parse 関数などを用いてパースする必要があるでしょう。
具体的なJSONの構造は、各APIのページをご覧ください。
OSCフォーマット用の変換#
いくつかのデータはわんコメからプラグインへ提供される形式をそのまま使うのではなく、JSONとして読みやすい形に変形させます。