VideoTileProps interface

包:

@azure/communication-react

VideoTile的道具。

属性

alwaysShowLabelBackground	在 VideoTile 上显示标签背景
children	React 子组件。 子组件将在 VideoTile 中显示为覆盖组件。
contextualMenu	在 VideoTile 的上下文菜单中显示自定义菜单项。 使用 Fluent UI ContextualMenu。 如果定义了此 prop，则将显示省略号图标以打开上下文菜单。
displayName	要显示在标签中的参与者的显示名称。
initialsName	用于生成缩写的参与者的名称。 例如，名称 John Doe 将以缩写的形式显示 JD。
isMirrored	确定视频是否镜像。
isMuted	视频是否静音。
isPinned	如果为 true，则视频磁贴将显示图钉图标。
isSpeaking	videoTile 中的参与者是否说话。 显示说话指示器（边框）。
isSpotlighted	如果为 true，则视频磁贴将显示聚焦图标。
mediaAccess	参与者的媒体访问状态。
noVideoAvailableAriaLabel	如果没有可用的流，则为设置视频磁贴的 aria 标签的可选属性。
onLongTouch	触摸并按住时由视频磁贴触发的回调。
onRenderPlaceholder	没有视频的自定义呈现组件函数可用。 如果未定义，则呈现角色图标。
overlay	负责渲染反应的 Overlay 组件
participantState	参与者的呼叫连接状态。 例如， Hold 表示参与者处于暂停状态。
personaMaxSize	px 中个人头像的最大大小。 角色虚拟形象是当没有视频流可用时显示的默认占位符。 有关详细信息，请参阅 https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
personaMinSize	px 中角色头像的最小大小。 角色虚拟形象是当没有视频流可用时显示的默认占位符。 有关详细信息，请参阅 https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
raisedHand	参与者是否举手。 显示指标（边框）和图标
reactionResources	Reactions 资源的 URL 和元数据。
renderElement	包含视频流的组件。
showLabel	在 VideoTile 上显示标签
showMuteIndicator	是否在用户的显示名称旁边显示静音图标。
strings	要在组件中覆盖的字符串。
styles	允许用户传入对象包含自定义 CSS 样式。
userId	VideoTile 占位符的用户 ID。

属性详细信息

alwaysShowLabelBackground

在 VideoTile 上显示标签背景

alwaysShowLabelBackground?: boolean

属性值

boolean

children

React 子组件。 子组件将在 VideoTile 中显示为覆盖组件。

children?: ReactNode

属性值

ReactNode

contextualMenu

在 VideoTile 的上下文菜单中显示自定义菜单项。 使用 Fluent UI ContextualMenu。 如果定义了此 prop，则将显示省略号图标以打开上下文菜单。

contextualMenu?: IContextualMenuProps

属性值

IContextualMenuProps

displayName

要显示在标签中的参与者的显示名称。

displayName?: string

属性值

string

注解

如果未提供 displayName，则 initialsName 用于生成头像首字母缩写。

initialsName

用于生成缩写的参与者的名称。 例如，名称 John Doe 将以缩写的形式显示 JD。

initialsName?: string

属性值

string

注解

如果未指定此属性，则使用 displayName。

isMirrored

确定视频是否镜像。

isMirrored?: boolean

属性值

boolean

isMuted

视频是否静音。

isMuted?: boolean

属性值

boolean

isPinned

如果为 true，则视频磁贴将显示图钉图标。

isPinned?: boolean

属性值

boolean

isSpeaking

videoTile 中的参与者是否说话。 显示说话指示器（边框）。

isSpeaking?: boolean

属性值

boolean

isSpotlighted

如果为 true，则视频磁贴将显示聚焦图标。

isSpotlighted?: boolean

属性值

boolean

mediaAccess

参与者的媒体访问状态。

mediaAccess?: MediaAccess

属性值

MediaAccess

noVideoAvailableAriaLabel

如果没有可用的流，则为设置视频磁贴的 aria 标签的可选属性。

noVideoAvailableAriaLabel?: string

属性值

string

onLongTouch

触摸并按住时由视频磁贴触发的回调。

onLongTouch?: () => void

属性值

() => void

onRenderPlaceholder

没有视频的自定义呈现组件函数可用。 如果未定义，则呈现角色图标。

onRenderPlaceholder?: OnRenderAvatarCallback

属性值

OnRenderAvatarCallback

overlay

负责渲染反应的 Overlay 组件

overlay?: null | Element

属性值

null | Element

participantState

参与者的呼叫连接状态。 例如， Hold 表示参与者处于暂停状态。

participantState?: ParticipantState

属性值

ParticipantState

personaMaxSize

px 中个人头像的最大大小。 角色虚拟形象是当没有视频流可用时显示的默认占位符。 有关详细信息，请参阅 https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMaxSize?: number

属性值

number

personaMinSize

px 中角色头像的最小大小。 角色虚拟形象是当没有视频流可用时显示的默认占位符。 有关详细信息，请参阅 https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMinSize?: number

属性值

number

raisedHand

参与者是否举手。 显示指标（边框）和图标

raisedHand?: RaisedHand

属性值

RaisedHand

reactionResources

Reactions 资源的 URL 和元数据。

reactionResources?: ReactionResources

属性值

ReactionResources

renderElement

包含视频流的组件。

renderElement?: null | Element

属性值

null | Element

showLabel

在 VideoTile 上显示标签

showLabel?: boolean

属性值

boolean

showMuteIndicator

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

showMuteIndicator?: boolean

属性值

boolean

strings

要在组件中覆盖的字符串。

strings?: VideoTileStrings

属性值

VideoTileStrings

styles

允许用户传入对象包含自定义 CSS 样式。

styles?: VideoTileStylesProps

属性值

VideoTileStylesProps

userId

VideoTile 占位符的用户 ID。

userId?: string

属性值

string