VideoTileProps interface

Pakiet:

@azure/communication-react

Podziękowania dla VideoTile.

Właściwości

alwaysShowLabelBackground	Pokazywanie tła etykiety na kafelku VideoTile
children	Składniki oprogramowania React Child. Składniki podrzędne będą wyświetlane jako składnik nakładki w pliku VideoTile.
contextualMenu	Wyświetlanie niestandardowych elementów menu w menu kontekstowym urządzenia VideoTile. Używa płynnego menu kontekstowego interfejsu użytkownika. Ikona wielokropka zostanie wyświetlona, aby otworzyć menu kontekstowe, jeśli ten rekwizyt jest zdefiniowany.
displayName	Nazwa wyświetlana uczestnika, który ma być wyświetlany w etykiecie.
initialsName	Nazwa uczestnika użytego do wygenerowania inicjałów. Na przykład nazwa John Doe będzie wyświetlana JD jako inicjały.
isMirrored	Określa, czy wideo jest dublowane, czy nie.
isMuted	Niezależnie od tego, czy wideo jest wyciszone, czy nie.
isPinned	Jeśli wartość to prawda, na kafelku wideo będzie widoczna ikona pinezki.
isSpeaking	Czy uczestnik wideoTile mówi. Pokazuje wskaźnik mówiący (obramowanie).
isSpotlighted	Jeśli to prawda, na kafelku wideo będzie wyświetlana wyróżniona ikona.
mediaAccess	Stan dostępu uczestnika do nośnika.
noVideoAvailableAriaLabel	Opcjonalna właściwość ustawiania etykiety aria kafelka wideo, jeśli nie ma dostępnego strumienia.
onLongTouch	Oddzwanianie wyzwalane przez kafelek wideo po dotknięciu i wstrzymaniu.
onRenderPlaceholder	Niestandardowa funkcja składnika renderowania dla żadnego wideo nie jest dostępna. Renderuj ikonę osoby, jeśli jest ona niezdefiniowana.
overlay	Komponent nakładki odpowiedzialny za reakcję renderingu
participantState	Stan połączenia uczestnika. Na przykład oznacza, Hold że uczestnik jest zawieszony.
personaMaxSize	Maksymalny rozmiar osobistego awatara w pikselach. Awatar osoby jest domyślnym symbolem zastępczym wyświetlanym, gdy strumień wideo nie jest dostępny. Aby uzyskać więcej informacji, zobacz https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
personaMinSize	Minimalny rozmiar awatara osoby w pikseli. Awatar osoby jest domyślnym symbolem zastępczym wyświetlanym, gdy strumień wideo nie jest dostępny. Aby uzyskać więcej informacji, zobacz https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
raisedHand	Czy uczestnik jest podniesiony do góry. Pokaż wskaźnik (obramowanie) i ikonę z zamówieniem
reactionResources	Adres URL i metadane zasobów reakcji.
renderElement	Składnik ze strumieniem wideo.
showLabel	Pokaż etykietę na videoTile
showMuteIndicator	Określa, czy obok nazwy wyświetlanej użytkownika ma być wyświetlana ikona wyciszenia.
strings	Ciągi znaków do zastąpienia w komponencie.
styles	Umożliwia użytkownikom przekazywanie obiektu zawiera niestandardowe style CSS.
userId	identyfikator użytkownika dla symbolu zastępczego VideoTile.

Szczegóły właściwości

alwaysShowLabelBackground

Pokazywanie tła etykiety na kafelku VideoTile

alwaysShowLabelBackground?: boolean

Wartość właściwości

boolean

children

Składniki oprogramowania React Child. Składniki podrzędne będą wyświetlane jako składnik nakładki w pliku VideoTile.

children?: ReactNode

Wartość właściwości

ReactNode

contextualMenu

Wyświetlanie niestandardowych elementów menu w menu kontekstowym urządzenia VideoTile. Używa płynnego menu kontekstowego interfejsu użytkownika. Ikona wielokropka zostanie wyświetlona, aby otworzyć menu kontekstowe, jeśli ten rekwizyt jest zdefiniowany.

contextualMenu?: IContextualMenuProps

Wartość właściwości

IContextualMenuProps

displayName

Nazwa wyświetlana uczestnika, który ma być wyświetlany w etykiecie.

displayName?: string

Wartość właściwości

string

Uwagi

displayName służy do generowania inicjałów awatara, jeśli nie podano initialsName.

initialsName

Nazwa uczestnika użytego do wygenerowania inicjałów. Na przykład nazwa John Doe będzie wyświetlana JD jako inicjały.

initialsName?: string

Wartość właściwości

string

Uwagi

displayName jest używana, jeśli ta właściwość nie jest określona.

isMirrored

Określa, czy wideo jest dublowane, czy nie.

isMirrored?: boolean

Wartość właściwości

boolean

isMuted

Niezależnie od tego, czy wideo jest wyciszone, czy nie.

isMuted?: boolean

Wartość właściwości

boolean

isPinned

Jeśli wartość to prawda, na kafelku wideo będzie widoczna ikona pinezki.

isPinned?: boolean

Wartość właściwości

boolean

isSpeaking

Czy uczestnik wideoTile mówi. Pokazuje wskaźnik mówiący (obramowanie).

isSpeaking?: boolean

Wartość właściwości

boolean

isSpotlighted

Jeśli to prawda, na kafelku wideo będzie wyświetlana wyróżniona ikona.

isSpotlighted?: boolean

Wartość właściwości

boolean

mediaAccess

Stan dostępu uczestnika do nośnika.

mediaAccess?: MediaAccess

Wartość właściwości

MediaAccess

noVideoAvailableAriaLabel

Opcjonalna właściwość ustawiania etykiety aria kafelka wideo, jeśli nie ma dostępnego strumienia.

noVideoAvailableAriaLabel?: string

Wartość właściwości

string

onLongTouch

Oddzwanianie wyzwalane przez kafelek wideo po dotknięciu i wstrzymaniu.

onLongTouch?: () => void

Wartość właściwości

() => void

onRenderPlaceholder

Niestandardowa funkcja składnika renderowania dla żadnego wideo nie jest dostępna. Renderuj ikonę osoby, jeśli jest ona niezdefiniowana.

onRenderPlaceholder?: OnRenderAvatarCallback

Wartość właściwości

OnRenderAvatarCallback

overlay

Komponent nakładki odpowiedzialny za reakcję renderingu

overlay?: null | Element

Wartość właściwości

null | Element

participantState

Stan połączenia uczestnika. Na przykład oznacza, Hold że uczestnik jest zawieszony.

participantState?: ParticipantState

Wartość właściwości

ParticipantState

personaMaxSize

Maksymalny rozmiar osobistego awatara w pikselach. Awatar osoby jest domyślnym symbolem zastępczym wyświetlanym, gdy strumień wideo nie jest dostępny. Aby uzyskać więcej informacji, zobacz https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMaxSize?: number

Wartość właściwości

number

personaMinSize

Minimalny rozmiar awatara osoby w pikseli. Awatar osoby jest domyślnym symbolem zastępczym wyświetlanym, gdy strumień wideo nie jest dostępny. Aby uzyskać więcej informacji, zobacz https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMinSize?: number

Wartość właściwości

number

raisedHand

Czy uczestnik jest podniesiony do góry. Pokaż wskaźnik (obramowanie) i ikonę z zamówieniem

raisedHand?: RaisedHand

Wartość właściwości

RaisedHand

reactionResources

Adres URL i metadane zasobów reakcji.

reactionResources?: ReactionResources

Wartość właściwości

ReactionResources

renderElement

Składnik ze strumieniem wideo.

renderElement?: null | Element

Wartość właściwości

null | Element

showLabel

Pokaż etykietę na videoTile

showLabel?: boolean

Wartość właściwości

boolean

showMuteIndicator

Określa, czy obok nazwy wyświetlanej użytkownika ma być wyświetlana ikona wyciszenia.

showMuteIndicator?: boolean

Wartość właściwości

boolean

strings

Ciągi znaków do zastąpienia w komponencie.

strings?: VideoTileStrings

Wartość właściwości

VideoTileStrings

styles

Umożliwia użytkownikom przekazywanie obiektu zawiera niestandardowe style CSS.

styles?: VideoTileStylesProps

Wartość właściwości

VideoTileStylesProps

userId

identyfikator użytkownika dla symbolu zastępczego VideoTile.

userId?: string

Wartość właściwości

string