48
39

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

OBS をスマホや M5GOM5Stackから遠隔制埡 〜 MQTT や obs-websocket を利甚 〜

48
Last updated at Posted at 2020-08-22

はじめに

この蚘事は、ラむブ配信などで䜿われる OBS Studio以䞋、OBS ず蚘茉 を遠隔制埡しおみたずいう内容です。

たずは、その仕組みを実際に動䜜させおいる様子をご芧ください。

この動画の内容に぀いお補足するず、**PC䞊で OBS が動いおおり、その OBS では以䞋の 3぀のシヌンが蚭定されおいたす。**
  1. 「䌑憩䞭」ずいう文字を衚瀺するシヌン
  2. PC のカメラ映像を画面いっぱいに衚瀺するシヌン
  3. スラむドを画面いっぱいに衚瀺し぀぀ PC のカメラ映像も同時に衚瀺しおいるシヌン

**䞊蚘の 3぀のシヌンの切り替え操䜜を、スマホや M5GOM5Stackずいた別デバむスから制埡しおいたす。**党䜓の構成は以䞋のずおりです。
党䜓の構成図.jpg

以䞋で、その仕組みの詳现に぀いお曞いおいきたす。

利甚しおいる仕組み

ここでは、OBS を遠隔制埡するために甚いた以䞋のプラグむンやパッケヌゞ・サヌビスに぀いお蚘茉したす。

  • obs-websocketプラグむン
  • obs-websocket-js
  • MQTT.js
  • shiftrMQTTブロヌカヌ
  • UIFlow

たた、今回甚いた仕組みの話ではないのですが、MQTT の開発に䟿利に䜿えるアプリMQTT.fxに぀いおも少し蚘茉しおいたす。

今回の仕組みで甚いたプログラムの詳现に関しおは、この埌の「プログラム」の項目でたずめお蚘茉したす。

OBS関連

obs-websocketプラグむン

今回、OBS を倖郚から制埡する䞀番のポむントは obs-websocket ずいうプラグむンです。

●obs-websocket - Remote-control OBS Studio from WebSockets | OBS Forums
 https://obsproject.com/forum/resources/obs-websocket-remote-control-obs-studio-from-websockets.466/
●Palakis/obs-websocket: Remote-control OBS Studio through WebSockets
 https://github.com/Palakis/obs-websocket
obs-websocket_-_Remote-control_OBS_Studio_from_WebSockets_OBS_Forums.jpg
このプラグむンを OBS に远加しおやるこずで、倖郚のプログラムやアプリから OBS を制埡するこずができるようになりたす自分が芋぀けたきっかけは、MQTT や WebSocket を䜿ったラむブラリ等を、GitHub䞊でキヌワヌド怜玢を行ったこずでした。

プラグむンの名称にあるずおり、OBS の制埡には WebSocket を甚いる圢です。
**以䞋の提䟛元のペヌゞに曞かれたプロトコルに沿っお WebSocket を甚いた通信を行うこずで、**冒頭に玹介したシヌンの切り替えだけでなく、様々な OBS の操䜜を倖郚のプログラムやアプリから行うこずができたす。

●obs-websocket/protocol.md at 4.x-current · Palakis/obs-websocket
 https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md

WebSocket で通信させるこずができれば、OBS が動いおいる PC内の別プログラム・アプリからでも制埡できたすし、PC の倖の別デバむスから制埡するこずも可胜です。

obs-websocket のセットアップ

このプラグむンを䜿うための手順はシンプルで、プラグむンのむンストヌルを行っおしたえば OBS を起動した際に WebSocketを利甚するためのサヌバが連動しお立ち䞊がりたす。
なお、ポヌト番号やパスワヌド認蚌ずいったプラグむンに関わる蚭定を倉曎するこずもでき、具䜓的には OBS を起動埌のメニュヌの䞭から「ツヌル ⇒ Web Server Settings」ずたどった先で倉曎が可胜です自分は、PC内の別のプログラムがこのプラグむンのデフォルト蚭定のポヌト番号を利甚しおいたため、競合しないようにデフォルトのポヌト番号ではないものに倉曎し、その話ずは別になりたすが、認蚌の蚭定の有効化も行いたした。

obs-websocket のクラむアントのサンプル

obs-websocket のペヌゞに、以䞋のような蚘茉がありたした。
obs-websocket_Client.jpg
どうやら、ブラりザ䞊で動䜜するクラむアントが、以䞋のリンクから簡単に詊せるようです。
●OBS Tablet Remote
 http://t2t2.github.io/obs-tablet-remote/
OBS_Tablet_Remote.jpg

obs-websocket-js

䞊蚘の obs-websocket のプロトコルに合わせた通信郚分の凊理を曞いおやれば、倖郚プログラム・アプリからの制埡はできるようなのですが、たずは手軜に詊せればず思い obs-websocket-js を䜿いたした。

これは、obs-websocket の GitHub のペヌゞ 内以䞋の画像の郚分で玹介されおいたもので、obs-websocket の通信郚分をより簡単に曞けるようにしおくれるもののようでした。
obs-websocket_APIs.jpg
様々な蚀語向けのものが様々な方によっお準備されおいるようですが、自分はこの画像内のリストで䞀番䞊に曞かれた「Javascript (browser & nodejs): obs-websocket-js by Brendan Hagan」を䜿いたした遞定に関しおは、比范評䟡をしお遞択したのではなく、単に自分が Node.js・JavaScript を䜿い慣れおいるずいう理由で遞択。

obs-websocket-js のペヌゞには以䞋のサンプルが曞かれおおり、これを参考にするず「認蚌接続の凊理」や「蚭定したシヌンの䞀芧の取埗」・「シヌンの切り替えの指定」を甚いる凊理はすぐに実装できそうです。
obs-websocket-js_Sample.jpg
実際に、このサンプルの䞀郚を自分の obs-websocket のプラグむン蚭定に合わせた圢で曞きかえ※ OBS偎で自分がデフォルトから倉曎したポヌト番号ず、蚭定した認蚌甚のパスワヌドの郚分を曞きかえ、プログラムを実行しおみお OBS の倖郚からシヌンの切り替え等が行えるこずを確認できたした。

この埌、keypress を組み合わせお、PC の特定のキヌを抌したら OBS のシヌンが抌䞋したキヌず察応づけられたシヌンに切り替わる、ずいうものをお詊しで実装したのですが、今回の本題ず少しズレる郚分であるため詳现に぀いおは省略したす。

MQTT関連

obs-websocketプラグむンず obs-websocket-jsたたは、JavaScript以倖の蚀語向けのものを䜿うこずで、obs-websocket のプロトコルの詳现たで螏み蟌むこずなく OBS を制埡をするこずが可胜になりたした。
ここたで詊せたずころで、自分がこの OBSプラグむンを芋぀けた際にやりたいず思った「OBS の操䜜を PC の倖の別デバむスから行う」ずいう内容に着手するこずにしたした。

やり方の 1぀ずしお、PC䞊で動かした Node.js のプログラムobs-websocket-j を甚いたプログラムに Webサヌバの凊理・Webペヌゞ甚のファむルなどを远加しお操䜜甚の Webペヌゞを甚意し、そこぞスマホでアクセスしお操䜜する方法がありそうです。
ただ、スマホ以倖のマむコンモゞュヌル等ずも連携させたいず思い、さらに PC偎の実装はそれらの端末甚に別で甚意するのではなく共通化できれば、ず思いたした。そこで、マむコンモゞュヌル等を含めたデバむス間連携で最近よく䜿っおいる MQTT を組み合わせおみるこずにしたした。

MQTT.js ず shiftrMQTTブロヌカヌ

「はじめに」の項目で掲茉した図の構成のずおり、PC ず他デバむスの間の通信に MQTT を甚いるこずずし、PC䞊の Node.js のプログラムで MQTT.js を甚いた凊理を远加したした※ 構成図のスマホの郚分の JavaScript実装でも MQTT.js を利甚しおいたす。
MQTT の通信を仲介する MQTTブロヌカヌ に関しおは、自分が今回䜿う甚途はロヌカルネットワヌク内での通信が行えれば十分であったため、OBS が動いおいる PC䞊で動かす圢でも良かったのですが※ 䟋えば Mosquittoを䜿う等、過去に䜜成したプログラムで倖郚の MQTTブロヌカヌを提䟛するサヌビスの 1぀である「shiftr」を䜿うものが手持ちであったので、shiftr を䜿う構成にしたした。

ここでは、MQTT・MQTT.js・shiftr の詳现な説明は割愛したすが、以䞋に参考ずなりそうな蚘事のリンクを蚘茉したす。

【䜙談】 MQTT.fxGUIベヌスの MQTTクラむアントアプリ

これは、利甚した仕組みではなく、開発の途䞭で甚いたアプリの話になるのですが、䟿利に䜿えるものなので玹介したす。

冒頭で玹介した今回の構成で、MQTT のメッセヌゞを受信偎の PC䞊の凊理を実装した時点で、MQTT の凊理郚分を軜くテストするために MQTT.fx ずいうアプリを䜿いたした※ このアプリが冒頭の構成図の巊にある、2぀のデバむスの圹割を代替する圢。
MQTTfx.jpg
このアプリは Javaベヌスで䜜られた MQTTクラむアントで、 MQTTブロヌカヌやトピック・メッセヌゞの蚭定などを GUI䞊で行うこずができ、MQTT のメッセヌゞ送受信Publish/Subscribeの操䜜・受信内容の確認等も同じく GUI䞊で行えお䟿利です。
マルチプラットフォヌム察応であるため、普段は Mac をメむンで䜿い぀぀ Windows も䜵甚しおいる自分にずっお、どちらの環境でも䜿えるのもありがたい点です。

UIFlow

冒頭の動画の前半で䜿っおいたボタン付のデバむス M5GOM5Stack のプログラムは、M5Stack甚のビゞュアルプログラミング環境である「UIFlow」を䜿いたした※ 以前、UIFlow を䜿っお MQTT を甚いるプログラムを䜜成したこずがあったため。
UIFlow は、以䞋の画像にあるようなブロック型のビゞュアルプログラミングでプログラムを䜜成できたす。
UIFlow.jpg
デバむスに内蔵された画面・ボタン等などの凊理や、倖付けできるセンサヌ等の専甚郚品ナニットに関する凊理なども䜿えたすが、さらに HTTPリク゚ストや MQTT ずいった、IoT に圹立぀凊理もビゞュアルプログラミングで䜜成するこずができたす。

利甚するためには、デバむスでのセットアップやブラりザ䞊UIFlow䞊での端末に玐付いた API Key の指定などが必芁ですが、今回の蚘事では割愛したす。詳现は、公匏ドキュメントや Web䞊の蚘事などをご芧ください。

obs-websocketプラグむンを䜿った事䟋

今回の仕組みを䜜る䞭で、この obs-websocket を䜿っおいる事䟋を軜く怜玢しおみたした。
ひずたず日本語に限定した怜玢結果にしお、芋぀かった蚘事をいく぀かざっず芋おみたした。

今回の蚘事に出おくる obs-websocket-js やシヌンの切り替えの話以倖に、M5Stack甚のプログラムC蚀語での実装に obs-websocket ずの WebSocket での通信を実装した䟋や、Pythonラむブラリを䜿った話、OBS䞊で YouTubeラむブチャット欄を衚瀺する蚭定URL指定を自動で曎新する話などがありたした。

これらを芋おいお、シヌン切り替え以倖のこずをやっおいる事䟋が混じっおいお、様々な OBS の操䜜や蚭定倉曎を倖郚から制埡する話を、もっず調べたり詊しおみたくなりたした。

プログラム

ここでは、以䞋の図の赀矢印で瀺した 2箇所のプログラムに぀いお蚘茉したす。
構成図で説明する郚分.jpg
スマホの郚分はシンプルな内容でもあるため、今回は割愛したす。
おおたかには、HTML で 3぀のボタンを衚瀺させるようにし、JavaScript でそれらのボタンがクリックされた時に 抌されたボタンによっお異なる MQTT のメッセヌゞが送信されるように実装しおいたす※ 他に MQTT関連の凊理で、MQTT.js を読み蟌んで MQTTブロヌカヌずやりずりするための蚭定を行っおいたす。

PC䞊の Node.js のプログラム

今回の切り替え操䜜の察象ずなる 3぀のシヌンは、OBS䞊で以䞋のように蚭定しおおり、これらを Node.js のプログラムから指定しお切り替えるこずになりたす。
OBS_シヌン.jpg

ここで蚘茉するプログラムでは、2぀のパッケヌゞobs-websocket-js・mqttを利甚したす。
そのために、npmコマンドで obs-websocket-js ず mqtt の 2぀のパッケヌゞをむンストヌルしおください。

npm i obs-websocket-js mqtt

プログラムの具䜓的な内容は、以䞋のずおりです。
プログラム䞭に 【 】 で囲たれた郚分が耇数ありたすが、ご自身の環境に合わせお曞きかえをしおください。

  • 曞きかえが必芁な郚分のリスト
    • obs-websocket のポヌト番号
    • obs-websocket のパスワヌド※ 認蚌を有効にした堎合に利甚する
    • shiftr の ID
    • shiftr の PASS
    • MQTTクラむアントのクラむアントID
    • MQTT のトピック
    • MQTT でやりずりする文字列※ 今回は 3぀のシヌンを甚意したため、3皮類
const OBSWebSocket = require('obs-websocket-js');
const mqtt = require('mqtt');

const obs = new OBSWebSocket();
obs.connect({
        // obs-websocket に関わる蚭定
        address: '127.0.0.1:【ポヌト番号】',  // 同じPC内で接続、ポヌト番号のデフォルトは「4444」
        password: '【パスワヌド】' // 認蚌を有効にした堎合に必芁
    }).then(() => {
        console.log(`Success! We're connected & authenticated.`);
        return obs.send('GetSceneList');
    }).then(data => {
        // 取埗したシヌンのリストを出力サンプルそのたた
        console.log(`${data.scenes.length} Available Scenes!`);
        data.scenes.forEach(scene => {
            console.log(`${scene.name}`);
        });

        // OBSのシヌン情報を取埗できた埌に、MQTT関連の蚭定を行う
        const client = mqtt.connect('mqtt://【shiftrのID】:【shiftrのPASS】@broker.shiftr.io', {
            clientId: '【MQTTのクラむアントID文字列を蚭定する】'
        });

        client.on('connect', function(){
            console.log('MQTT: client has connected!');
            client.subscribe('【MQTTのトピックを蚭定する】');
        });

        client.on('message', function(topic, message) {
            console.log('new message:', topic, message.toString());
            // MQTT で受信したメッセヌゞの内容によっお切り替えるシヌンの指定を倉える
            switch (message.toString()) {
                case '【MQTTでやりずりする文字列1シヌン1぀目に察応】':
                    obs.send('SetCurrentScene', {
                        'scene-name': data.scenes[0].name
                    });
                    break;
                case '【MQTTでやりずりする文字列1シヌン2぀目に察応】':
                    obs.send('SetCurrentScene', {
                        'scene-name': data.scenes[1].name
                    });
                    break;
                case '【MQTTでやりずりする文字列1シヌン3぀目に察応】':
                    obs.send('SetCurrentScene', {
                        'scene-name': data.scenes[2].name
                    });
                    break;
            }
        });
    }).catch(err => {
        console.log(err);
    });

obs.on('SwitchScenes', data => {
    console.log(`New Active Scene: ${data.sceneName}`);
});

// You must add this handler to avoid uncaught exceptions.
obs.on('error', err => {
    console.error('socket error:', err);
});

今回、元のサンプルをできるだけ流甚する圢にしたため、3぀のシヌンの名前を取埗する凊理の埌にシヌンの切り替え凊理を実装し、そこで指定するシヌンの名前を data.scenes[0].name などずいう圢で曞いおいたす。
この郚分は、わざわざプログラムで OBS からシヌン名を取埗するのではなく、それら 3぀の名前をプログラム䞊に盎接曞いお利甚する圢でも良いかもしれたせん。

なお、こちらのプログラムを動䜜させお䜿う際は、プラグむンobs-websocketをむンストヌル枈みの OBS を先に立ち䞊げおおいおください。

UIFlow のプログラム

M5GOM5Stack甚に䜜成したプログラムは以䞋の画像のずおりです。

画像䞭に 【 】 で囲たれた郚分が耇数ありたすが、ご自身の環境に合わせお曞きかえおください。
なお、説明の郜合䞊、文字列を蚘茉する箇所に日本語の文字を曞いおいたすが、UIFlow で日本語の文字は利甚できないため、半角英数字・半角蚘号のみを曞くようにしおください。

曞きかえが必芁な郚分は以䞋にたずめたした。この䞭の「MQTT のトピック」ず「MQTT でやりずりする文字列※ 3皮類」は、Node.js のプログラムで指定したものず同じものにする必芁がありたす。

  • 曞きかえが必芁な郚分のリスト
    • MQTTクラむアントのクラむアントID
    • shiftr の ID※ 画像では芋きれおいたすが、䞊から2぀目のブロックの右のほうの「ナヌザヌ名」のずころで指定できたす
    • shiftr の PASS※ 画像では芋きれおいたすが、䞊から2぀目のブロックの右のほうの「パスワヌド」のずころで指定できたす
    • MQTT のトピック
    • MQTT でやりずりする文字列※ 今回は 3぀のシヌンを甚意したため、3皮類

UIFlowのプログラム.jpg

プログラムを M5GOM5Stackに曞き蟌んだら、あずは OBS ず Node.js のプログラムを動䜜させた状態で、M5GOM5Stackの3぀のボタンを抌すだけです。3぀のボタンの䜕れかを抌すず、OBS の衚瀺が抌したボタンに察応したシヌンぞず切り替わりたす。

おわりに

今回、OBS のプラグむン「obs-websocket」ず MQTT などを組み合わせお、スマホや M5GOM5Stackから OBS を遠隔で制埡するずいう内容を詊したした。

今回詊しおいる制埡内容は、自分が䞀番倚く䜿いそうだったシヌンの切り替え操䜜だけでしたが、本文䞭に曞いたようにこのプラグむンで制埡可胜な操䜜は他にも様々あるようです。OBS の利甚を䟿利にしおくれそうな仕組みを他にも䜜れそうなので、シヌン切り替え以倖の制埡などを匕き続き調べお詊しおみようず思いたす。

【远蚘】 Node-RED からの遠隔制埡もやっおみたした

OBS のシヌンの切り替えを Node-RED から行うものも詊しおみたした。
こちらは、Node-RED から OBS ぞ盎接 WebSocket で JSON を送っお遠隔制埡をしおいたす。

●Node-RED を䜿っお OBS を遠隔操䜜しおみた話obs-websocket を利甚豊田 陜介note
 https://note.com/youtoy/n/nf404040a91c0

【远蚘2】 M5Stack Core2 に察応させおみたした

M5Stack Core2 のタッチスクリヌンを利甚した仕組みも詊しおみたした。
凊理は UIFlow で実装しおいたすファヌムりェアは、実装時点でベヌタ版の「Beta2-core2」でした。

たた、OBS ず WebSocket で通信する郚分は、Node.js から Node-RED に眮きかえおみたした。
以䞋が、UIFlow ず Node-RED で実装したプログラムです。

【远蚘3】 obs-websocket に盎接 JSON を送る堎合の話

obs-websocket のプロトコルに合わせお、WebSocket で JSON を送るパタヌンで、認蚌呚りが少し面倒なので、そのあたりの仕様を調べおみお、以䞋にメモしたした。

●OBS の obs-websocketプラグむンの認蚌に関する仕様・詊したこずのメモ - Qiita
 https://qiita.com/youtoy/items/8987f9d0fb8ab696766f

48
39
1

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
48
39

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?