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の開発者登録について

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

  1. RICOH Live Streaming APIのアカウントを登録し、ClientID/Secretの取得をおこなってください。(取得済みの方は省略可能です)
    1. アカウント登録はこちら
    2. ClientID/Secretの登録はこちらからログインを行い、「RICOH Live Streaming API はじめてご利用になるお客様へ」からClientIDの発行申請をお願いします。
  2. RICOH THETA Z1 51GB用の事前申請フォーム( 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 プラグインパートナープログラムの登録申請をお願いいたします
    • パートナープログラムの詳細はこちらをご覧ください
    • 登録フォームはこちらになります
      • 登録の際のメールアドレスは上記手順の申請で利用した物と同じものとしてください
        1. 上記申請完了後は、開発者モードへの変更が可能となります。詳細の手順については【THETAプラグイン開発】THETAを開発者モードにする手順をご確認ください。
        2. RICOH THETA Z1 51GBでは、弊社の確認を受けていない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
    • platform tools 配下の adb コマンドにパスを通す。
  • Vysor

THETA の WiFi 設定

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

THETA の USB 接続中の WiFi 有効化

通常の THETA は USB 接続中は WiFi が無効になるが、開発中は不便なので、以下により USB 接続中も WiFi を有効にできる。

adb shell settings put global usb_debug true

THETA のスリープ設定

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

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

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

adb install -g XXplugin.apk

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

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

プラグインの起動設定

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

プラグインの起動方法

THETA Plugin開発着手の際には

RICOH THETA Z1 51GB上でTHETA Pluginの動作確認を行う際には、弊社にて「端末設備等規則及び電気通信主任技術者規則の一部を改正する省令」への適合確認が必要となります。

確認を受けていないTHETA Pluginは、ネットワークに接続された状態でのプラグイン起動がエラーとなり制限されます。

新規のTHETA Pluginを開発される際には、リクエストより下記の情報をお知らせください。

  • お知らせ頂きたい情報
    • 法人名(会社名)
    • ご担当者名
    • メールアドレス
    • ClientID(Secretは秘密情報であるため記載しないでください)
    • Plugin名称
    • Pluginに割り当てる予定のPackage (ex. "com.yourcompany.yourapp")
    • 一意である必要があるため、御社のドメイン等を利用の上で、他のアプリと重複しないように決定ください
    • システム/アプリケーションの概要
    • 現状で想定する利用者と規模
    • デバイスの識別/認証方法