VideoGalleryProps interface

Pakiet:

@azure/communication-react

Podziękowania dla VideoGallery.

Właściwości

dominantSpeakers	Lista dominujących identyfikatorów użytkownika osoby mówiącej w kolejności ich dominacji. 0. indeks jest najbardziej dominujący.
isTogetherModeActive	Wskazuje, czy tryb razem jest aktywny
layout	Układ kafelków wideo.
localParticipant	Lokalny składnik wideo
localScreenShareView	Steruje widokiem lokalnego strumienia udostępniania ekranu w galerii
localVideoCameraCycleButtonProps	Informacje o kontrolce aparatu do przełączania aparatów fotograficznych.
localVideoTileSize	Określa współczynnik proporcji lokalnego kafelka wideo w galerii wideo.
localVideoViewOptions	Opcje lokalnego widoku wideo
maxParticipantsToSpotlight	Maksymalna liczba uczestników, którzy mogą zostać wyróżnieni
maxRemoteVideoStreams	Maksymalna liczba wyrenderowanych zdalnych strumieni wideo uczestnika.
onCreateLocalStreamView	Wywołanie zwrotne w celu utworzenia lokalnego widoku strumienia wideo
onCreateRemoteStreamView	Wywołanie zwrotne w celu utworzenia zdalnego widoku strumienia wideo
onCreateTogetherModeStreamView	Wywołanie zwrotne w celu utworzenia widoku strumienia w trybie razem
onDisposeLocalScreenShareStreamView	Wywołanie zwrotne w celu usunięcia lokalnego widoku strumienia udostępnionego ekranu
onDisposeLocalStreamView	Wywołanie zwrotne w celu usunięcia lokalnego widoku strumienia wideo
onDisposeRemoteScreenShareStreamView	Wywołanie zwrotne w celu usunięcia widoku strumienia zdalnego udostępniania ekranu
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView	Wywołanie zwrotne w celu usunięcia zdalnego widoku strumienia wideo
onDisposeTogetherModeStreamView	Wywołanie zwrotne w celu usunięcia widoku strumienia w trybie razem
onForbidAudio	To wywołanie zwrotne ma na celu zabronienie odtwarzania dźwięku dla uczestników zdalnych
onForbidVideo	To wywołanie zwrotne ma na celu zabranie wideo dla zdalnych uczestników
onMuteParticipant	To wywołanie zwrotne ma na celu wyciszenie uczestnika zdalnego
onPermitAudio	To wywołanie zwrotne ma na celu zezwolenie na dźwięk dla uczestników zdalnych
onPermitVideo	To wywołanie zwrotne ma na celu zezwolenie na wideo dla uczestników zdalnych
onPinParticipant	To wywołanie zwrotne zostanie wywołane po przypięciu kafelka wideo uczestnika.
onRenderAvatar	Oddzwanianie w celu renderowania awatara uczestnika
onRenderLocalVideoTile	Wywołanie zwrotne w celu renderowania lokalnego kafelka wideo
onRenderRemoteVideoTile	Wywołanie zwrotne w celu renderowania zdalnego kafelka wideo
onSetTogetherModeSceneSize	To wywołanie zwrotne ma na celu ustawienie rozmiaru sceny dla trybu razem
onStartLocalSpotlight	To wywołanie zwrotne ma na celu uruchomienie funkcji w centrum uwagi dla lokalnego kafelka wideo uczestnika.
onStartRemoteSpotlight	To wywołanie zwrotne ma na celu zatrzymanie światła reflektorów dla lokalnego kafelka wideo uczestnika.
onStartTogetherMode	To wywołanie zwrotne ma na celu uruchomienie trybu razem
onStopLocalSpotlight	To wywołanie zwrotne ma na celu uruchomienie funkcji w centrum uwagi dla kafelków wideo uczestników zdalnych.
onStopRemoteSpotlight	To wywołanie zwrotne ma na celu zatrzymanie reflektora dla kafelków wideo uczestników zdalnych.
onUnpinParticipant	To wywołanie zwrotne zostanie wywołane, gdy kafelek wideo uczestnika zostanie odpięty.
overflowGalleryPosition	Określa układ obiektu overflowGallery wewnątrz obiektu VideoGallery.
pinnedParticipants	Lista przypiętych identyfikatorów użytkownika uczestnika.
reactionResources	Zasoby reakcji na polubienia, serce, śmiech, oklaski i zaskoczenie.
remoteParticipants	Lista zdalnych particpants wideo
remoteVideoTileMenu	Opcje wyświetlania menu kafelka zdalnego wideo.
remoteVideoViewOptions	Opcje wyświetlania zdalnych filmów wideo
showCameraSwitcherInLocalPreview	Czy wyświetlić przycisk przełącznika lokalnego aparatu wideo
showMuteIndicator	Określa, czy obok nazwy wyświetlanej użytkownika ma być wyświetlana ikona wyciszenia.
spotlightedParticipants	Lista wyróżnionych identyfikatorów użytkowników uczestników.
startTogetherModeEnabled	Wskazuje, czy uczestnik lokalny może uruchomić tryb współpracy
strings	Opcjonalne ciągi do zastąpienia w składniku
styles	Umożliwia użytkownikom przekazywanie obiektu zawierającego niestandardowe style CSS dla kontenera galerii.
togetherModeSeatingCoordinates	Pozycja siedząca uczestników w trybie "razem"
togetherModeStreams	Strumienie wideo w trybie Together
videoTilesOptions	Dodatkowe opcje kafelków wideo

Szczegóły właściwości

dominantSpeakers

Lista dominujących identyfikatorów użytkownika osoby mówiącej w kolejności ich dominacji. 0. indeks jest najbardziej dominujący.

dominantSpeakers?: string[]

Wartość właściwości

string[]

isTogetherModeActive

Wskazuje, czy tryb razem jest aktywny

isTogetherModeActive?: boolean

Wartość właściwości

boolean

layout

Układ kafelków wideo.

layout?: VideoGalleryLayout

Wartość właściwości

VideoGalleryLayout

localParticipant

Lokalny składnik wideo

localParticipant: VideoGalleryLocalParticipant

Wartość właściwości

VideoGalleryLocalParticipant

localScreenShareView

Steruje widokiem lokalnego strumienia udostępniania ekranu w galerii

localScreenShareView?: LocalScreenShareView

Wartość właściwości

LocalScreenShareView

localVideoCameraCycleButtonProps

Informacje o kontrolce aparatu do przełączania aparatów fotograficznych.

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

Wartość właściwości

LocalVideoCameraCycleButtonProps

localVideoTileSize

Określa współczynnik proporcji lokalnego kafelka wideo w galerii wideo.

localVideoTileSize?: LocalVideoTileSize

Wartość właściwości

LocalVideoTileSize

Uwagi

"followDeviceOrientation" będzie reagować na orientację ekranu i zmieni proporcje między 9:16 (pionowo) i 16:9 (poziomo).

localVideoViewOptions

Opcje lokalnego widoku wideo

localVideoViewOptions?: VideoStreamOptions

Wartość właściwości

VideoStreamOptions

maxParticipantsToSpotlight

Maksymalna liczba uczestników, którzy mogą zostać wyróżnieni

maxParticipantsToSpotlight?: number

Wartość właściwości

number

maxRemoteVideoStreams

Maksymalna liczba wyrenderowanych zdalnych strumieni wideo uczestnika.

maxRemoteVideoStreams?: number

Wartość właściwości

number

onCreateLocalStreamView

Wywołanie zwrotne w celu utworzenia lokalnego widoku strumienia wideo

onCreateLocalStreamView?: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

Wartość właściwości

(options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

onCreateRemoteStreamView

Wywołanie zwrotne w celu utworzenia zdalnego widoku strumienia wideo

onCreateRemoteStreamView?: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

Wartość właściwości

(userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

onCreateTogetherModeStreamView

Wywołanie zwrotne w celu utworzenia widoku strumienia w trybie razem

onCreateTogetherModeStreamView?: (options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>

Wartość właściwości

(options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>

onDisposeLocalScreenShareStreamView

Wywołanie zwrotne w celu usunięcia lokalnego widoku strumienia udostępnionego ekranu

onDisposeLocalScreenShareStreamView?: () => Promise<void>

Wartość właściwości

() => Promise<void>

onDisposeLocalStreamView

Wywołanie zwrotne w celu usunięcia lokalnego widoku strumienia wideo

onDisposeLocalStreamView?: () => void

Wartość właściwości

() => void

onDisposeRemoteScreenShareStreamView

Wywołanie zwrotne w celu usunięcia widoku strumienia zdalnego udostępniania ekranu

onDisposeRemoteScreenShareStreamView?: (userId: string) => Promise<void>

Wartość właściwości

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Ostrzeżenie

Ten interfejs API jest już przestarzały.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead

Callback to dispose a remote video stream view

onDisposeRemoteStreamView?: (userId: string) => Promise<void>

Wartość właściwości

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

Wywołanie zwrotne w celu usunięcia zdalnego widoku strumienia wideo

onDisposeRemoteVideoStreamView?: (userId: string) => Promise<void>

Wartość właściwości

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Wywołanie zwrotne w celu usunięcia widoku strumienia w trybie razem

onDisposeTogetherModeStreamView?: () => Promise<void>

Wartość właściwości

() => Promise<void>

onForbidAudio

To wywołanie zwrotne ma na celu zabronienie odtwarzania dźwięku dla uczestników zdalnych

onForbidAudio?: (userIds: string[]) => Promise<void>

Wartość właściwości

(userIds: string[]) => Promise<void>

onForbidVideo

To wywołanie zwrotne ma na celu zabranie wideo dla zdalnych uczestników

onForbidVideo?: (userIds: string[]) => Promise<void>

Wartość właściwości

(userIds: string[]) => Promise<void>

onMuteParticipant

To wywołanie zwrotne ma na celu wyciszenie uczestnika zdalnego

onMuteParticipant?: (userId: string) => Promise<void>

Wartość właściwości

(userId: string) => Promise<void>

onPermitAudio

To wywołanie zwrotne ma na celu zezwolenie na dźwięk dla uczestników zdalnych

onPermitAudio?: (userIds: string[]) => Promise<void>

Wartość właściwości

(userIds: string[]) => Promise<void>

onPermitVideo

To wywołanie zwrotne ma na celu zezwolenie na wideo dla uczestników zdalnych

onPermitVideo?: (userIds: string[]) => Promise<void>

Wartość właściwości

(userIds: string[]) => Promise<void>

onPinParticipant

To wywołanie zwrotne zostanie wywołane po przypięciu kafelka wideo uczestnika.

onPinParticipant?: (userId: string) => void

Wartość właściwości

(userId: string) => void

onRenderAvatar

Oddzwanianie w celu renderowania awatara uczestnika

onRenderAvatar?: OnRenderAvatarCallback

Wartość właściwości

OnRenderAvatarCallback

onRenderLocalVideoTile

Wywołanie zwrotne w celu renderowania lokalnego kafelka wideo

onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => Element

Wartość właściwości

(localParticipant: VideoGalleryLocalParticipant) => Element

onRenderRemoteVideoTile

Wywołanie zwrotne w celu renderowania zdalnego kafelka wideo

onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element

Wartość właściwości

(remoteParticipant: VideoGalleryRemoteParticipant) => Element

onSetTogetherModeSceneSize

To wywołanie zwrotne ma na celu ustawienie rozmiaru sceny dla trybu razem

onSetTogetherModeSceneSize?: (width: number, height: number) => void

Wartość właściwości

(width: number, height: number) => void

onStartLocalSpotlight

To wywołanie zwrotne ma na celu uruchomienie funkcji w centrum uwagi dla lokalnego kafelka wideo uczestnika.

onStartLocalSpotlight?: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStartRemoteSpotlight

To wywołanie zwrotne ma na celu zatrzymanie światła reflektorów dla lokalnego kafelka wideo uczestnika.

onStartRemoteSpotlight?: (userIds: string[]) => Promise<void>

Wartość właściwości

(userIds: string[]) => Promise<void>

onStartTogetherMode

To wywołanie zwrotne ma na celu uruchomienie trybu razem

onStartTogetherMode?: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStopLocalSpotlight

To wywołanie zwrotne ma na celu uruchomienie funkcji w centrum uwagi dla kafelków wideo uczestników zdalnych.

onStopLocalSpotlight?: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStopRemoteSpotlight

To wywołanie zwrotne ma na celu zatrzymanie reflektora dla kafelków wideo uczestników zdalnych.

onStopRemoteSpotlight?: (userIds: string[]) => Promise<void>

Wartość właściwości

(userIds: string[]) => Promise<void>

onUnpinParticipant

To wywołanie zwrotne zostanie wywołane, gdy kafelek wideo uczestnika zostanie odpięty.

onUnpinParticipant?: (userId: string) => void

Wartość właściwości

(userId: string) => void

overflowGalleryPosition

Określa układ obiektu overflowGallery wewnątrz obiektu VideoGallery.

overflowGalleryPosition?: OverflowGalleryPosition

Wartość właściwości

OverflowGalleryPosition

pinnedParticipants

Lista przypiętych identyfikatorów użytkownika uczestnika.

pinnedParticipants?: string[]

Wartość właściwości

string[]

reactionResources

Zasoby reakcji na polubienia, serce, śmiech, oklaski i zaskoczenie.

reactionResources?: ReactionResources

Wartość właściwości

ReactionResources

remoteParticipants

Lista zdalnych particpants wideo

remoteParticipants?: VideoGalleryRemoteParticipant[]

Wartość właściwości

VideoGalleryRemoteParticipant[]

remoteVideoTileMenu

Opcje wyświetlania menu kafelka zdalnego wideo.

remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

Wartość właściwości

false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

remoteVideoViewOptions

Opcje wyświetlania zdalnych filmów wideo

remoteVideoViewOptions?: VideoStreamOptions

Wartość właściwości

VideoStreamOptions

showCameraSwitcherInLocalPreview

Czy wyświetlić przycisk przełącznika lokalnego aparatu wideo

showCameraSwitcherInLocalPreview?: 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

spotlightedParticipants

Lista wyróżnionych identyfikatorów użytkowników uczestników.

spotlightedParticipants?: string[]

Wartość właściwości

string[]

startTogetherModeEnabled

Wskazuje, czy uczestnik lokalny może uruchomić tryb współpracy

startTogetherModeEnabled?: boolean

Wartość właściwości

boolean

strings

Opcjonalne ciągi do zastąpienia w składniku

strings?: Partial<VideoGalleryStrings>

Wartość właściwości

Partial<VideoGalleryStrings>

styles

Umożliwia użytkownikom przekazywanie obiektu zawierającego niestandardowe style CSS dla kontenera galerii.

styles?: VideoGalleryStyles

Wartość właściwości

VideoGalleryStyles

togetherModeSeatingCoordinates

Pozycja siedząca uczestników w trybie "razem"

togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition

Wartość właściwości

VideoGalleryTogetherModeParticipantPosition

togetherModeStreams

Strumienie wideo w trybie Together

togetherModeStreams?: VideoGalleryTogetherModeStreams

Wartość właściwości

VideoGalleryTogetherModeStreams

videoTilesOptions

Dodatkowe opcje kafelków wideo

videoTilesOptions?: VideoTilesOptions

Wartość właściwości

VideoTilesOptions