VideoGalleryProps interface

Paket:

@azure/communication-react

Rekvisita för VideoGallery.

Egenskaper

dominantSpeakers	Lista över dominanta talaranvändar-ID:n i deras dominansordning. 0:e indexet är det mest dominerande.
isTogetherModeActive	Indikerar om tillsammans-läget är aktivt
layout	Layout för videopanelerna.
localParticipant	Lokal videodelik
localScreenShareView	Styr visningen av den lokala skärmdelningsströmmen i galleriet
localVideoCameraCycleButtonProps	Kamerakontrollinformation för knapp för att växla kameror.
localVideoTileSize	Bestämmer proportionerna för den lokala videorutan i videogalleriet.
localVideoViewOptions	Alternativ för lokal videovy
maxParticipantsToSpotlight	Maximalt antal deltagare som kan lyftas fram
maxRemoteVideoStreams	Maximalt antal fjärrvideoströmmar för deltagare som återges.
onCreateLocalStreamView	Återanrop för att skapa den lokala videoströmvyn
onCreateRemoteStreamView	Återanrop för att skapa en fjärrvy för videoströmmar
onCreateTogetherModeStreamView	Återuppringning för att skapa en strömvy i tillsammans-läge
onDisposeLocalScreenShareStreamView	Återuppringning för att ta bort en lokal skärmdelningsströmvy
onDisposeLocalStreamView	Återanrop för att ta bort den lokala videoströmvyn
onDisposeRemoteScreenShareStreamView	Återuppringning för att ta bort en fjärrskärmsdelning strömvy
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView	Återanrop för att ta bort en fjärrvy för videoströmmar
onDisposeTogetherModeStreamView	Återuppringning för att ta bort en strömvy i tillsammans-läge
onForbidAudio	Det här återanropet är till för att förbjuda ljud för fjärranslutna deltagare
onForbidVideo	Det här återanropet är för att förbjuda video för fjärranslutna deltagare
onMuteParticipant	Det här återanropet är för att tysta en fjärransluten deltagare
onPermitAudio	Det här återanropet är till för att tillåta ljud för fjärranslutna deltagare
onPermitVideo	Det här återanropet är för att tillåta video för fjärranslutna deltagare
onPinParticipant	Det här återanropet anropas när en videopanel för mötesdeltagare fästs.
onRenderAvatar	Återanrop för att återge en deltagaravatar
onRenderLocalVideoTile	Återanrop för att återge den lokala videopanelen
onRenderRemoteVideoTile	Återanrop för att återge en fjärrvideopanel
onSetTogetherModeSceneSize	Detta återanrop är för att ställa in scenstorleken för tillsammans-läge
onStartLocalSpotlight	Det här återanropet är till för att starta spotlight för videopanelen för lokala deltagare.
onStartRemoteSpotlight	Det här återanropet är för att stoppa spotlighten för videopanelen för lokala deltagare.
onStartTogetherMode	Detta återanrop är för att starta tillsammans-läge
onStopLocalSpotlight	Det här återanropet är till för att starta spotlight för videopaneler för fjärrdeltagare.
onStopRemoteSpotlight	Det här återanropet är till för att stoppa spotlighten för videopaneler för fjärranslutna deltagare.
onUnpinParticipant	Det här återanropet anropas när en mötesdeltagares videopanel inte är fäst.
overflowGalleryPosition	Bestämmer layouten för overflowGallery i VideoGallery.
pinnedParticipants	Lista över fästa användar-ID:n för deltagare.
reactionResources	Reaktionsresurser för like, hjärta, skratt, applåder och överraskad.
remoteParticipants	Lista över fjärranslutna videodelikrutor
remoteVideoTileMenu	Alternativ för att visa fjärrvideopanelens meny.
remoteVideoViewOptions	Visningsalternativ för fjärrvideor
showCameraSwitcherInLocalPreview	Om du vill visa växelknappen för den lokala videokameran
showMuteIndicator	Om du vill visa en ljudavstängningsikon bredvid användarens visningsnamn.
spotlightedParticipants	Lista över användar-ID:n för deltagare i fokus.
startTogetherModeEnabled	Anger om den lokala deltagaren kan starta tillsammans
strings	Valfria strängar som ska åsidosättas i komponenten
styles	Tillåter användare att skicka ett objekt som innehåller anpassade CSS-format för gallericontainern.
togetherModeSeatingCoordinates	Deltagarnas sittställning i tillsammans-läge
togetherModeStreams	Videoströmmar i Tillsammans-läge
videoTilesOptions	Ytterligare alternativ för videopaneler

Egenskapsinformation

dominantSpeakers

Lista över dominanta talaranvändar-ID:n i deras dominansordning. 0:e indexet är det mest dominerande.

dominantSpeakers?: string[]

Egenskapsvärde

string[]

isTogetherModeActive

Indikerar om tillsammans-läget är aktivt

isTogetherModeActive?: boolean

Egenskapsvärde

boolean

layout

Layout för videopanelerna.

layout?: VideoGalleryLayout

Egenskapsvärde

VideoGalleryLayout

localParticipant

Lokal videodelik

localParticipant: VideoGalleryLocalParticipant

Egenskapsvärde

VideoGalleryLocalParticipant

localScreenShareView

Styr visningen av den lokala skärmdelningsströmmen i galleriet

localScreenShareView?: LocalScreenShareView

Egenskapsvärde

LocalScreenShareView

localVideoCameraCycleButtonProps

Kamerakontrollinformation för knapp för att växla kameror.

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

Egenskapsvärde

LocalVideoCameraCycleButtonProps

localVideoTileSize

Bestämmer proportionerna för den lokala videorutan i videogalleriet.

localVideoTileSize?: LocalVideoTileSize

Egenskapsvärde

LocalVideoTileSize

Kommentarer

"followDeviceOrientation" kommer att svara på skärmens orientering och kommer att ändras mellan 9:16 (stående) och 16:9 (liggande) bildförhållanden.

localVideoViewOptions

Alternativ för lokal videovy

localVideoViewOptions?: VideoStreamOptions

Egenskapsvärde

VideoStreamOptions

maxParticipantsToSpotlight

Maximalt antal deltagare som kan lyftas fram

maxParticipantsToSpotlight?: number

Egenskapsvärde

number

maxRemoteVideoStreams

Maximalt antal fjärrvideoströmmar för deltagare som återges.

maxRemoteVideoStreams?: number

Egenskapsvärde

number

onCreateLocalStreamView

Återanrop för att skapa den lokala videoströmvyn

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

Egenskapsvärde

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

onCreateRemoteStreamView

Återanrop för att skapa en fjärrvy för videoströmmar

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

Egenskapsvärde

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

onCreateTogetherModeStreamView

Återuppringning för att skapa en strömvy i tillsammans-läge

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

Egenskapsvärde

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

onDisposeLocalScreenShareStreamView

Återuppringning för att ta bort en lokal skärmdelningsströmvy

onDisposeLocalScreenShareStreamView?: () => Promise<void>

Egenskapsvärde

() => Promise<void>

onDisposeLocalStreamView

Återanrop för att ta bort den lokala videoströmvyn

onDisposeLocalStreamView?: () => void

Egenskapsvärde

() => void

onDisposeRemoteScreenShareStreamView

Återuppringning för att ta bort en fjärrskärmsdelning strömvy

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

Egenskapsvärde

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Varning

Det här API:et är nu inaktuellt.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead

Callback to dispose a remote video stream view

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

Egenskapsvärde

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

Återanrop för att ta bort en fjärrvy för videoströmmar

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

Egenskapsvärde

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Återuppringning för att ta bort en strömvy i tillsammans-läge

onDisposeTogetherModeStreamView?: () => Promise<void>

Egenskapsvärde

() => Promise<void>

onForbidAudio

Det här återanropet är till för att förbjuda ljud för fjärranslutna deltagare

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

Egenskapsvärde

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

onForbidVideo

Det här återanropet är för att förbjuda video för fjärranslutna deltagare

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

Egenskapsvärde

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

onMuteParticipant

Det här återanropet är för att tysta en fjärransluten deltagare

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

Egenskapsvärde

(userId: string) => Promise<void>

onPermitAudio

Det här återanropet är till för att tillåta ljud för fjärranslutna deltagare

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

Egenskapsvärde

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

onPermitVideo

Det här återanropet är för att tillåta video för fjärranslutna deltagare

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

Egenskapsvärde

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

onPinParticipant

Det här återanropet anropas när en videopanel för mötesdeltagare fästs.

onPinParticipant?: (userId: string) => void

Egenskapsvärde

(userId: string) => void

onRenderAvatar

Återanrop för att återge en deltagaravatar

onRenderAvatar?: OnRenderAvatarCallback

Egenskapsvärde

OnRenderAvatarCallback

onRenderLocalVideoTile

Återanrop för att återge den lokala videopanelen

onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => Element

Egenskapsvärde

(localParticipant: VideoGalleryLocalParticipant) => Element

onRenderRemoteVideoTile

Återanrop för att återge en fjärrvideopanel

onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element

Egenskapsvärde

(remoteParticipant: VideoGalleryRemoteParticipant) => Element

onSetTogetherModeSceneSize

Detta återanrop är för att ställa in scenstorleken för tillsammans-läge

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

Egenskapsvärde

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

onStartLocalSpotlight

Det här återanropet är till för att starta spotlight för videopanelen för lokala deltagare.

onStartLocalSpotlight?: () => Promise<void>

Egenskapsvärde

() => Promise<void>

onStartRemoteSpotlight

Det här återanropet är för att stoppa spotlighten för videopanelen för lokala deltagare.

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

Egenskapsvärde

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

onStartTogetherMode

Detta återanrop är för att starta tillsammans-läge

onStartTogetherMode?: () => Promise<void>

Egenskapsvärde

() => Promise<void>

onStopLocalSpotlight

Det här återanropet är till för att starta spotlight för videopaneler för fjärrdeltagare.

onStopLocalSpotlight?: () => Promise<void>

Egenskapsvärde

() => Promise<void>

onStopRemoteSpotlight

Det här återanropet är till för att stoppa spotlighten för videopaneler för fjärranslutna deltagare.

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

Egenskapsvärde

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

onUnpinParticipant

Det här återanropet anropas när en mötesdeltagares videopanel inte är fäst.

onUnpinParticipant?: (userId: string) => void

Egenskapsvärde

(userId: string) => void

overflowGalleryPosition

Bestämmer layouten för overflowGallery i VideoGallery.

overflowGalleryPosition?: OverflowGalleryPosition

Egenskapsvärde

OverflowGalleryPosition

pinnedParticipants

Lista över fästa användar-ID:n för deltagare.

pinnedParticipants?: string[]

Egenskapsvärde

string[]

reactionResources

Reaktionsresurser för like, hjärta, skratt, applåder och överraskad.

reactionResources?: ReactionResources

Egenskapsvärde

ReactionResources

remoteParticipants

Lista över fjärranslutna videodelikrutor

remoteParticipants?: VideoGalleryRemoteParticipant[]

Egenskapsvärde

VideoGalleryRemoteParticipant[]

remoteVideoTileMenu

Alternativ för att visa fjärrvideopanelens meny.

remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

Egenskapsvärde

false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

remoteVideoViewOptions

Visningsalternativ för fjärrvideor

remoteVideoViewOptions?: VideoStreamOptions

Egenskapsvärde

VideoStreamOptions

showCameraSwitcherInLocalPreview

Om du vill visa växelknappen för den lokala videokameran

showCameraSwitcherInLocalPreview?: boolean

Egenskapsvärde

boolean

showMuteIndicator

Om du vill visa en ljudavstängningsikon bredvid användarens visningsnamn.

showMuteIndicator?: boolean

Egenskapsvärde

boolean

spotlightedParticipants

Lista över användar-ID:n för deltagare i fokus.

spotlightedParticipants?: string[]

Egenskapsvärde

string[]

startTogetherModeEnabled

Anger om den lokala deltagaren kan starta tillsammans

startTogetherModeEnabled?: boolean

Egenskapsvärde

boolean

strings

Valfria strängar som ska åsidosättas i komponenten

strings?: Partial<VideoGalleryStrings>

Egenskapsvärde

Partial<VideoGalleryStrings>

styles

Tillåter användare att skicka ett objekt som innehåller anpassade CSS-format för gallericontainern.

styles?: VideoGalleryStyles

Egenskapsvärde

VideoGalleryStyles

togetherModeSeatingCoordinates

Deltagarnas sittställning i tillsammans-läge

togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition

Egenskapsvärde

VideoGalleryTogetherModeParticipantPosition

togetherModeStreams

Videoströmmar i Tillsammans-läge

togetherModeStreams?: VideoGalleryTogetherModeStreams

Egenskapsvärde

VideoGalleryTogetherModeStreams

videoTilesOptions

Ytterligare alternativ för videopaneler

videoTilesOptions?: VideoTilesOptions

Egenskapsvärde

VideoTilesOptions