你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

VideoGalleryProps interface

包:: @azure/communication-react

属性

dominantSpeakers	主要说话人 userId 的列表，其优势顺序。第 0 个索引是最占主导地位的。
isTogetherModeActive	指示同场模式是否处于活动状态
layout	视频磁贴的布局。
localParticipant	本地视频 particpant
localScreenShareView	控制库中本地屏幕共享流的视图
localVideoCameraCycleButtonProps	用于切换相机的按钮的相机控制信息。
localVideoTileSize	确定视频库中本地视频图块的纵横比。
localVideoViewOptions	本地视频视图选项
maxParticipantsToSpotlight	可聚焦的最大参与者数
maxRemoteVideoStreams	呈现的参与者远程视频流的最大数量。
onCreateLocalStreamView	用于创建本地视频流视图的回调
onCreateRemoteStreamView	用于创建远程视频流视图的回调
onCreateTogetherModeStreamView	用于创建 Together 模式流视图的回调
onDisposeLocalScreenShareStreamView	释放本地屏幕共享流视图回调
onDisposeLocalStreamView	用于释放本地视频流视图的回调
onDisposeRemoteScreenShareStreamView	释放远端屏幕共享流视图回调
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView	用于释放远程视频流视图的回调
onDisposeTogetherModeStreamView	用于释放 Together 模式流视图的回调
onForbidAudio	该回调用于禁止远端参与者音频
onForbidVideo	该回调用于禁止远端参与者观看视频
onMuteParticipant	该回调用于将远端参与者静音
onPermitAudio	该回调用于允许远端参与者进行音频
onPermitVideo	该回调用于允许远端参与者进行视频作
onPinParticipant	该回调会在参加者视频模块置顶时调用。
onRenderAvatar	用于渲染参与者头像的回调
onRenderLocalVideoTile	用于呈现本地视频磁贴的回调
onRenderRemoteVideoTile	用于呈现远程视频磁贴的回调
onSetTogetherModeSceneSize	该回调用于设置 Together 模式的场景大小
onStartLocalSpotlight	此回调用于启动本地参加者视频图块的聚焦。
onStartRemoteSpotlight	该回调用于停止对本地参加者视频图块的聚焦。
onStartTogetherMode	此回调是 start together 模式
onStopLocalSpotlight	此回调用于启动远程参加者视频图块的 Spotlight。
onStopRemoteSpotlight	此回调用于停止远程参加者视频图块的聚焦。
onUnpinParticipant	当参加者视频图块解压时，将调用该回调。
overflowGalleryPosition	确定 VideoGallery 内 overflowGallery 的布局。
pinnedParticipants	固定参与者 userId 的列表。
reactionResources	点赞、心声、笑声、掌声和惊喜的反应资源。
remoteParticipants	远程视频部件列表
remoteVideoTileMenu	用于显示远程视频拼贴菜单的选项。
remoteVideoViewOptions	远程视频视图选项
showCameraSwitcherInLocalPreview	是否显示本地摄像机切换器按钮
showMuteIndicator	是否在用户的显示名称旁边显示静音图标。
spotlightedParticipants	聚焦参与者 userId 的列表。
startTogetherModeEnabled	指示本地参与者是否可以启动一起模式
strings	在组件中重写的可选字符串
styles	允许用户传递包含库容器的自定义 CSS 样式的对象。
togetherModeSeatingCoordinates	一起模式下参与者的座位位置
togetherModeStreams	同框场景模式视频流
videoTilesOptions	视频磁贴的其他选项

属性详细信息

dominantSpeakers

主要说话人 userId 的列表，其优势顺序。第 0 个索引是最占主导地位的。

dominantSpeakers?: string[]

属性值

string[]

isTogetherModeActive

指示同场模式是否处于活动状态

isTogetherModeActive?: boolean

属性值

boolean

layout

视频磁贴的布局。

layout?: VideoGalleryLayout

属性值

VideoGalleryLayout

localParticipant

本地视频 particpant

localParticipant: VideoGalleryLocalParticipant

属性值

VideoGalleryLocalParticipant

localScreenShareView

控制库中本地屏幕共享流的视图

localScreenShareView?: LocalScreenShareView

属性值

LocalScreenShareView

localVideoCameraCycleButtonProps

用于切换相机的按钮的相机控制信息。

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

属性值

LocalVideoCameraCycleButtonProps

localVideoTileSize

确定视频库中本地视频图块的纵横比。

localVideoTileSize?: LocalVideoTileSize

属性值

LocalVideoTileSize

注解

'followDeviceOrientation' 将响应屏幕方向，并将在 9：16（纵向）和 16：9（横向）纵横比之间变化。

localVideoViewOptions

本地视频视图选项

localVideoViewOptions?: VideoStreamOptions

属性值

VideoStreamOptions

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

用于创建 Together 模式流视图的回调

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

用于释放 Together 模式流视图的回调

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

用于渲染参与者头像的回调

onRenderAvatar?: OnRenderAvatarCallback

属性值

OnRenderAvatarCallback

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

此回调是 start together 模式

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

属性值

OverflowGalleryPosition

pinnedParticipants

固定参与者 userId 的列表。

pinnedParticipants?: string[]

属性值

string[]

reactionResources

点赞、心声、笑声、掌声和惊喜的反应资源。

reactionResources?: ReactionResources

属性值

ReactionResources

remoteParticipants

远程视频部件列表

remoteParticipants?: VideoGalleryRemoteParticipant[]

属性值

VideoGalleryRemoteParticipant[]

remoteVideoTileMenu

用于显示远程视频拼贴菜单的选项。

remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

属性值

false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

remoteVideoViewOptions

远程视频视图选项

remoteVideoViewOptions?: VideoStreamOptions

属性值

VideoStreamOptions

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

属性值

VideoGalleryStyles

togetherModeSeatingCoordinates

一起模式下参与者的座位位置

togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition

属性值

VideoGalleryTogetherModeParticipantPosition

togetherModeStreams

同框场景模式视频流

togetherModeStreams?: VideoGalleryTogetherModeStreams

属性值

VideoGalleryTogetherModeStreams

videoTilesOptions

视频磁贴的其他选项

videoTilesOptions?: VideoTilesOptions

属性值

VideoTilesOptions