VideoTileProps interface

Pacote:

@azure/communication-react

Props para VideoTile.

Propriedades

alwaysShowLabelBackground	Mostrar fundo da etiqueta no VideoTile
children	Componentes React Child. Componentes filho serão mostrados como componente de sobreposição no VideoTile.
contextualMenu	Exiba itens de menu personalizados no menu contextual do VideoTile. Usa Fluent UI ContextualMenu. Um ícone de reticências será exibido para abrir o menu contextual se este suporte estiver definido.
displayName	Nome de exibição do Participante a ser mostrado no rótulo.
initialsName	Nome do participante usado para gerar iniciais. Por exemplo, um nome John Doe exibirá JD como iniciais.
isMirrored	Determina se o vídeo é espelhado ou não.
isMuted	Se o vídeo está mudo ou não.
isPinned	Se verdadeiro, o bloco de vídeo mostrará o ícone de pino.
isSpeaking	Se o participante no videoTile está falando. Mostra um indicador de fala (borda).
isSpotlighted	Se verdadeiro, o bloco de vídeo mostrará o ícone em destaque.
mediaAccess	Estado de acesso aos meios de comunicação social do participante.
noVideoAvailableAriaLabel	Propriedade opcional para definir o rótulo de ária do bloco de vídeo se não houver nenhum fluxo disponível.
onLongTouch	Retorno de chamada acionado pelo bloco de vídeo ao tocar e segurar.
onRenderPlaceholder	Renderização personalizada Função de componente para nenhum vídeo está disponível. Renderize um ícone de persona se indefinido.
overlay	Componente de sobreposição responsável pela renderização da reação
participantState	O estado da conexão de chamada do participante. Por exemplo, Hold significa que o participante está em espera.
personaMaxSize	Tamanho máximo do avatar pessoal em px. O avatar persona é o espaço reservado padrão mostrado quando nenhum fluxo de vídeo está disponível. Para obter mais informações, consulte https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
personaMinSize	Tamanho mínimo do avatar da persona em px. O avatar persona é o espaço reservado padrão mostrado quando nenhum fluxo de vídeo está disponível. Para obter mais informações, consulte https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
raisedHand	Se o participante está com a mão levantada. Mostrar um indicador (borda) e ícone com ordem
reactionResources	URL e metadados dos recursos de reações.
renderElement	Componente com o fluxo de vídeo.
showLabel	Mostrar rótulo no VideoTile
showMuteIndicator	Se deseja exibir um ícone de mudo ao lado do nome de exibição do usuário.
strings	Strings para substituir no componente.
styles	Permite que os usuários passem um objeto que contém estilos CSS personalizados.
userId	ID de usuário para o espaço reservado VideoTile.

Detalhes de Propriedade

alwaysShowLabelBackground

Mostrar fundo da etiqueta no VideoTile

alwaysShowLabelBackground?: boolean

Valor de Propriedade

boolean

children

Componentes React Child. Componentes filho serão mostrados como componente de sobreposição no VideoTile.

children?: ReactNode

Valor de Propriedade

ReactNode

contextualMenu

Exiba itens de menu personalizados no menu contextual do VideoTile. Usa Fluent UI ContextualMenu. Um ícone de reticências será exibido para abrir o menu contextual se este suporte estiver definido.

contextualMenu?: IContextualMenuProps

Valor de Propriedade

IContextualMenuProps

displayName

Nome de exibição do Participante a ser mostrado no rótulo.

displayName?: string

Valor de Propriedade

string

Observações

displayName é usado para gerar iniciais de avatar se initialsName não for fornecido.

initialsName

Nome do participante usado para gerar iniciais. Por exemplo, um nome John Doe exibirá JD como iniciais.

initialsName?: string

Valor de Propriedade

string

Observações

displayName é usado se essa propriedade não for especificada.

isMirrored

Determina se o vídeo é espelhado ou não.

isMirrored?: boolean

Valor de Propriedade

boolean

isMuted

Se o vídeo está mudo ou não.

isMuted?: boolean

Valor de Propriedade

boolean

isPinned

Se verdadeiro, o bloco de vídeo mostrará o ícone de pino.

isPinned?: boolean

Valor de Propriedade

boolean

isSpeaking

Se o participante no videoTile está falando. Mostra um indicador de fala (borda).

isSpeaking?: boolean

Valor de Propriedade

boolean

isSpotlighted

Se verdadeiro, o bloco de vídeo mostrará o ícone em destaque.

isSpotlighted?: boolean

Valor de Propriedade

boolean

mediaAccess

Estado de acesso aos meios de comunicação social do participante.

mediaAccess?: MediaAccess

Valor de Propriedade

MediaAccess

noVideoAvailableAriaLabel

Propriedade opcional para definir o rótulo de ária do bloco de vídeo se não houver nenhum fluxo disponível.

noVideoAvailableAriaLabel?: string

Valor de Propriedade

string

onLongTouch

Retorno de chamada acionado pelo bloco de vídeo ao tocar e segurar.

onLongTouch?: () => void

Valor de Propriedade

() => void

onRenderPlaceholder

Renderização personalizada Função de componente para nenhum vídeo está disponível. Renderize um ícone de persona se indefinido.

onRenderPlaceholder?: OnRenderAvatarCallback

Valor de Propriedade

OnRenderAvatarCallback

overlay

Componente de sobreposição responsável pela renderização da reação

overlay?: null | Element

Valor de Propriedade

null | Element

participantState

O estado da conexão de chamada do participante. Por exemplo, Hold significa que o participante está em espera.

participantState?: ParticipantState

Valor de Propriedade

ParticipantState

personaMaxSize

Tamanho máximo do avatar pessoal em px. O avatar persona é o espaço reservado padrão mostrado quando nenhum fluxo de vídeo está disponível. Para obter mais informações, consulte https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMaxSize?: number

Valor de Propriedade

number

personaMinSize

Tamanho mínimo do avatar da persona em px. O avatar persona é o espaço reservado padrão mostrado quando nenhum fluxo de vídeo está disponível. Para obter mais informações, consulte https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMinSize?: number

Valor de Propriedade

number

raisedHand

Se o participante está com a mão levantada. Mostrar um indicador (borda) e ícone com ordem

raisedHand?: RaisedHand

Valor de Propriedade

RaisedHand

reactionResources

URL e metadados dos recursos de reações.

reactionResources?: ReactionResources

Valor de Propriedade

ReactionResources

renderElement

Componente com o fluxo de vídeo.

renderElement?: null | Element

Valor de Propriedade

null | Element

showLabel

Mostrar rótulo no VideoTile

showLabel?: boolean

Valor de Propriedade

boolean

showMuteIndicator

Se deseja exibir um ícone de mudo ao lado do nome de exibição do usuário.

showMuteIndicator?: boolean

Valor de Propriedade

boolean

strings

Strings para substituir no componente.

strings?: VideoTileStrings

Valor de Propriedade

VideoTileStrings

styles

Permite que os usuários passem um objeto que contém estilos CSS personalizados.

styles?: VideoTileStylesProps

Valor de Propriedade

VideoTileStylesProps

userId

ID de usuário para o espaço reservado VideoTile.

userId?: string

Valor de Propriedade

string