今回はわんコメのプラグイン開発についてのお話です。
わんコメは配信サイトでのコメントを取得し、表示から読み上げ、演出などを行えるアプリです。
今回はこのわんコメのプラグインを開発してみたいと思います。
作成するプラグインについて
今回は初めの一歩としてシンプルに一番新しいコメントの情報をブラウザで表示する、というものを開発してみます。
今回は最新のコメントだけですが、これをもとに拡張していけば色々な機能を持たせることができると思います。
plugin.js
まずはソースです。
// 最新コメント情報
var lastData = {
userName: "", // 名前
comment: "", // コメント
}
// プラグイン登録
module.exports = {
name: 'TestPlugin', // @required プラグイン名
uid: 'com.onecomme.test-plugin', // @required プラグインID
version: '0.0.1', // @required バージョン
author: '名前', // @required 名前
url: 'http://localhost:11180/plugins/com.onecomme.test-plugin/index.html', // @optional URL
permissions: ['comments'], // @required パーミッション
// コメント受信時の処理です
subscribe(type, ...args) {
switch (type) {
case "comments": {
for(const comment of args[0].comments)
{
lastData.userName = comment.data.name;
lastData.comment = comment.data.comment;
}
break;
}
}
},
// プラグインRestAPI実行時の処理です
async request(req) {
switch (req.method) {
case 'GET': {
return {
code: 200,
response: JSON.stringify(lastData)
}
}
default: {
return {
code: 404,
response: {}
}
}
}
}
}簡単にですが解説します。
「permissions」に「comments」を指定することで、視聴者さんからコメントをもらったタイミングで「subscribe」が実行されるようになっています。この「subscribe」において毎回コメントの情報を保持しています。
そして、プラグインRestAPI実行時の処理である「request」において、保持していたコメント情報を返しています。なおこの処理はこの後説明するindex.htmlのボタンが押下されたときに実行されます。
index.html
<!doctype html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>わんコメ用TestPlugin</title>
</head>
<body>
<button id="fetchButton">データを取得</button>
<div id="result">ここに結果が表示されます</div>
<script>
// 要素を取得する
const fetchButton = document.getElementById('fetchButton');
const resultDiv = document.getElementById('result');
// 押下時処理を登録する
fetchButton.addEventListener('click', async () => {
try {
const response = await fetch('http://localhost:11180/api/plugins/com.onecomme.test-plugin');
const result = await response.json();
if (200 !== result.code) {
resultDiv.textContent = `エラーが発生しました。code: ${result.code}`;
return;
}
// 最新コメント情報を取得する
const lastData = JSON.parse(result.response);
// 取得したデータを表示する
resultDiv.textContent = `最新コメント者:${lastData.userName}, コメント:${lastData.comment}`;
} catch (ex) {
resultDiv.textContent = `例外が発生しました: ${ex.message}`;
}
});
</script>
</body>プラグイン
</html>
簡単にですが解説します。
このHTMLではボタンが1つとメッセージが表示されます。
ボタンが押下されると、「fetch」によりplugin.jsの「request」につながります。結果plugin.jsの最新コメント情報が入手でき、HTMLに反映することでブラウザに最新コメント情報を表示します。
ファイル配置
以上の2ファイルをわんコメのプラグインフォルダに「test-plugin」という名前のフォルダを作り配置します。プラグインフォルダはわんコメを起動し、メニューからプラグインを選択後、「プラグインフォルダ」を押下すると簡単に表示できます。
もしフォルダの名前を変更した場合にはplugin.jsの「url」を変更することをわすれないでください。もし変更を忘れてしまうとブラウザで表示できなくなってしまいます。
わんコメの設定
最新メッセージの表示
わんコメのプラグイン画面の「TestPlugin」行の右から2つ目のURL欄をクリックするとブラウザが起動します。表示されるのが先ほどのindex.htmlです。
あとはこの状態でコメントを受信します。コメントの受信方法についてはすみませんがここでは説明しません。コメントテスターでも実際の配信サイト上のコメントでも大丈夫です。
コメントを受信したらブラウザの「データを取得」ボタンを押してみてください。
ボタン下のメッセージ欄にユーザー名とコメントが表示されるはずです。
最後に
今回はわんコメのプラグインの開発についての紹介しました。
簡単ではありますが、プラグインで最新コメントを保持しておき、ブラウザでその情報を取得し表示してみました。
以上、少しでも参考になれば幸いです。次回もよろしくお願いします。

0件のコメント: