2. アプリリンク仕様
2.1. アプリリンク概要
Nexmileクライアントはアプリリンクにより、外部(ブラウザー)から制御を行います。
以下アプリリンクを実装するにあたりスマートフォンにNexmileクライアントがインストール済みとします。
システム連携を行う必要がない場合、アプリリンクの実装のみでNexmileクライアントを利用できます。
アプリリンクのみでも、例としてWebサイトからの呼出しを1人のコミュニケータが受ける場合などに御利用頂けます。
アプリリンクとは
スキームに「https+アプリ固有のドメイン」が設定されたURLにアクセスした際、アプリへの遷移を優先するのが主な機能です。iOSではユニバーサルリンクと呼びます。
Nexmileクライアントのアプリリンクを実行する場合はアプリリンクが埋め込まれたWebページが必要となります。
ブラウザーのURL欄に入力しても遷移されませんのでご注意下さい。
2.2. アプリリンクURL
NexmileクライアントのアプリリンクURLは下記となります。
https://sbx.stream-works.biz/sbxapp
上記URLはNexmileクライアントを制御するためにアプリに組み込まれている固定値となり、変更されることはありません。
上記のURLと後述のアプリリンク機能+クエリ形式のパラメータをHTML上にAタグ等で埋め込むことにより、
ウェブページのリンクをクリックした際にアプリが起動し、アプリリンク機能で指定された動作を実行します。
(例)
<a href=" https://sbx.stream-works.biz/sbxapp/activateExUser/?site=newsite.ggsrgdetw&user=XXXXXXXX&pass=YYYY ">登録</a>
2.3. アプリリンク機能
Nexmileクライアントでは以下のアプリリンク機能を使用することでできます。
2.3.1. 共通パラメータ
下記は全てのアプリリンク機能において利用する共通パラメータとなります。
2.3.2. ユーザ認証
連携先システムのユーザをNexmileクライアント・サーバ共に登録します。
このアプリリンク機能を使用するためにはサーバ間連携が必須条件となります。
Nexmileクライアントからの要求はNexmileサーバが受信し、連携先サーバとの間でユーザ認証処理を行います。
詳細は「3.サーバ間連携」を参照して下さい。
① リクエスト
JavaScriptサンプル(一部抜粋)
let intentHost = "https://sbx.stream-works.biz/sbxapp";
$(function () {
$(‘. regist').click(function () {
var intent = intentHost + '/activateExUser/' +
'?site=' +’ newsite1’+
'&user=' +’1234’ +
'&pass=' + ‘4567’ +
'&uniqueId=' + ‘abcdefg-123456’+
'&allowWeb=0' +
'&returnUrl='+encodeURIComponent(‘https://test.com?id=1234&pw=4567’);
window. location = intent;
});
}
2.3.3. ビデオテスト (videoSetting)
自身の映像・音声をサーバに送り、その映像・音声がNexmileサーバを介して受信・表示されます。
このループバック処理を行うことで通信経路・応答時間・パケットロスト率等の確認を行うことができます。
エンドユーザに提供することで、現在のネットワーク状況をユーザが確認することができます。
これによりネットワーク状態に不安があるユーザが、ライブ配信前等に事前確認することができます。
またもう一つの機能として、壁紙・モザイク・フェースフィルターの効果をユーザが事前に確認・調整することができます。
設定された効果は自動的に通話・ライブ配信時に適用されます。
Nexmileクライアントはビデオ効果を実行するためにそれぞれの効果ファイルを必要とします。
効果ファイルはユーザ認証時に自動的にダウンロードされますが、ダウンロードのキャンセルや効果ファイルの更新により
ユーザの保有する効果ファイルが古くなっている場合でも、このアプリリンクを使用して効果ファイルの更新を
行うことができます。
効果ファイルが古い場合でも通話・ライブ配信/視聴を実行した際に自動的に差分が更新されますが、
連携先で大量に更新された場合、インタラクティブアクションに遅延がでる可能性があります。
イベントや季節によりギフト等を大量に差し換える場合はビデオテストのダウンロード機能を利用下さい。
※効果ファイルはサイトコード毎に保有されます。
① リクエスト
➁ 実行時イメージ