SkyWay

戻る

Android SDK

開発者ドキュメントユーザーガイドAndroid SDK概要

SkyWay Android SDK の概要

SkyWay Android SDK(以下、Android SDK)は Android デバイス用のアプリケーションから SkyWay を利用するための SDK です。 Android のネイティブなアプリケーションに SkyWay を組み込むことで、デバイス同士やブラウザとのリアルタイム通信を実現できます。

このセクションでは、Android SDK の動作環境や入手方法を掲載しています。 Android SDK の採用を検討する際の参考情報としてください。

対応環境

項目SkyWay Android SDKの対応状況
OSAndroid 5.0 Lollipop(API Level 21)以降
CPUアーキテクチャarm64-v8a、armeabi-v7a、x86_64、x86、
推奨するIDEAndroid Studio

※原則として、一般のスマートフォン上での動作、またはエミュレータによる動作検証を想定しています。

アプリケーション開発言語

  • Kotlin

Kotlin は Android アプリケーション開発の公式でサポート言語であり(2023年現在)、Android Studio のような開発環境で利用できます。

ライブラリの仕様

SkyWay を利用する上で理解する必要のある基本的な仕様について説明します。

Room

通話を行うグループの単位であり、ユーザーは共通の Room に参加したユーザー同士で通話を行います。

P2P Room と SFU Room の 2 種類の Room があり、どちらかを選択して利用できます。

Roomの使い分けは以下の通りです。

  • P2P Room は少人数向け
    • 上限人数に制限はありませんが、ユーザーが快適に通話できる人数は 4 人までです
  • SFU Room は多人数向け
    • SFU サーバーを経由してメディア通信を行います

Member

Room に参加しているユーザーのことを Member と呼びます。

Stream

Room 上で送受信できるメディアのことを Stream といいます。以下の 3 種類の Stream を利用できます。

  • AudioStream
    • ユーザーのマイク音声など
  • VideoStream
    • ユーザーのカメラ映像など
  • DataStream
    • 任意のメッセージ
    • SFU-Room では利用できません

Publish

Member が Stream を Room に公開することを Publish といいます。

Stream を Publish すると Room 上に Stream に対応する Publication というリソースが作成されます。

Subscribe

Member が Room 上の Publication を受信することを Subscribe といいます。

Subscribe をすると Room 上に Subscription というリソースが作成されます。

Publication を Subscribe した Member は Subscription を通じて Stream にアクセスし映像や音声を受信できます。

SkyWay Auth Token

SkyWay Auth Token は、SkyWay を利用するために必要な JWT（JSON Web Token）形式のトークンです。

ユーザー毎に権限を細かく設定することでき、例えば Room ごとの入室を特定ユーザーに制限する、といったことができます。

SkyWay Auth Token を利用するためには、これを払い出すアプリケーションサーバーを構築する必要があります。SkyWay SDK を利用したクライアントアプリは、アプリケーションサーバーから SkyWay Auth Token を取得し、これを用いて各種 SkyWay の機能を利用します。

なお、サーバーを構築せずにフロントエンドで SkyWay Auth Token を生成した場合、シークレットキーをエンドユーザーが取得できるため、権限の制限が機能せず注意する必要があります。

SDK のダウンロード

Maven Central Repository にて配布を行なっています。

導入先の app/build.gradle にて、以下の依存関係を追記してください。

// 最新の SDK バージョンに差し替えてください
// 最新の SDK バージョン情報は以下のリンクより、Maven Central Repository にて確認できます
// https://central.sonatype.com/search?q=skyway
def skywayVersion = 'x.x.x'

dependencies {
  implementation "com.ntt.skyway:room:$skywayVersion"
}

旧Android SDK(skyway.aar)との互換性と共存

互換性はありません。

1つのアプリで新旧 SDK を共存することは v4.0.2 から可能です。

既知の問題

クイックスタート(Android View)