RTKSelf モジュールは現在のユーザーを表し、ミーティング内のユーザー状態を変更できます。ユーザーの音声ストリームとビデオストリームは、このモジュールから取得できます。
- RTKSelf
- .peerId
- .roomState
- .permissions
- .config
- .roomJoined
- .isPinned
- .cleanupEvents()
- .setName(name)
- .setupTracks(options)
- .enableAudio()
- .enableVideo()
- .updateVideoConstraints()
- .enableScreenShare()
- .updateScreenshareConstraints()
- .disableAudio()
- .disableVideo()
- .disableScreenShare()
- .getAllDevices()
- .pin()
- .unpin()
- .hide()
- .show()
- .setDevice(device)
NOTE(ishita1805): Ravindra と相談し、Locker で識別子を使うときの一貫性のため、重複を追加しています。
将来 id を非推奨にする可能性があります。
種類: RTKSelf のインスタンスプロパティ
ルームの現在の状態を返します init - 初期状態 joined - ユーザーがミーティング内にいます waitlisted - ユーザーが待機リストの状態です rejected - ユーザーは待合室にいましたが、入場が拒否されました kicked - 権限のあるユーザーが、このユーザーをミーティングから退出させました left - ユーザーがミーティングを退出しました ended - ミーティングが終了しました
種類: RTKSelf のインスタンスプロパティ
ミーティングに対してユーザーへ付与されている現在の権限を返します。
種類: RTKSelf のインスタンスプロパティ
ミーティングの設定を返します。
種類: RTKSelf のインスタンスプロパティ
ローカル参加者がミーティングに参加済みの場合は true を返します。
種類: RTKSelf のインスタンスプロパティ
現在のユーザーがピン留めされている場合は true を返します。
種類: RTKSelf のインスタンスプロパティ
種類: RTKSelf のインスタンスメソッド
このメソッドを呼び出して、ユーザーの名前を設定できます。 ルームに参加する前に呼び出した場合にのみ、他の参加者へ反映されます。
種類: RTKSelf のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| name | string |
ユーザーの名前。 |
ローカルのメディアトラックをセットアップします。
種類: RTKSelf のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| options | Object |
音声とビデオのオプション。 |
| [options.video] | boolean |
true の場合、ビデオストリームを取得します。 |
| [options.audio] | boolean |
true の場合、音声ストリームを取得します。 |
| [options.forceReset] | boolean |
true の場合、再取得の前にトラックを強制リセットします。 |
ローカル参加者の音声をミュート解除します。
種類: RTKSelf のインスタンスメソッド
ローカル参加者のビデオをミーティングへ配信し始めます。
種類: RTKSelf のインスタンスメソッド
現在のビデオストリームに制約を適用します。
種類: RTKSelf のインスタンスメソッド
ローカル参加者の画面共有をミーティングへ配信し始めます。
種類: RTKSelf のインスタンスメソッド
現在の画面共有ストリームに制約を適用します。
種類: RTKSelf のインスタンスメソッド
ローカル参加者の音声をミュートします。
種類: RTKSelf のインスタンスメソッド
ローカル参加者のビデオを無効にします。
種類: RTKSelf のインスタンスメソッド
ローカル参加者の画面共有を停止します。
種類: RTKSelf のインスタンスメソッド
ローカル参加者がアクセスできるすべてのメディアデバイスを返します。
種類: RTKSelf のインスタンスメソッド
参加者をピン留めする権限がある場合、self.id を返します。
種類: RTKSelf のインスタンスメソッド
参加者のピン留めを解除する権限がある場合、self.id を返します。
種類: RTKSelf のインスタンスメソッド
UI 上のユーザータイルを非表示にします(ローカルのみ)
種類: RTKSelf のインスタンスメソッド
非表示になっているユーザータイルを UI に再表示します(ローカルのみ)
種類: RTKSelf のインスタンスメソッド
ローカル参加者が使っている現在のメディアデバイスを切り替えます。
種類: RTKSelf のインスタンスメソッド
| パラメーター | 型 | 説明 |
|---|---|---|
| device | MediaDeviceInfo |
使うデバイス。同じ kind のデバイスが置き換えられます。プライマリストリームです。 |