VideoTileProps interface

Пакет:

@azure/communication-react

Реквизиты для VideoTile.

Свойства

alwaysShowLabelBackground	Отображение фона метки на VideoTile
children	Компоненты React Child. Дочерние компоненты будут отображаться как компонент наложения в VideoTile.
contextualMenu	Отображение пользовательских пунктов меню в контекстном меню VideoTile. Использует Fluent UI ContextualMenu. Для открытия контекстного меню будет отображаться значок многоточия, если этот параметр определен.
displayName	Отображаемое имя участника, отображаемое в метке.
initialsName	Имя участника, используемого для создания инициалов. Например, имя John Doe будет отображаться JD как инициалы.
isMirrored	Определяет, является ли видео зеркальным или нет.
isMuted	Если видео отключено или нет.
isPinned	Если значение равно true, на плитке видео будет отображаться значок булавки.
isSpeaking	Говорит ли участник видеоTile. Отображает индикатор речи (граница).
isSpotlighted	Если значение true, на плитке видео будет отображаться выделенный значок.
mediaAccess	Состояние доступа участника к медиа.
noVideoAvailableAriaLabel	Необязательное свойство, чтобы задать метку aria плитки видео, если нет доступного потока.
onLongTouch	Обратный вызов запускается видеоплиткой при касании и удержании.
onRenderPlaceholder	Пользовательская функция компонента отрисовки для видео недоступна. Отрисовка значка persona, если не определено.
overlay	Компонент Overlay, отвечающий за рендеринг реакции
participantState	Состояние соединения вызова участника. Например, означает, Hold что участник находится на удержании.
personaMaxSize	Максимальный размер личного аватара в px. Аватар persona — это заполнитель по умолчанию, отображаемый, если видеопоток недоступен. Дополнительные сведения см. в https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
personaMinSize	Минимальный размер аватара человека в px. Аватар persona — это заполнитель по умолчанию, отображаемый, если видеопоток недоступен. Дополнительные сведения см. в https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
raisedHand	Поднята ли у участника рука. Показать индикатор (рамку) и иконку с ордером
reactionResources	URL и метаданные ресурсов реакций.
renderElement	Компонент с видеопотоком.
showLabel	Отображение метки в VideoTile
showMuteIndicator	Отображается ли значок отключения звука рядом с отображаемого имени пользователя.
strings	Строки для переопределения в компоненте.
styles	Позволяет пользователям передавать в объект настраиваемые стили CSS.
userId	идентификатор пользователя для заполнителя VideoTile.

Сведения о свойстве

alwaysShowLabelBackground

Отображение фона метки на VideoTile

alwaysShowLabelBackground?: boolean

Значение свойства

boolean

children

Компоненты React Child. Дочерние компоненты будут отображаться как компонент наложения в 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

Говорит ли участник видеоTile. Отображает индикатор речи (граница).

isSpeaking?: boolean

Значение свойства

boolean

isSpotlighted

Если значение true, на плитке видео будет отображаться выделенный значок.

isSpotlighted?: boolean

Значение свойства

boolean

mediaAccess

Состояние доступа участника к медиа.

mediaAccess?: MediaAccess

Значение свойства

MediaAccess

noVideoAvailableAriaLabel

Необязательное свойство, чтобы задать метку aria плитки видео, если нет доступного потока.

noVideoAvailableAriaLabel?: string

Значение свойства

string

onLongTouch

Обратный вызов запускается видеоплиткой при касании и удержании.

onLongTouch?: () => void

Значение свойства

() => void

onRenderPlaceholder

Пользовательская функция компонента отрисовки для видео недоступна. Отрисовка значка persona, если не определено.

onRenderPlaceholder?: OnRenderAvatarCallback

Значение свойства

OnRenderAvatarCallback

overlay

Компонент Overlay, отвечающий за рендеринг реакции

overlay?: null | Element

Значение свойства

null | Element

participantState

Состояние соединения вызова участника. Например, означает, Hold что участник находится на удержании.

participantState?: ParticipantState

Значение свойства

ParticipantState

personaMaxSize

Максимальный размер личного аватара в px. Аватар persona — это заполнитель по умолчанию, отображаемый, если видеопоток недоступен. Дополнительные сведения см. в https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMaxSize?: number

Значение свойства

number

personaMinSize

Минимальный размер аватара человека в px. Аватар persona — это заполнитель по умолчанию, отображаемый, если видеопоток недоступен. Дополнительные сведения см. в 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.

userId?: string

Значение свойства

string