VideoTileProps interface

パッケージ:

@azure/communication-react

VideoTileの Props。

プロパティ

children	React 子コンポーネント。 子コンポーネントは、VideoTile にオーバーレイ コンポーネントとして表示されます。
displayName	ラベルに表示する参加者の表示名。
initialsName	イニシャルの生成に使用される参加者の名前。 たとえば、名前 John Doe はイニシャルとして JD 表示されます。
isMirrored	ビデオがミラー化されているかどうかを判断します。
isMuted	ビデオがミュートされているかどうか。
isSpeaking	videoTile の参加者が話しているかどうか。 読み上げインジケーター (境界線) を表示します。
noVideoAvailableAriaLabel	使用可能なストリームがない場合にビデオ タイルの aria ラベルを設定する省略可能なプロパティ。
onRenderPlaceholder	ビデオなしのカスタム レンダリング コンポーネント関数を使用できます。 定義されていない場合は、ペルソナ アイコンをレンダリングします。
personaMaxSize	個人アバターの最大サイズ (ピクセル単位)。 ペルソナ アバターは、ビデオ ストリームが利用できない場合に表示される既定のプレースホルダーです。 詳細については、https://developer.microsoft.com/en-us/fluentui#/controls/web/persona を参照してください。
personaMinSize	ペルソナアバターの最小サイズ (ピクセル単位)。 ペルソナ アバターは、ビデオ ストリームが利用できない場合に表示される既定のプレースホルダーです。 詳細については、https://developer.microsoft.com/en-us/fluentui#/controls/web/persona を参照してください。
renderElement	ビデオ ストリームを含むコンポーネント。
showLabel	VideoTile にラベルを表示する
showMuteIndicator	ユーザーの表示名の横にミュート アイコンを表示するかどうかを指定します。
styles	ユーザーがカスタム CSS スタイルを含むオブジェクトを渡すことができます。
userId	VideoTile プレースホルダーのユーザー ID。

プロパティの詳細

children

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

children?: ReactNode

プロパティ値

ReactNode

displayName

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

displayName?: string

プロパティ値

string

注釈

displayName は、initialsName が指定されていない場合にアバターイニシャルを生成するために使用されます。

initialsName

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

initialsName?: string

プロパティ値

string

注釈

このプロパティが指定されていない場合は、displayName が使用されます。

isMirrored

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

isMirrored?: boolean

プロパティ値

boolean

isMuted

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

isMuted?: boolean

プロパティ値

boolean

isSpeaking

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

isSpeaking?: boolean

プロパティ値

boolean

noVideoAvailableAriaLabel

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

noVideoAvailableAriaLabel?: string

プロパティ値

string

onRenderPlaceholder

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

onRenderPlaceholder?: OnRenderAvatarCallback

プロパティ値

OnRenderAvatarCallback

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

renderElement

ビデオ ストリームを含むコンポーネント。

renderElement?: null | Element

プロパティ値

null | Element

showLabel

VideoTile にラベルを表示する

showLabel?: boolean

プロパティ値

boolean

showMuteIndicator

ユーザーの表示名の横にミュート アイコンを表示するかどうかを指定します。

showMuteIndicator?: boolean

プロパティ値

boolean

styles

ユーザーがカスタム CSS スタイルを含むオブジェクトを渡すことができます。

styles?: VideoTileStylesProps

プロパティ値

VideoTileStylesProps

userId

VideoTile プレースホルダーのユーザー ID。

userId?: string

プロパティ値

string