画面共有

画面共有の実装方法について説明します。

SkyWayStreamFactory.createDisplayStreams関数を利用します。

• APIリファレンス https://javascript-sdk.api-reference.skyway.ntt.com/room/classes/StreamFactory.html#createDisplayStreams

import {SkyWayStreamFactory} from '@skyway-sdk/room';

const { video } = await SkyWayStreamFactory.createDisplayStreams();

また、引数のオプションで、音声の取得や、どの映像を取得するかの設定が可能になります。

const { audio, video } = await SkyWayStreamFactory.createDisplayStreams(
    {
      audio: true, // 音声も取得する
      video: {
        displaySurface: 'monitor', // 画面全体の映像
      }
    }
);

options 引数はそれぞれ次の値を渡すことができます。

• video
  • displaySurface : 共有開始前のポップアップにてデフォルトで選ばれている共有方式
    • "monitor" : 画面全体
    • "window" : 特定のウィンドウ
    • "browser" : 利用しているブラウザのタブ
• audio
  • boolean(true/false)
    • true : displaySurface: "browser" の場合にそのタブが発している音声を返り値: audio で取得できます。
      • 画面共有時のポップアップにて、「タブの音声も共有する」のトグルが利用可能になるのでユーザ側で操作が必要です。
      • この機能は一部の PC 版ブラウザのみ利用可能です。最新の対応状態については以下のリンクを確認してください。
        • mdn web docs:ブラウザの互換性 - Audio capture support
    • false : タブが発生する音声の共有機能を利用しません。
      • 画面共有時のポップアップにてトグルが出なくなります。