Socket.io

Socket.io

イベント

フロントエンド から バックエンド

init, id

• id String チャンネルID

チャンネルIDからサーバーを取得しインスタンス化する 成功した場合は volume, ready イベントを発信し、 失敗した場合は error イベントを発信する

返されるエラーの種類

• INVAILD_CHANNEL_ID
• ALREADY_JOINED

q, q

• q String 検索対象文字列

指定された文字列でYouTubeDataAPIを叩き、 result イベントを発信する

返されるエラーの種類

• NativeYouTubeAPIError

add, data

• data Object
  • id String YouTubeビデオID
  • img String サムネイル画像URL
  • title String ビデオタイトル
  • guild String サーバーID

キューリストにアイテムを追加する

返されるエラーの種類

• UNTREATED_CHANNEL

remove, data

• data Object
  • index Number 再生中のアイテムを0としたときの番号
  • guild String サーバーID

キューリストからアイテムを削除する

返されるエラーの種類

• UNTREATED_CHANNEL
• INVAILD_VALUE

volume, data

• data Object
  • volume Number 0から200で表したボリューム値
  • id String サーバーID

ボリュームを変更する

返されるエラーの種類

• UNTREATED_CHANNEL

バックエンド から フロントエンド

error, error

• error String エラーコード。次のいずれか
  • INVAILD_CHANNEL_ID String 指定したチャンネルIDが存在しないかボイスチャンネルではない場合に返される
  • ALREADY_JOINED String 既に該当のサーバーの別のボイスチャンネルに参加している場合に返される
  • UNTREATED_CHANNEL String サーバーがインスタンス化されていない場合に返される
  • INVAILD_VALUE String remove イベントで不正な値(NaN, 0)が送信された場合に返される
  • NOT_PLAYING_YET String ボットが音楽を再生していない(dispatcherが存在しない)場合に返す
  • NativeYouTubeAPIError Object YouTubeDataAPIが返すエラーオブジェクト

処理中にエラーが起きたときに発信されるイベント

list, queue

• queue QueueItem[] QueueItemの配列

init イベントを受信したとき、または キューリストが更新されたときに発信されるイベント

volume, volume

• volume Number ボットのボリューム（0から200で表される）

init イベントを受信したとき、または ボリュームが変更されたときに発信されるイベント

ready, data

• data Object サーバーの情報を含むオブジェクト
  • guild String サーバー名
  • channel String チャンネル名
  • id String サーバーID

init イベントを受信し、処理が完了したときに発信されるイベント

result, data

• data Object YouTubeDataAPIが返す検索結果

q イベントを受信し、検索が完了したときに送信されるイベント