VideoGalleryProps interface
VideoGallery的道具。
屬性
屬性詳細資料
dominantSpeakers
主要說話者 userId 的清單，其支配順序。 第 0 個索引是最佔主導地位的。
dominantSpeakers?: string[]屬性值
string[]
isTogetherModeActive
指示在一起模式是否處於活動狀態
isTogetherModeActive?: boolean屬性值
boolean
layout
localParticipant
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
此回調用於啟動遠端參與者視頻圖塊的Spotlight。
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
remoteVideoTileMenu
用於顯示遠端視頻拼貼功能表的選項。
remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps屬性值
remoteVideoViewOptions
showCameraSwitcherInLocalPreview
是否要顯示本機攝像機切換器按鈕
showCameraSwitcherInLocalPreview?: boolean屬性值
boolean
showMuteIndicator
是否要在使用者的顯示名稱旁邊顯示靜音圖示。
showMuteIndicator?: boolean屬性值
boolean
spotlightedParticipants
聚焦參與者 userId 的清單。
spotlightedParticipants?: string[]屬性值
string[]
startTogetherModeEnabled
指示本地參與者是否可以一起啟動模式
startTogetherModeEnabled?: boolean屬性值
boolean
strings
styles
togetherModeSeatingCoordinates
參與者在一起模式下的座位位置
togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition