VideoGalleryProps interface
VideoGallery用の小道具。
プロパティ
| dominant |
優勢な話者の userId の一覧 (その支配順)。 0 番目のインデックスが最も優先されます。 |
| is |
together モードがアクティブかどうかを示します |
| layout | ビデオ タイルのレイアウト。 |
| local |
ローカル ビデオパーツ |
| local |
ギャラリー内のローカル画面共有ストリームの表示を制御します |
| local |
カメラを切り替えるボタンのカメラ コントロール情報。 |
| local |
ビデオ ギャラリー内のローカル ビデオ タイルの縦横比を決定します。 |
| local |
ローカル ビデオ ビューのオプション |
| max |
スポットライトを当てることができる最大参加者数 |
| max |
レンダリングされる参加者リモート ビデオ ストリームの最大数。 |
| on |
ローカル ビデオ ストリーム ビューを作成するためのコールバック |
| on |
リモート ビデオ ストリーム ビューを作成するためのコールバック |
| on |
一緒にモードのストリームビューを作成するためのコールバック |
| on |
ローカル画面共有ストリーム ビューを破棄するコールバック |
| on |
ローカル ビデオ ストリーム ビューを破棄するコールバック |
| on |
リモート画面共有ストリームビューを破棄するコールバック |
| on |
|
| on |
リモート ビデオ ストリーム ビューを破棄するためのコールバック |
| on |
一緒にモードのストリームビューを破棄するコールバック |
| on |
このコールバックは、リモート参加者のオーディオを禁止するためのものです |
| on |
このコールバックは、リモート参加者のビデオを禁止するためのものです |
| on |
このコールバックは、リモート参加者をミュートするためのものです |
| on |
このコールバックは、リモート参加者のオーディオを許可するためのものです |
| on |
このコールバックは、リモート参加者にビデオを許可するためのものです |
| on |
このコールバックは、参加者のビデオ タイルがピン留めされたときに呼び出されます。 |
| on |
参加者のアバターをレンダリングするコールバック |
| on |
ローカル ビデオ タイルをレンダリングするためのコールバック |
| on |
リモート ビデオ タイルをレンダリングするためのコールバック |
| on |
このコールバックは、Together モードのシーン サイズを設定するためのものです |
| on |
このコールバックは、ローカル参加者のビデオ タイルのスポットライトを開始するためのものです。 |
| on |
このコールバックは、ローカル参加者のビデオ タイルのスポットライトを停止するためのものです。 |
| on |
このコールバックは、一緒にモードを開始するためのものです |
| on |
このコールバックは、リモート参加者のビデオ タイルのスポットライトを開始するためのものです。 |
| on |
このコールバックは、リモート参加者のビデオ タイルのスポットライトを停止するためのものです。 |
| on |
このコールバックは、参加者のビデオ タイルがピン留め解除されたときに呼び出されます。 |
| overflow |
VideoGallery 内の overflowGallery のレイアウトを決定します。 |
| pinned |
ピン留めされた参加者の userId の一覧。 |
| reaction |
リアクションリソースは、心、笑い、拍手、驚き。 |
| remote |
リモート ビデオのパーツの一覧 |
| remote |
リモートビデオタイルメニューを表示するためのオプション。 |
| remote |
リモート ビデオの表示オプション |
| show |
ローカル ビデオ カメラ スイッチャー ボタンを表示するかどうか |
| show |
ユーザーの表示名の横にミュート アイコンを表示するかどうかを指定します。 |
| spotlighted |
スポットライトされた参加者の userId の一覧。 |
| start |
ローカル参加者が一緒にモードを開始できるかどうかを示します |
| strings | コンポーネントでオーバーライドする省略可能な文字列 |
| styles | ユーザーがギャラリー コンテナーのカスタム CSS スタイルを含むオブジェクトを渡すことができます。 |
| together |
一緒にモードの参加者の着席位置 |
| together |
トゥギャザーモードのビデオストリーム |
| video |
ビデオ タイルの追加オプション |
プロパティの詳細
dominantSpeakers
優勢な話者の userId の一覧 (その支配順)。 0 番目のインデックスが最も優先されます。
dominantSpeakers?: string[]
プロパティ値
string[]
isTogetherModeActive
together モードがアクティブかどうかを示します
isTogetherModeActive?: boolean
プロパティ値
boolean
layout
localParticipant
localScreenShareView
ギャラリー内のローカル画面共有ストリームの表示を制御します
localScreenShareView?: LocalScreenShareView
プロパティ値
localVideoCameraCycleButtonProps
カメラを切り替えるボタンのカメラ コントロール情報。
localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps
プロパティ値
localVideoTileSize
ビデオ ギャラリー内のローカル ビデオ タイルの縦横比を決定します。
localVideoTileSize?: LocalVideoTileSize
プロパティ値
注釈
'followDeviceOrientation' は画面の向きに反応し、アスペクト比が 9:16 (縦) と 16:9 (横) の間で変化します。
localVideoViewOptions
maxParticipantsToSpotlight
スポットライトを当てることができる最大参加者数
maxParticipantsToSpotlight?: number
プロパティ値
number
maxRemoteVideoStreams
レンダリングされる参加者リモート ビデオ ストリームの最大数。
maxRemoteVideoStreams?: number
プロパティ値
number
onCreateLocalStreamView
ローカル ビデオ ストリーム ビューを作成するためのコールバック
onCreateLocalStreamView?: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
プロパティ値
(options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
onCreateRemoteStreamView
リモート ビデオ ストリーム ビューを作成するためのコールバック
onCreateRemoteStreamView?: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
プロパティ値
(userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
onCreateTogetherModeStreamView
一緒にモードのストリームビューを作成するためのコールバック
onCreateTogetherModeStreamView?: (options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>
プロパティ値
(options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>
onDisposeLocalScreenShareStreamView
ローカル画面共有ストリーム ビューを破棄するコールバック
onDisposeLocalScreenShareStreamView?: () => Promise<void>
プロパティ値
() => Promise<void>
onDisposeLocalStreamView
ローカル ビデオ ストリーム ビューを破棄するコールバック
onDisposeLocalStreamView?: () => void
プロパティ値
() => void
onDisposeRemoteScreenShareStreamView
リモート画面共有ストリームビューを破棄するコールバック
onDisposeRemoteScreenShareStreamView?: (userId: string) => Promise<void>
プロパティ値
(userId: string) => Promise<void>
onDisposeRemoteStreamView
警告
この API は非推奨になりました。
use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead
Callback to dispose a remote video stream view
onDisposeRemoteStreamView?: (userId: string) => Promise<void>
プロパティ値
(userId: string) => Promise<void>
onDisposeRemoteVideoStreamView
リモート ビデオ ストリーム ビューを破棄するためのコールバック
onDisposeRemoteVideoStreamView?: (userId: string) => Promise<void>
プロパティ値
(userId: string) => Promise<void>
onDisposeTogetherModeStreamView
一緒にモードのストリームビューを破棄するコールバック
onDisposeTogetherModeStreamView?: () => Promise<void>
プロパティ値
() => Promise<void>
onForbidAudio
このコールバックは、リモート参加者のオーディオを禁止するためのものです
onForbidAudio?: (userIds: string[]) => Promise<void>
プロパティ値
(userIds: string[]) => Promise<void>
onForbidVideo
このコールバックは、リモート参加者のビデオを禁止するためのものです
onForbidVideo?: (userIds: string[]) => Promise<void>
プロパティ値
(userIds: string[]) => Promise<void>
onMuteParticipant
このコールバックは、リモート参加者をミュートするためのものです
onMuteParticipant?: (userId: string) => Promise<void>
プロパティ値
(userId: string) => Promise<void>
onPermitAudio
このコールバックは、リモート参加者のオーディオを許可するためのものです
onPermitAudio?: (userIds: string[]) => Promise<void>
プロパティ値
(userIds: string[]) => Promise<void>
onPermitVideo
このコールバックは、リモート参加者にビデオを許可するためのものです
onPermitVideo?: (userIds: string[]) => Promise<void>
プロパティ値
(userIds: string[]) => Promise<void>
onPinParticipant
このコールバックは、参加者のビデオ タイルがピン留めされたときに呼び出されます。
onPinParticipant?: (userId: string) => void
プロパティ値
(userId: string) => void
onRenderAvatar
onRenderLocalVideoTile
ローカル ビデオ タイルをレンダリングするためのコールバック
onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => Element
プロパティ値
(localParticipant: VideoGalleryLocalParticipant) => Element
onRenderRemoteVideoTile
リモート ビデオ タイルをレンダリングするためのコールバック
onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element
プロパティ値
(remoteParticipant: VideoGalleryRemoteParticipant) => Element
onSetTogetherModeSceneSize
このコールバックは、Together モードのシーン サイズを設定するためのものです
onSetTogetherModeSceneSize?: (width: number, height: number) => void
プロパティ値
(width: number, height: number) => void
onStartLocalSpotlight
このコールバックは、ローカル参加者のビデオ タイルのスポットライトを開始するためのものです。
onStartLocalSpotlight?: () => Promise<void>
プロパティ値
() => Promise<void>
onStartRemoteSpotlight
このコールバックは、ローカル参加者のビデオ タイルのスポットライトを停止するためのものです。
onStartRemoteSpotlight?: (userIds: string[]) => Promise<void>
プロパティ値
(userIds: string[]) => Promise<void>
onStartTogetherMode
このコールバックは、一緒にモードを開始するためのものです
onStartTogetherMode?: () => Promise<void>
プロパティ値
() => Promise<void>
onStopLocalSpotlight
このコールバックは、リモート参加者のビデオ タイルのスポットライトを開始するためのものです。
onStopLocalSpotlight?: () => Promise<void>
プロパティ値
() => Promise<void>
onStopRemoteSpotlight
このコールバックは、リモート参加者のビデオ タイルのスポットライトを停止するためのものです。
onStopRemoteSpotlight?: (userIds: string[]) => Promise<void>
プロパティ値
(userIds: string[]) => Promise<void>
onUnpinParticipant
このコールバックは、参加者のビデオ タイルがピン留め解除されたときに呼び出されます。
onUnpinParticipant?: (userId: string) => void
プロパティ値
(userId: string) => void
overflowGalleryPosition
VideoGallery 内の overflowGallery のレイアウトを決定します。
overflowGalleryPosition?: OverflowGalleryPosition
プロパティ値
pinnedParticipants
ピン留めされた参加者の userId の一覧。
pinnedParticipants?: string[]
プロパティ値
string[]
reactionResources
remoteParticipants
リモート ビデオのパーツの一覧
remoteParticipants?: VideoGalleryRemoteParticipant[]
プロパティ値
remoteVideoTileMenu
リモートビデオタイルメニューを表示するためのオプション。
remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps
プロパティ値
remoteVideoViewOptions
showCameraSwitcherInLocalPreview
ローカル ビデオ カメラ スイッチャー ボタンを表示するかどうか
showCameraSwitcherInLocalPreview?: boolean
プロパティ値
boolean
showMuteIndicator
ユーザーの表示名の横にミュート アイコンを表示するかどうかを指定します。
showMuteIndicator?: boolean
プロパティ値
boolean
spotlightedParticipants
スポットライトされた参加者の userId の一覧。
spotlightedParticipants?: string[]
プロパティ値
string[]
startTogetherModeEnabled
ローカル参加者が一緒にモードを開始できるかどうかを示します
startTogetherModeEnabled?: boolean
プロパティ値
boolean
strings
コンポーネントでオーバーライドする省略可能な文字列
strings?: Partial<VideoGalleryStrings>
プロパティ値
Partial<VideoGalleryStrings>
styles
ユーザーがギャラリー コンテナーのカスタム CSS スタイルを含むオブジェクトを渡すことができます。
styles?: VideoGalleryStyles
プロパティ値
togetherModeSeatingCoordinates
一緒にモードの参加者の着席位置
togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition
プロパティ値
togetherModeStreams
トゥギャザーモードのビデオストリーム
togetherModeStreams?: VideoGalleryTogetherModeStreams