VideoTileProps interface

Pacote:

@azure/communication-react

Adereços para VideoTile .

Propriedades

alwaysShowLabelBackground	Mostrar plano de fundo do rótulo no VideoTile
children	Componentes do 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 esta prop estiver definida.
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 for verdadeiro, o bloco de vídeo mostrará o ícone de alfinete.
isSpeaking	Se o participante do videoTile está falando. Mostra um indicador de fala (borda).
isSpotlighted	Se for verdadeiro, o bloco de vídeo mostrará o ícone destacado.
mediaAccess	Estado de acesso à mídia do participante.
noVideoAvailableAriaLabel	Propriedade opcional para definir o rótulo aria do bloco de vídeo se não houver fluxo disponível.
onLongTouch	Retorno de chamada acionado pelo bloco de vídeo ao tocar e segurar.
onRenderPlaceholder	A função Componente de renderização personalizada para nenhum vídeo está disponível. Renderize um ícone de persona se indefinido.
overlay	Componente de sobreposição responsável pela reação de renderizaçã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 da 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 de persona em px. O avatar da 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á levantando a mão. 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 será necessário exibir um ícone de mudo ao lado do nome de exibição do usuário.
strings	Strings a serem substituídas no componente.
styles	Permite que os usuários passem um objeto que contém estilos CSS personalizados.
userId	ID do usuário para o espaço reservado do VideoTile.

Detalhes da propriedade

alwaysShowLabelBackground

Mostrar plano de fundo do rótulo no VideoTile

alwaysShowLabelBackground?: boolean

Valor da propriedade

boolean

children

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

children?: ReactNode

Valor da 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 esta prop estiver definida.

contextualMenu?: IContextualMenuProps

Valor da propriedade

IContextualMenuProps

displayName

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

displayName?: string

Valor da propriedade

string

Comentários

displayName será 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 da propriedade

string

Comentários

displayName será usado se essa propriedade não for especificada.

isMirrored

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

isMirrored?: boolean

Valor da propriedade

boolean

isMuted

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

isMuted?: boolean

Valor da propriedade

boolean

isPinned

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

isPinned?: boolean

Valor da propriedade

boolean

isSpeaking

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

isSpeaking?: boolean

Valor da propriedade

boolean

isSpotlighted

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

isSpotlighted?: boolean

Valor da propriedade

boolean

mediaAccess

Estado de acesso à mídia do participante.

mediaAccess?: MediaAccess

Valor da propriedade

MediaAccess

noVideoAvailableAriaLabel

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

noVideoAvailableAriaLabel?: string

Valor da propriedade

string

onLongTouch

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

onLongTouch?: () => void

Valor da propriedade

() => void

onRenderPlaceholder

A função Componente de renderização personalizada para nenhum vídeo está disponível. Renderize um ícone de persona se indefinido.

onRenderPlaceholder?: OnRenderAvatarCallback

Valor da propriedade

OnRenderAvatarCallback

overlay

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

overlay?: null | Element

Valor da 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 da propriedade

ParticipantState

personaMaxSize

Tamanho máximo do avatar pessoal em px. O avatar da 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 da propriedade

number

personaMinSize

Tamanho mínimo do avatar de persona em px. O avatar da 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 da propriedade

number

raisedHand

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

raisedHand?: RaisedHand

Valor da propriedade

RaisedHand

reactionResources

URL e metadados dos recursos de reações.

reactionResources?: ReactionResources

Valor da propriedade

ReactionResources

renderElement

Componente com o fluxo de vídeo.

renderElement?: null | Element

Valor da propriedade

null | Element

showLabel

Mostrar rótulo no VideoTile

showLabel?: boolean

Valor da propriedade

boolean

showMuteIndicator

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

showMuteIndicator?: boolean

Valor da propriedade

boolean

strings

Strings a serem substituídas no componente.

strings?: VideoTileStrings

Valor da propriedade

VideoTileStrings

styles

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

styles?: VideoTileStylesProps

Valor da propriedade

VideoTileStylesProps

userId

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

userId?: string

Valor da propriedade

string