VideoTileProps interface

パッケージ:
@azure/communication-react

VideoTileの Props。

プロパティ

alwaysShowLabelBackground

VideoTile にラベルの背景を表示する
children

React 子コンポーネント。 子コンポーネントは、VideoTile にオーバーレイ コンポーネントとして表示されます。
contextualMenu

VideoTileのコンテキストメニューにカスタムメニュー項目を表示します。 Fluent UI の ContextualMenu を使用します。 省略記号アイコンが表示され、このプロパティが定義されている場合、コンテキストメニューが開きます。
displayName

ラベルに表示する参加者の表示名。
initialsName

イニシャルの生成に使用される参加者の名前。 たとえば、名前 John Doe はイニシャルとして JD 表示されます。
isMirrored

ビデオがミラー化されているかどうかを判断します。
isMuted

ビデオがミュートされているかどうか。
isPinned

true の場合、ビデオ タイルにピン アイコンが表示されます。
isSpeaking

videoTile の参加者が話しているかどうか。 読み上げインジケーター (境界線) を表示します。
isSpotlighted

true の場合、ビデオ タイルにスポットライト付きのアイコンが表示されます。
mediaAccess

参加者のメディア アクセス状態。
noVideoAvailableAriaLabel

使用可能なストリームがない場合にビデオ タイルの aria ラベルを設定する省略可能なプロパティ。
onLongTouch

タッチアンドホールドでビデオタイルによってトリガーされるコールバック。
onRenderPlaceholder

ビデオなしのカスタム レンダリング コンポーネント関数を使用できます。 定義されていない場合は、ペルソナ アイコンをレンダリングします。
overlay

レンダリング反応を担当するオーバーレイコンポーネント
participantState

参加者の通話接続状態。 たとえば、 Hold は参加者が保留中であることを意味します。
personaMaxSize

個人アバターの最大サイズ (ピクセル単位)。 ペルソナ アバターは、ビデオ ストリームが利用できない場合に表示される既定のプレースホルダーです。 詳細については、https://developer.microsoft.com/en-us/fluentui#/controls/web/persona を参照してください。
personaMinSize

ペルソナアバターの最小サイズ (ピクセル単位)。 ペルソナ アバターは、ビデオ ストリームが利用できない場合に表示される既定のプレースホルダーです。 詳細については、https://developer.microsoft.com/en-us/fluentui#/controls/web/persona を参照してください。
raisedHand

参加者が手を挙げているかどうか。 インジケーター (境界線) とアイコンを順番で表示する
reactionResources

リアクションリソースの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 を使用します。 省略記号アイコンが表示され、このプロパティが定義されている場合、コンテキストメニューが開きます。

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?: null | Element

プロパティ値

null | Element

participantState

参加者の通話接続状態。 たとえば、 Hold は参加者が保留中であることを意味します。

participantState?: ParticipantState

プロパティ値

ParticipantState

personaMaxSize

個人アバターの最大サイズ (ピクセル単位)。 ペルソナ アバターは、ビデオ ストリームが利用できない場合に表示される既定のプレースホルダーです。 詳細については、https://developer.microsoft.com/en-us/fluentui#/controls/web/persona を参照してください。

personaMaxSize?: number

プロパティ値

number

personaMinSize

ペルソナアバターの最小サイズ (ピクセル単位)。 ペルソナ アバターは、ビデオ ストリームが利用できない場合に表示される既定のプレースホルダーです。 詳細については、https://developer.microsoft.com/en-us/fluentui#/controls/web/persona を参照してください。

personaMinSize?: number

プロパティ値

number

raisedHand

参加者が手を挙げているかどうか。 インジケーター (境界線) とアイコンを順番で表示する

raisedHand?: RaisedHand

プロパティ値

RaisedHand

reactionResources

リアクションリソースの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