通过

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

VideoGalleryProps interface

  • 参考
包:
@azure/communication-react

VideoGallery 的道具。

属性

dominantSpeakers

按其占位顺序排列的主导说话人 userId 列表。 第 0 个索引是最占主导地位的。
layout

视频磁贴的布局。
localParticipant

本地视频部分
localVideoCameraCycleButtonProps

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

本地视频视图选项
maxRemoteVideoStreams

呈现的参与者远程视频流的最大数量。
onCreateLocalStreamView

用于创建本地视频流视图的回调
onCreateRemoteStreamView

用于创建远程视频流视图的回调
onDisposeLocalStreamView

用于释放本地视频流视图的回调
onDisposeRemoteStreamView

用于释放远程视频流视图的回调
onRenderAvatar

用于呈现部分头像的回调
onRenderLocalVideoTile

用于呈现本地视频磁贴的回调
onRenderRemoteVideoTile

用于呈现远程视频磁贴的回调
remoteParticipants

远程视频部件列表
remoteVideoViewOptions

远程视频查看选项
showCameraSwitcherInLocalPreview

是否显示本地摄像机切换器按钮
showMuteIndicator

是否在用户的显示名称旁边显示静音图标。
strings

组件中要重写的可选字符串
styles

允许用户传递包含库容器的自定义 CSS 样式的对象。

属性详细信息

dominantSpeakers

按其占位顺序排列的主导说话人 userId 列表。 第 0 个索引是最占主导地位的。

dominantSpeakers?: string[]

属性值

string[]

layout

视频磁贴的布局。

layout?: VideoGalleryLayout

属性值

VideoGalleryLayout

localParticipant

本地视频部分

localParticipant: VideoGalleryParticipant

属性值

VideoGalleryParticipant

localVideoCameraCycleButtonProps

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

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

属性值

LocalVideoCameraCycleButtonProps

localVideoViewOptions

本地视频视图选项

localVideoViewOptions?: VideoStreamOptions

属性值

VideoStreamOptions

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>

onDisposeLocalStreamView

用于释放本地视频流视图的回调

onDisposeLocalStreamView?: () => void

属性值

() => void

onDisposeRemoteStreamView

用于释放远程视频流视图的回调

onDisposeRemoteStreamView?: (userId: string) => Promise<void>

属性值

(userId: string) => Promise<void>

onRenderAvatar

用于呈现部分头像的回调

onRenderAvatar?: OnRenderAvatarCallback

属性值

OnRenderAvatarCallback

onRenderLocalVideoTile

用于呈现本地视频磁贴的回调

onRenderLocalVideoTile?: (localParticipant: VideoGalleryParticipant) => Element

属性值

(localParticipant: VideoGalleryParticipant) => Element

onRenderRemoteVideoTile

用于呈现远程视频磁贴的回调

onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element

属性值

(remoteParticipant: VideoGalleryRemoteParticipant) => Element

remoteParticipants

远程视频部件列表

remoteParticipants?: VideoGalleryRemoteParticipant[]

属性值

VideoGalleryRemoteParticipant[]

remoteVideoViewOptions

远程视频查看选项

remoteVideoViewOptions?: VideoStreamOptions

属性值

VideoStreamOptions

showCameraSwitcherInLocalPreview

是否显示本地摄像机切换器按钮

showCameraSwitcherInLocalPreview?: boolean

属性值

boolean

showMuteIndicator

是否在用户的显示名称旁边显示静音图标。

showMuteIndicator?: boolean

属性值

boolean

strings

组件中要重写的可选字符串

strings?: Partial<VideoGalleryStrings>

属性值

Partial<VideoGalleryStrings>

styles

允许用户传递包含库容器的自定义 CSS 样式的对象。

styles?: VideoGalleryStyles

属性值

VideoGalleryStyles