VideoGalleryProps interface

Paket:

@azure/communication-react

Props für VideoGallery.

Eigenschaften

dominantSpeakers	Liste der dominanten Sprecherbenutzer-ID in der Reihenfolge ihrer Dominanz. Der 0. Index ist der dominantste.
isTogetherModeActive	Gibt an, ob der Zusammen-Modus aktiv ist
layout	Layout der Videokacheln.
localParticipant	Lokaler Videoteil
localScreenShareView	Steuert die Ansicht des lokalen Screenshare-Streams im Katalog
localVideoCameraCycleButtonProps	Kamerasteuerungsinformationen für Die Schaltfläche zum Wechseln von Kameras.
localVideoTileSize	Bestimmt das Seitenverhältnis der lokalen Videokachel in der Videogalerie.
localVideoViewOptions	Optionen für die lokale Videoansicht
maxParticipantsToSpotlight	Maximale Teilnehmerzahl, die ins Rampenlicht gerückt werden kann
maxRemoteVideoStreams	Maximale Anzahl von Teilnehmer-Remotevideostreams, die gerendert werden.
onCreateLocalStreamView	Rückruf zum Erstellen der lokalen Videostreamansicht
onCreateRemoteStreamView	Rückruf zum Erstellen einer Remotevideostreamansicht
onCreateTogetherModeStreamView	Callback zum Erstellen einer Stream-Ansicht im gemeinsamen Modus
onDisposeLocalScreenShareStreamView	Rückruf zum Löschen einer Stream-Ansicht für die lokale Bildschirmfreigabe
onDisposeLocalStreamView	Rückruf zum Löschen der lokalen Videostreamansicht
onDisposeRemoteScreenShareStreamView	Rückruf zum Löschen einer Stream-Ansicht für die Remote-Bildschirmfreigabe
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView	Rückruf zum Löschen einer Remotevideostreamansicht
onDisposeTogetherModeStreamView	Callback zum Löschen einer Stream-Ansicht im Modus "Zusammen"
onForbidAudio	Dieser Rückruf dient dazu, Audio für Remote-Teilnehmer zu verbieten
onForbidVideo	Dieser Rückruf dient dazu, Videos für Remote-Teilnehmer zu verbieten
onMuteParticipant	Dieser Rückruf dient dazu, einen Remote-Teilnehmer stummzuschalten
onPermitAudio	Dieser Rückruf dient dazu, Audio für entfernte Teilnehmer zuzulassen
onPermitVideo	Dieser Rückruf dient dazu, Video für Remote-Teilnehmer zuzulassen
onPinParticipant	Dieser Rückruf wird aufgerufen, wenn eine Teilnehmervideokachel angeheftet wird.
onRenderAvatar	Callback zum Rendern eines Teilnehmer-Avatars
onRenderLocalVideoTile	Rückruf zum Rendern der lokalen Videokachel
onRenderRemoteVideoTile	Rückruf zum Rendern einer Remotevideokachel
onSetTogetherModeSceneSize	Mit diesem Callback wird die Szenengröße für den Together-Modus festgelegt
onStartLocalSpotlight	Dieser Rückruf dient zum Starten des Spotlights für die Videokachel des lokalen Teilnehmers.
onStartRemoteSpotlight	Dieser Rückruf dient dazu, das Spotlight für die Videokachel des lokalen Teilnehmers zu beenden.
onStartTogetherMode	Dieser Rückruf dient zum Starten des gemeinsamen Modus
onStopLocalSpotlight	Dieser Rückruf dient zum Starten des Spotlights für Videokacheln von Remoteteilnehmern.
onStopRemoteSpotlight	Dieser Rückruf dient dazu, das Spotlight für Videokacheln von Remoteteilnehmern zu beenden.
onUnpinParticipant	Dieser Rückruf wird aufgerufen, wenn die Bindung einer Teilnehmervideokachel aufgehoben wird.
overflowGalleryPosition	Bestimmt das Layout der overflowGallery innerhalb der VideoGallery.
pinnedParticipants	Liste der angehefteten Benutzer-IDs der Teilnehmer.
reactionResources	Reaktionsressourcen für Like, Herz, Lachen, Applaus und Überraschung.
remoteParticipants	Liste der Remotevideoparticpants
remoteVideoTileMenu	Optionen zum Anzeigen des Menüs der Kachel für Remote-Videos.
remoteVideoViewOptions	Optionen für die Remotevideoansicht
showCameraSwitcherInLocalPreview	Gibt an, ob die Lokale Videokameraschalterschaltfläche angezeigt werden soll.
showMuteIndicator	Gibt an, ob neben dem Anzeigenamen des Benutzers ein Stummschaltsymbol angezeigt werden soll.
spotlightedParticipants	Liste der Benutzer-IDs der im Rampenlicht stehenden Teilnehmer.
startTogetherModeEnabled	Gibt an, ob der lokale Teilnehmer den gemeinsamen Modus starten kann
strings	Optionale Zeichenfolgen, die in komponente außer Kraft gesetzt werden sollen
styles	Ermöglicht Benutzern das Übergeben eines Objekts, das benutzerdefinierte CSS-Formatvorlagen für den Katalogcontainer enthält.
togetherModeSeatingCoordinates	Sitzposition der Teilnehmer im Together-Modus
togetherModeStreams	Videostreams im Together-Modus
videoTilesOptions	Zusätzliche Optionen für Videokacheln

Details zur Eigenschaft

dominantSpeakers

Liste der dominanten Sprecherbenutzer-ID in der Reihenfolge ihrer Dominanz. Der 0. Index ist der dominantste.

dominantSpeakers?: string[]

Eigenschaftswert

string[]

isTogetherModeActive

Gibt an, ob der Zusammen-Modus aktiv ist

isTogetherModeActive?: boolean

Eigenschaftswert

boolean

layout

Layout der Videokacheln.

layout?: VideoGalleryLayout

Eigenschaftswert

VideoGalleryLayout

localParticipant

Lokaler Videoteil

localParticipant: VideoGalleryLocalParticipant

Eigenschaftswert

VideoGalleryLocalParticipant

localScreenShareView

Steuert die Ansicht des lokalen Screenshare-Streams im Katalog

localScreenShareView?: LocalScreenShareView

Eigenschaftswert

LocalScreenShareView

localVideoCameraCycleButtonProps

Kamerasteuerungsinformationen für Die Schaltfläche zum Wechseln von Kameras.

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

Eigenschaftswert

LocalVideoCameraCycleButtonProps

localVideoTileSize

Bestimmt das Seitenverhältnis der lokalen Videokachel in der Videogalerie.

localVideoTileSize?: LocalVideoTileSize

Eigenschaftswert

LocalVideoTileSize

Hinweise

'followDeviceOrientation' reagiert auf die Bildschirmausrichtung und ändert sich zwischen den Seitenverhältnissen 9:16 (Hochformat) und 16:9 (Querformat).

localVideoViewOptions

Optionen für die lokale Videoansicht

localVideoViewOptions?: VideoStreamOptions

Eigenschaftswert

VideoStreamOptions

maxParticipantsToSpotlight

Maximale Teilnehmerzahl, die ins Rampenlicht gerückt werden kann

maxParticipantsToSpotlight?: number

Eigenschaftswert

number

maxRemoteVideoStreams

Maximale Anzahl von Teilnehmer-Remotevideostreams, die gerendert werden.

maxRemoteVideoStreams?: number

Eigenschaftswert

number

onCreateLocalStreamView

Rückruf zum Erstellen der lokalen Videostreamansicht

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

Eigenschaftswert

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

onCreateRemoteStreamView

Rückruf zum Erstellen einer Remotevideostreamansicht

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

Eigenschaftswert

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

onCreateTogetherModeStreamView

Callback zum Erstellen einer Stream-Ansicht im gemeinsamen Modus

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

Eigenschaftswert

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

onDisposeLocalScreenShareStreamView

Rückruf zum Löschen einer Stream-Ansicht für die lokale Bildschirmfreigabe

onDisposeLocalScreenShareStreamView?: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onDisposeLocalStreamView

Rückruf zum Löschen der lokalen Videostreamansicht

onDisposeLocalStreamView?: () => void

Eigenschaftswert

() => void

onDisposeRemoteScreenShareStreamView

Rückruf zum Löschen einer Stream-Ansicht für die Remote-Bildschirmfreigabe

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

Eigenschaftswert

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Warnung

Diese API ist nun veraltet.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead

Callback to dispose a remote video stream view

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

Eigenschaftswert

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

Rückruf zum Löschen einer Remotevideostreamansicht

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

Eigenschaftswert

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Callback zum Löschen einer Stream-Ansicht im Modus "Zusammen"

onDisposeTogetherModeStreamView?: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onForbidAudio

Dieser Rückruf dient dazu, Audio für Remote-Teilnehmer zu verbieten

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

Eigenschaftswert

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

onForbidVideo

Dieser Rückruf dient dazu, Videos für Remote-Teilnehmer zu verbieten

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

Eigenschaftswert

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

onMuteParticipant

Dieser Rückruf dient dazu, einen Remote-Teilnehmer stummzuschalten

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

Eigenschaftswert

(userId: string) => Promise<void>

onPermitAudio

Dieser Rückruf dient dazu, Audio für entfernte Teilnehmer zuzulassen

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

Eigenschaftswert

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

onPermitVideo

Dieser Rückruf dient dazu, Video für Remote-Teilnehmer zuzulassen

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

Eigenschaftswert

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

onPinParticipant

Dieser Rückruf wird aufgerufen, wenn eine Teilnehmervideokachel angeheftet wird.

onPinParticipant?: (userId: string) => void

Eigenschaftswert

(userId: string) => void

onRenderAvatar

Callback zum Rendern eines Teilnehmer-Avatars

onRenderAvatar?: OnRenderAvatarCallback

Eigenschaftswert

OnRenderAvatarCallback

onRenderLocalVideoTile

Rückruf zum Rendern der lokalen Videokachel

onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => Element

Eigenschaftswert

(localParticipant: VideoGalleryLocalParticipant) => Element

onRenderRemoteVideoTile

Rückruf zum Rendern einer Remotevideokachel

onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element

Eigenschaftswert

(remoteParticipant: VideoGalleryRemoteParticipant) => Element

onSetTogetherModeSceneSize

Mit diesem Callback wird die Szenengröße für den Together-Modus festgelegt

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

Eigenschaftswert

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

onStartLocalSpotlight

Dieser Rückruf dient zum Starten des Spotlights für die Videokachel des lokalen Teilnehmers.

onStartLocalSpotlight?: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStartRemoteSpotlight

Dieser Rückruf dient dazu, das Spotlight für die Videokachel des lokalen Teilnehmers zu beenden.

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

Eigenschaftswert

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

onStartTogetherMode

Dieser Rückruf dient zum Starten des gemeinsamen Modus

onStartTogetherMode?: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStopLocalSpotlight

Dieser Rückruf dient zum Starten des Spotlights für Videokacheln von Remoteteilnehmern.

onStopLocalSpotlight?: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStopRemoteSpotlight

Dieser Rückruf dient dazu, das Spotlight für Videokacheln von Remoteteilnehmern zu beenden.

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

Eigenschaftswert

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

onUnpinParticipant

Dieser Rückruf wird aufgerufen, wenn die Bindung einer Teilnehmervideokachel aufgehoben wird.

onUnpinParticipant?: (userId: string) => void

Eigenschaftswert

(userId: string) => void

overflowGalleryPosition

Bestimmt das Layout der overflowGallery innerhalb der VideoGallery.

overflowGalleryPosition?: OverflowGalleryPosition

Eigenschaftswert

OverflowGalleryPosition

pinnedParticipants

Liste der angehefteten Benutzer-IDs der Teilnehmer.

pinnedParticipants?: string[]

Eigenschaftswert

string[]

reactionResources

Reaktionsressourcen für Like, Herz, Lachen, Applaus und Überraschung.

reactionResources?: ReactionResources

Eigenschaftswert

ReactionResources

remoteParticipants

Liste der Remotevideoparticpants

remoteParticipants?: VideoGalleryRemoteParticipant[]

Eigenschaftswert

VideoGalleryRemoteParticipant[]

remoteVideoTileMenu

Optionen zum Anzeigen des Menüs der Kachel für Remote-Videos.

remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

Eigenschaftswert

false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

remoteVideoViewOptions

Optionen für die Remotevideoansicht

remoteVideoViewOptions?: VideoStreamOptions

Eigenschaftswert

VideoStreamOptions

showCameraSwitcherInLocalPreview

Gibt an, ob die Lokale Videokameraschalterschaltfläche angezeigt werden soll.

showCameraSwitcherInLocalPreview?: boolean

Eigenschaftswert

boolean

showMuteIndicator

Gibt an, ob neben dem Anzeigenamen des Benutzers ein Stummschaltsymbol angezeigt werden soll.

showMuteIndicator?: boolean

Eigenschaftswert

boolean

spotlightedParticipants

Liste der Benutzer-IDs der im Rampenlicht stehenden Teilnehmer.

spotlightedParticipants?: string[]

Eigenschaftswert

string[]

startTogetherModeEnabled

Gibt an, ob der lokale Teilnehmer den gemeinsamen Modus starten kann

startTogetherModeEnabled?: boolean

Eigenschaftswert

boolean

strings

Optionale Zeichenfolgen, die in komponente außer Kraft gesetzt werden sollen

strings?: Partial<VideoGalleryStrings>

Eigenschaftswert

Partial<VideoGalleryStrings>

styles

Ermöglicht Benutzern das Übergeben eines Objekts, das benutzerdefinierte CSS-Formatvorlagen für den Katalogcontainer enthält.

styles?: VideoGalleryStyles

Eigenschaftswert

VideoGalleryStyles

togetherModeSeatingCoordinates

Sitzposition der Teilnehmer im Together-Modus

togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition

Eigenschaftswert

VideoGalleryTogetherModeParticipantPosition

togetherModeStreams

Videostreams im Together-Modus

togetherModeStreams?: VideoGalleryTogetherModeStreams

Eigenschaftswert

VideoGalleryTogetherModeStreams

videoTilesOptions

Zusätzliche Optionen für Videokacheln

videoTilesOptions?: VideoTilesOptions

Eigenschaftswert

VideoTilesOptions