VideoTileProps interface

套件:

@azure/communication-react

VideoTile的 Props。

屬性

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 佔位元符的用戶標識碼。

屬性詳細資料

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 佔位元符的用戶標識碼。

userId?: string

屬性值

string