Live Streaming API を利用した THETA Plugin の開発ガイド

本文書は RICOH Live Streaming API を用いた THETA Plugin の開発者向けに開発手順やノウハウを解説する文書である。THETA に関連が強い内容を記載する。

1. 前提

アプリケーション開発者ガイド

RICOH Live Streaming API を用いた開発の共通部分についてはアプリケーション開発者ガイドを参照

2. 利用する SDK

Client SDK for Android

RICOH Live Streaming API を用いた Android 向けの SDK である。THETA Plugin のサンプルプログラムを含む。Client SDK アプリケーション開発者ガイドを参照

THETA Plugin SDK

THETA Plugin の開発情報は以下を参照

Android SDK

Android SDK の情報は以下を参照

3. 開発準備

開発者モード

以下に従い、THETA を開発者モードにしておく。

なお、開発者モードにするためには以下の開発者登録が必要になります。

RICOH THETA Z1 51GB、RICOH THETA X の開発者登録について

※RICOH THETA Z1 51GB(シリアルナンバーが YN35 から始まる機器)、RICOH THETA X(シリアルナンバーが YR15 から始まる機器)では RICOH THETA クライアントモードを使用した開発を希望する場合、追加の事前申請が必要となります。
(すでに RICOH THETA プラグインパートナープログラムにご登録頂いているお客様も、初めて RICOH THETA Z1 51GB、RICOH THETA X を追加申請する前には同様の事前申請が必要となります。)
具体的には、下記手順に従い申請をお願いいたします。

  1. RICOH Live Streaming API のアカウントを登録し、ClientID/Secret の取得をおこなってください。(取得済みの方は省略可能です)
    • アカウント登録はこちら
    • ClientID/Secret の登録はこちらからログインを行い、「RICOH Live Streaming API はじめてご利用になるお客様へ」から ClientID の発行申請をお願いします。
  2. 事前申請フォーム( https://webform.ricoh.com/form/pub/e00101/support51gb )より事前申請をお願いします。
    • Live Streaming API のアカウント登録に利用したものと同じ「ご担当者名、メールアドレス」を記載ください
    • 「[必須] 開発を計画しているプラグインの概要を教えてください」の 1 行目に下記を追加でご記載ください。これにより、RICOH Live Streaming API の利用であることを確認いたします
RICOH Live Streamingを利用 / ClientID: [上記手順により取得したClientID *のみ* 記載ください
(Secretは秘密情報であるため記載しないでください)]

記載例

RICOH Live Streamingを利用 / ClientID: abcdefghijklmnopqrstuvwxyz0123456789ABCDEFG
  1. 弊社より「RICOH THETA プラグインパートナープログラムへ登録可」の旨メールで返信がありましたら、改めて RICOH THETA プラグインパートナープログラムの登録申請をお願いいたします
    • パートナープログラムの詳細はこちらをご覧ください
    • 登録フォームはこちらになります
      • 登録の際のメールアドレスは上記手順の申請で利用した物と同じものとしてください
  2. 上記申請完了後は、開発者モードへの変更が可能となります。詳細の手順については【THETA プラグイン開発】THETA を開発者モードにする手順をご確認ください。
  3. RICOH THETA Z1 51GB、RICOH THETA X では、弊社の確認を受けていない THETA Plugin(開発中を含む)の起動が制限されます。詳細はこちらをご確認ください。

ツール

最低限必要もしくは有用なツール

  • RICOH THETA 基本アプリ(PC)
  • RICOH THETA 基本アプリ(スマートフォン)
    • https://theta360.com/ja/about/application/basic.html
    • RICOH THETA 基本アプリ(スマートフォン)を使って THETA とスマートフォンを接続することで、自動的に時刻補正が行われる。
    • THETA の時刻が正しくないと RICOH Live Streaming API が正常に動作しない場合がある。
  • Android Studio
    • Client SDK for Android のサンプルをビルド可能になるようセットアップを行う。
      • File > Settings > Appearance & Behavior > System Settings > Android SDK から以下をインストールする。
        • Android SDK Build-Tools 28.0.3
        • Android SDK Platform 29
      • File > Settings > Appearance & Behavior > System Settings > SDK Tools から以下をインストールする。
        • NDK 21.4.7075529
    • platform tools 配下の adb コマンドにパスを通す。
  • Vysor

THETA の WiFi 設定

THETA が WiFi クライアントモードで動作するように設定する。

THETA のスリープ設定

THETA を一定期間操作しないとスリープしてしまうため、必要に応じてスリープを OFF 等にする。

プラグインのインストール方法

プラグインの初回起動時にはプラグインで利用する機能のパーミッションを付与する必要があるが、 -g オプションを用いるとマニフェストに記載のパーミッションを全て付与できる。 Vysor でパーミッションを付与することもできる。

adb install -g XXplugin.apk

プラグインのアンインストール方法

プラグインをクリーンインストールする場合は事前にアンインストールする。

プラグインの起動設定

起動対象とする THETA Plugin を指定する。

プラグインの起動方法

  • THETA V : モードボタンを長押しする。
  • THETA Z1 : インストールされているプラグインの数によって異なる。
  • THETA X : プラグイン選択画面を表示してから起動したいプラグインをタップする。
    • モードボタンを長押しすると、最後に起動したプラグインを起動できる。

THETA Plugin 開発着手の際には

RICOH THETA X および RICOH THETA Z1 51GB 上で THETA Plugin の動作確認を行う際には、弊社にて「端末設備等規則及び電気通信主任技術者規則の一部を改正する省令」への適合確認が必要です。
確認を受けていない THETA Plugin は、ネットワークに接続された状態でのプラグイン起動がエラーとなり制限されます。
以前は個別にご申請いただいておりましたが、非公開でのプラグイン共有が可能になったことに伴い、THETA PLUG-IN STORE へのプラグイン共有を申請することで、上記適合確認が実施されるようになりました。
THETA PLUG-IN STORE へのプラグイン公開手順(公開手続き編)を参考に、ご申請ください。