JSONフォーマット(みくみくまうす本体バージョン2.1以降向け)

こちらはみくみくまうすv2.1以降のJsonフォーマットです
v2.0向けとフォーマットが異なっているのでご注意下さい

旧フォーマットはv2.1以降も引き続き利用可能ですが、今後廃止する可能性があります

Json構成

JsonはこのJsonが何向けのJsonであるかを表す「meta部」と、データの本体である「data部」から構成されます
プロトコルにHTTPを利用する場合は、meta部を省略しdata部の中身のみを送信してください

TCP/WebSocket利用時のJson例

テキストの読み上げ

{
  "meta":{
    "type" : "speechText"
  },
  "data":{
    "name": "ゆかり",
    "text": "こんにちはみなさん",
    "emotion": "greeting",
    "tag": "white",
    "isInterrupt": false
  }
}

キャラクタの状態変更

{
  "meta":{
    "type" : "characterOption"
  },
  "data":{
    "character": "Inkling_Girl",
    "optionParams": {
        "blue": 0.0,
        "green": 0.3,
        "red" : 1.0
    }
  }
}

HTTP利用時のJson例

テキストの読み上げ(/talk)

{
    "name": "ゆかり",
    "text": "こんにちはみなさん",
    "emotion": "greeting",
    "tag": "white",
    "isInterrupt": false
}

キャラクタの状態変更(/character)

{
   "character": "Inkling_Girl",
   "optionParams": {
       "blue": 0.0,
       "green": 0.3,
       "red" : 1.0
   }
}

パラメータ解説

root

キー名省略可否詳細
metaobjectHTTP時省略可Jsonのメタ情報部分です
dataobjectHTTP時は中身のみ必要データの本体部分です

meta部分

キー名省略可否詳細
typestringHTTP時省略可このJsonがどのAPI用のデータであるかを表します
次の2つのどちらかを指定してください
  • "speechText" : 喋らせるテキストデータ
  • "characterOption" : キャラクタの状態変化データ

data部(speechText用)

キー名省略可否詳細
namestring省略可メッセージの送信者名を指定します
未指定の場合は空文字列になります
textstring必須読み上げさせるメッセージ本文を指定します
emotionstring省略可キャラクタに取らせる感情アニメーションを指定します
指定した場合はみくみくまうす側の感情解析結果を無視して指定のアニメーションを再生します
noneを指定した場合はみくみくまうす側の設定を優先します(感情解析の結果を用いてアニメーションする)
未指定の場合はnoneになります
tagstring省略可コメントカラーフィルタの判定に用いられます
みくみくまうすを多重起動する場合はここを指定することで読み上げキャラクタの制御が行えます
未指定の場合は "white" 扱いとなります
isInterruptbool省略可割り込みメッセージであるかを指定します
割り込みメッセージは現在の読み上げのキューを無視し、最優先で読み上げさせることができます
複数台みくみくまうすを起動している場合にも、割り込みコメントの読み上げが最優先となります(プロセス間で同期して読み上げ制御します)
未指定の場合はfalseとなります

data部(characterOption用)

キー名省略可否詳細
characterstring必須変更対象のキャラクタ名を指定します
現在対応しているキャラクタは以下の通りです(要望次第で追加します)
  • "Inlinkg_Girl" :きの式インクリング
  • "TsurumakiMaki_kino" :きの式弦巻マキ
optionParamsobject必須対象のキャラクタの状態変化行うためのパラメータを指定します
キャラ別のパラメータ詳細

emotion一覧

名前詳細
noneアニメーションせずに読み上げます
ただし「感情解析を行う」設定になっている場合はその結果を用いてアニメーションします
hakushu拍手します
byebye片手を振ります
wktk両手を握りガッツポーズします
question首を傾げます
notsay口を両手で押さえます
happy両手を頬にあててニコニコします
shy照れます
no両手でバッテンを作ります
present両手を前に向けてプレゼントを渡すような動きをします
greetingお辞儀します
cry泣きます
tsukkomiツッコミを入れます
meirei指を突き出します
bikkuri驚きます
response数回頷きます
salute片手を大きく上げてます
tsukkomiツッコミを入れます
warai笑顔になります

tag一覧

全て小文字で指定して下さい
  • white
  • red
  • pink
  • orange
  • yellow
  • green
  • cyan
  • blue
  • purple
  • black

旧Jsonフォーマット

各プロトコル共通で、以下の形式のJSONを送信してください

こちらはみくみくまうすv2.0のJsonフォーマットです

こちらのフォーマットはv2.1以降も引き続き利用可能ですが、今後廃止する可能性があります

キー名省略可否詳細
namestring省略可メッセージの送信者名を指定します
未指定の場合は空文字列になります
textstring必須読み上げさせるメッセージ本文を指定します
emotionstring省略可キャラクタに取らせる感情アニメーションを指定します
指定した場合はみくみくまうす側の感情解析結果を無視して指定のアニメーションを再生します
noneを指定した場合はみくみくまうす側の設定を優先します(感情解析の結果を用いてアニメーションする)
未指定の場合はnoneになります
tagstring省略可コメントカラーフィルタの判定に用いられます
みくみくまうすを多重起動する場合はここを指定することで読み上げキャラクタの制御が行えます
未指定の場合は "white" 扱いとなります
isInterruptedbool省略可割り込みメッセージであるかを指定します
割り込みメッセージは現在の読み上げのキューを無視し、最優先で読み上げさせることができます
複数台みくみくまうすを起動している場合にも、割り込みコメントの読み上げが最優先となります(プロセス間で同期して読み上げ制御します)
未指定の場合はfalseとなります

{
    "name": "ゆかり",
    "text": "こんにちはみなさん",
    "emotion": "greeting",
    "tag": "white",
    "isInterrupted": false
}