VideoTileProps interface

Paquet:

@azure/communication-react

Accessoires pour VideoTile.

Propriétés

alwaysShowLabelBackground	Afficher l’arrière-plan de l’étiquette sur le VideoTile
children	Composants React Child. Les composants enfants s’affichent en tant que composant de superposition dans VideoTile.
contextualMenu	Affichez les éléments de menu personnalisés dans le menu contextuel du VideoTile. Utilise Fluent UI ContextualMenu. Une icône d’ellipses s’affichera pour ouvrir le menu contextuel si cette prop est définie.
displayName	Nom complet du participant à afficher dans l’étiquette.
initialsName	Nom du participant utilisé pour générer des initiales. Par exemple, un nom John Doe affiche JD en tant qu’initiales.
isMirrored	Détermine si la vidéo est mise en miroir ou non.
isMuted	Indique si la vidéo est désactivée ou non.
isPinned	Si la valeur est true, la vignette vidéo affichera l’icône d’épingle.
isSpeaking	Indique si le participant à la vidéoTile parle. Affiche un indicateur de parole (bordure).
isSpotlighted	Si la valeur est true, la vignette vidéo affichera l’icône en vedette.
mediaAccess	État d’accès aux médias du participant.
noVideoAvailableAriaLabel	Propriété facultative pour définir l’étiquette aria de la vignette vidéo s’il n’existe aucun flux disponible.
onLongTouch	Rappel déclenché par la vignette vidéo lors du toucher prolongé.
onRenderPlaceholder	Fonction de composant de rendu personnalisé pour aucune vidéo n’est disponible. Affichez une icône Persona si elle n’est pas définie.
overlay	Composant de superposition responsable de la réaction de rendu
participantState	L’état de connexion de l’appel du participant. Par exemple, Hold signifie que le participant est en attente.
personaMaxSize	Taille maximale de l’avatar personnel en px. L’avatar persona est l’espace réservé par défaut affiché lorsqu’aucun flux vidéo n’est disponible. Pour plus d’informations, consultez https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
personaMinSize	Taille minimale de l’avatar de persona en px. L’avatar persona est l’espace réservé par défaut affiché lorsqu’aucun flux vidéo n’est disponible. Pour plus d’informations, consultez https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
raisedHand	Si le participant est la main levée. Afficher un indicateur (bordure) et une icône avec l’ordre
reactionResources	Réactions : l’URL et les métadonnées des ressources.
renderElement	Composant avec le flux vidéo.
showLabel	Afficher l’étiquette sur VideoTile
showMuteIndicator	Indique s’il faut afficher une icône muet en regard du nom d’affichage de l’utilisateur.
strings	Chaînes à remplacer dans le composant.
styles	Permet aux utilisateurs de passer un objet contient des styles CSS personnalisés.
userId	ID utilisateur de l’espace réservé VideoTile.

Détails de la propriété

alwaysShowLabelBackground

Afficher l’arrière-plan de l’étiquette sur le VideoTile

alwaysShowLabelBackground?: boolean

Valeur de propriété

boolean

children

Composants React Child. Les composants enfants s’affichent en tant que composant de superposition dans VideoTile.

children?: ReactNode

Valeur de propriété

ReactNode

contextualMenu

Affichez les éléments de menu personnalisés dans le menu contextuel du VideoTile. Utilise Fluent UI ContextualMenu. Une icône d’ellipses s’affichera pour ouvrir le menu contextuel si cette prop est définie.

contextualMenu?: IContextualMenuProps

Valeur de propriété

IContextualMenuProps

displayName

Nom complet du participant à afficher dans l’étiquette.

displayName?: string

Valeur de propriété

string

Remarques

displayName est utilisé pour générer des initiales d’avatar si initialsName n’est pas fourni.

initialsName

Nom du participant utilisé pour générer des initiales. Par exemple, un nom John Doe affiche JD en tant qu’initiales.

initialsName?: string

Valeur de propriété

string

Remarques

displayName est utilisé si cette propriété n’est pas spécifiée.

isMirrored

Détermine si la vidéo est mise en miroir ou non.

isMirrored?: boolean

Valeur de propriété

boolean

isMuted

Indique si la vidéo est désactivée ou non.

isMuted?: boolean

Valeur de propriété

boolean

isPinned

Si la valeur est true, la vignette vidéo affichera l’icône d’épingle.

isPinned?: boolean

Valeur de propriété

boolean

isSpeaking

Indique si le participant à la vidéoTile parle. Affiche un indicateur de parole (bordure).

isSpeaking?: boolean

Valeur de propriété

boolean

isSpotlighted

Si la valeur est true, la vignette vidéo affichera l’icône en vedette.

isSpotlighted?: boolean

Valeur de propriété

boolean

mediaAccess

État d’accès aux médias du participant.

mediaAccess?: MediaAccess

Valeur de propriété

MediaAccess

noVideoAvailableAriaLabel

Propriété facultative pour définir l’étiquette aria de la vignette vidéo s’il n’existe aucun flux disponible.

noVideoAvailableAriaLabel?: string

Valeur de propriété

string

onLongTouch

Rappel déclenché par la vignette vidéo lors du toucher prolongé.

onLongTouch?: () => void

Valeur de propriété

() => void

onRenderPlaceholder

Fonction de composant de rendu personnalisé pour aucune vidéo n’est disponible. Affichez une icône Persona si elle n’est pas définie.

onRenderPlaceholder?: OnRenderAvatarCallback

Valeur de propriété

OnRenderAvatarCallback

overlay

Composant de superposition responsable de la réaction de rendu

overlay?: null | Element

Valeur de propriété

null | Element

participantState

L’état de connexion de l’appel du participant. Par exemple, Hold signifie que le participant est en attente.

participantState?: ParticipantState

Valeur de propriété

ParticipantState

personaMaxSize

Taille maximale de l’avatar personnel en px. L’avatar persona est l’espace réservé par défaut affiché lorsqu’aucun flux vidéo n’est disponible. Pour plus d’informations, consultez https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMaxSize?: number

Valeur de propriété

number

personaMinSize

Taille minimale de l’avatar de persona en px. L’avatar persona est l’espace réservé par défaut affiché lorsqu’aucun flux vidéo n’est disponible. Pour plus d’informations, consultez https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMinSize?: number

Valeur de propriété

number

raisedHand

Si le participant est la main levée. Afficher un indicateur (bordure) et une icône avec l’ordre

raisedHand?: RaisedHand

Valeur de propriété

RaisedHand

reactionResources

Réactions : l’URL et les métadonnées des ressources.

reactionResources?: ReactionResources

Valeur de propriété

ReactionResources

renderElement

Composant avec le flux vidéo.

renderElement?: null | Element

Valeur de propriété

null | Element

showLabel

Afficher l’étiquette sur VideoTile

showLabel?: boolean

Valeur de propriété

boolean

showMuteIndicator

Indique s’il faut afficher une icône muet en regard du nom d’affichage de l’utilisateur.

showMuteIndicator?: boolean

Valeur de propriété

boolean

strings

Chaînes à remplacer dans le composant.

strings?: VideoTileStrings

Valeur de propriété

VideoTileStrings

styles

Permet aux utilisateurs de passer un objet contient des styles CSS personnalisés.

styles?: VideoTileStylesProps

Valeur de propriété

VideoTileStylesProps

userId

ID utilisateur de l’espace réservé VideoTile.

userId?: string

Valeur de propriété

string