ハードウェア・セットアップ・コンポーネント

ハードウェア・セットアップ・コンポーネントは、[OpenTok js. OpenTok.js]を使用しています。 1 ライブラリを使用してカメラとマイクを選択します。クライアントはクライアントはカメラとマイクを使ってOpenTok.jsのセッションにストリームを公開することができます。セッションにストリームを公開します。

以下のスクリプトタグを使用して、ハードウェアセットアップコンポーネントのビルド済みバージョンをウェブページに追加できます：

<script src="https://static.opentok.com/hardware-setup/v1/js/opentok-hardware-setup.min.js"></script>

からコンポーネントをビルド（および修正）することもできます。 GitHubのソースコード.

コンポーネントの使用

このコンポーネントは、[OpenTok.js]と一緒に使用してください。 1 SDK。

重要な制限 ハードウェア・セットアップ・コンポーネントは、HTTPS経由でロードされたサイトでのみ利用可能です。でのみ利用可能です。

createOpentokHardwareSetupComponent()

ハードウェア・セットアップ・コンポーネントを初期化するには createOpentokHardwareSetupComponent() メソッドを使用する。このメソッドはパラメータを取ります：

targetElement -- ハードウェア・セットアップ・コンポーネントを挿入するDOM要素。コンポーネントを挿入する DOM 要素。(次のパラメータoptionsのinsertModeプロパティを参照)。
options -- コンポーネントをどのようにHTML DOMに挿入するかを指定するオプションの引数。を指定するオプションの引数です。このパラメータにはこのパラメータには、以下の値のいずれかを設定します：
- "replace" -- コンポーネントはtargetElementの内容を置き換える。これはの内容を置き換える。
- "after" -- コンポーネントは、HTML DOMのtargetElementの後に挿入される新しい要素である。の後に挿入される新しい要素です。(コンポーネントもtargetElementも同じ親要素を持つ)。
- "before" -- コンポーネントは、HTML DOMのtargetElement の前に挿入される新しい要素です。(コンポーネントもtargetElementも同じ親要素を持つ)。
- "append" -- コンポーネントは targetElementの子要素として追加されます。他の子要素がある場合、コンポーネントはtargetElementの最後の子要素として追加されます。の最後の子要素として追加されます。
completionHandler -- コンポーネントがページ上にレンダリングされたときや、メソッドの呼び出しに失敗したときに呼び出される関数。が呼び出される関数。エラー時にはを持つオブジェクトが渡されます。 message プロパティがあります。プロパティには以下の値のいずれかを指定します：
- "コンポーネントを配置するための要素が提供されていない"
- 「このブラウザはgetMediaDevices APIをサポートしていません。
- 「利用可能なオーディオ機器やビデオ機器はありません」。
コンポーネントがページ上に正常にレンダリングされると、完了ハンドラハンドラが呼び出されます。

このメソッドは、以下のメソッドを持つHardwareSetupオブジェクトを返す： audioSource(), videoSource()そして destroy().

例

// Replace this with the ID of the target DOM element for the component
var element = document.querySelector('#hardware-setup');

var options = {
  insertMode: 'append' // Or use another insertMode setting.
};

var component = createOpentokHardwareSetupComponent(element, options, function(error) {
  if (error) {
    console.error('Error: ', error);
    element.innerHTML = '<strong>Error getting devices</strong>: '
      error.message;
    return;
  }
  // Add a button to call component.destroy() to close the component.
});

HardwareSetup.audioSource()

選択されたオーディオソースを表すオブジェクトを返します。このオブジェクトは deviceId プロパティは、一意のオーディオ・デバイスID（文字列）です。この文字列はこの文字列をクッキーに保存して、将来のセッションで使用することができます。オーディオ・ソース・オブジェクトまたはそのオーディオ・ソース・オブジェクトまたはその deviceId プロパティを audioSource プロパティに渡される。 OT.initPublisher() メソッドを使用する。

例

// component is the object returned by createOpentokHardwareSetupComponent()
var publisherOptions = {
  audioSource: component.audioSource(),
  videoSource: component.videoSource()
};
OT.initPublisher(targetElement, publisherOptions);

HardwareSetup.videoSource()

選択されたビデオソースを表すオブジェクトを返します。このオブジェクトは deviceId プロパティは、固有のビデオ・デバイスID（文字列）です。この文字列はこの文字列をクッキーに保存して、将来のセッションで使用できます。この文字列はオブジェクトまたはその deviceId プロパティを videoSource プロパティに渡される。 OT.initPublisher() メソッドを使用する。

例

// component is the object returned by createOpentokHardwareSetupComponent()
var publisherOptions = {
  audioSource: component.audioSource(),
  videoSource: component.videoSource()
};
OT.initPublisher(targetElement, publisherOptions);

HardwareSetup.destroy()

ハードウェア・セットアップ・コンポーネント（表示されている場合）を閉じ、HTMLOMから削除する。から削除します。

例

// component is the object returned by createOpentokHardwareSetupComponent()
component.destroy();