共通受信API

わんコメが受信したニコ生とYouTubeLiveへのメッセージを全て受信できる基本のAPIです。

• ニコ生のコメントを受信します。

• ニコ生のギフトを受信します。

• YouTubeLiveのコメントを受信します。

• YouTubeLiveのスーパーチャットを受信します。

/vc-official/onecomme/common APIは、以下のようなデータをOSC通信で提供します。Timestamp型を含みます。

{
    type: "youtube" | "youtube-super" | "niconico" | "niconico-gift",
    author: string,
    comment: string,
    iconUrl: string,
    timestamp: Timestamp
}

プラットフォーム固有のデータを得る方法

例えばYouTubeLiveのスーパーチャットデータを受信した場合、以下のようにLuaを書くことでスーパーチャットの金額を取得する事ができます。

-- 転送されたデータが data 変数に入っているとします
if (data.type == "youtube-super") then
    print(data.price)   -- スーパーチャットの金額を使った処理ができる
end

以下に、 type ごとに得られる追加のデータを解説します。

yotube-super

Color型を含みます。

{
    type: "youtube-super",
    author: string,
    comment: string,
    iconUrl: string,
    timestamp: Timestamp,

    // 以下、固有部分
    paidText: string,
    price: number,
    tier: number,
    unit: string,
    colors: {
        headerBackgroundColor: Color,
        headerTextColor: Color,
        bodyBackgroundColor: Color,
        bodyTextColor: Color,
        authorNameTextColor: Color,
        timestampColor: Color
    }
}

niconico-gift

{
    type: "niconico-gift",
    author: string,
    comment: string,
    iconUrl: string,
    timestamp: Timestamp,

    // 以下、固有部分
    price: number
}