VideoGalleryProps interface

Pakket:

@azure/communication-react

Rekwisieten voor VideoGallery.

Eigenschappen

dominantSpeakers	Lijst met dominante sprekergebruikers-id's in de volgorde van hun dominantie. De 0e index is de meest dominante index.
isTogetherModeActive	Geeft aan of de samenmodus actief is
layout	Indeling van de videotegels.
localParticipant	Lokale video particpant
localScreenShareView	Hiermee bepaalt u de weergave van de lokale schermdeelstream in de galerij
localVideoCameraCycleButtonProps	Informatie over camerabesturing voor knop om van camera te wisselen.
localVideoTileSize	Hiermee bepaalt u de hoogte-breedteverhouding van de lokale videotegel in de videogalerie.
localVideoViewOptions	Opties voor lokale videoweergave
maxParticipantsToSpotlight	Maximaal aantal deelnemers dat in de schijnwerpers kan worden gezet
maxRemoteVideoStreams	Maximum aantal externe videostreams van deelnemers dat wordt weergegeven.
onCreateLocalStreamView	Callback voor het maken van de lokale videostreamweergave
onCreateRemoteStreamView	Callback voor het maken van een externe videostreamweergave
onCreateTogetherModeStreamView	Aanbellen om een streamweergave in de samenmodus te maken
onDisposeLocalScreenShareStreamView	Terugbellen om een lokale streamweergave voor het delen van schermen te verwijderen
onDisposeLocalStreamView	Callback om de lokale videostreamweergave te verwijderen
onDisposeRemoteScreenShareStreamView	Terugbellen om een externe weergave van de schermdeling te verwijderen
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView	Callback voor het verwijderen van een externe videostreamweergave
onDisposeTogetherModeStreamView	Aanbellen om een streamweergave in de samenmodus te verwijderen
onForbidAudio	Deze callback is om audio te verbieden voor externe deelnemer(s)
onForbidVideo	Deze callback is om video te verbieden voor externe deelnemer(s)
onMuteParticipant	Deze callback is bedoeld om een externe deelnemer te dempen
onPermitAudio	Deze callback is bedoeld om audio toe te staan voor externe deelnemer(s)
onPermitVideo	Deze callback is bedoeld om video toe te staan voor externe deelnemer(s)
onPinParticipant	Deze callback wordt aangeroepen wanneer een videotegel van een deelnemer wordt vastgemaakt.
onRenderAvatar	Terugbellen om een avatar van een deelnemer weer te geven
onRenderLocalVideoTile	Callback om de lokale videotegel weer te geven
onRenderRemoteVideoTile	Callback om een externe videotegel weer te geven
onSetTogetherModeSceneSize	Deze callback is om de scènegrootte in te stellen voor de samen-modus
onStartLocalSpotlight	Deze callback is bedoeld om de schijnwerpers te starten voor de videotegel van lokale deelnemers.
onStartRemoteSpotlight	Deze callback is bedoeld om de schijnwerper voor de videotegel van lokale deelnemers te stoppen.
onStartTogetherMode	Deze callback is om samen modus te starten
onStopLocalSpotlight	Deze callback is bedoeld om de spotlight te starten voor videotegels voor externe deelnemers.
onStopRemoteSpotlight	Deze callback is bedoeld om de spotlight te stoppen voor videotegels voor externe deelnemers.
onUnpinParticipant	Deze callback wordt aangeroepen wanneer de videotegel van een deelnemer wordt losgemaakt.
overflowGalleryPosition	Bepaalt de lay-out van de overloopgalerij in de VideoGallery.
pinnedParticipants	Lijst met vastgemaakte userId's van deelnemers.
reactionResources	Reactiemiddelen voor like, hart, lach, applaus en verrast.
remoteParticipants	Lijst met externe videoonderdelen
remoteVideoTileMenu	Opties voor het weergeven van het menu van de externe videotegel.
remoteVideoViewOptions	Weergaveopties voor externe video's
showCameraSwitcherInLocalPreview	Of de lokale videocamerawisselaarknop moet worden weergegeven
showMuteIndicator	Of u een demppictogram naast de weergavenaam van de gebruiker wilt weergeven.
spotlightedParticipants	Lijst met uitgelichte gebruikers-id's van deelnemers.
startTogetherModeEnabled	Geeft aan of de lokale deelnemer de samenmodus kan starten
strings	Optionele tekenreeksen die moeten worden overschreven in onderdeel
styles	Hiermee kunnen gebruikers een object met aangepaste CSS-stijlen doorgeven voor de galeriecontainer.
togetherModeSeatingCoordinates	Zitpositie van de deelnemers in de samen-modus
togetherModeStreams	Videostreams in de Together-modus
videoTilesOptions	Extra opties voor videotegels

Eigenschapdetails

dominantSpeakers

Lijst met dominante sprekergebruikers-id's in de volgorde van hun dominantie. De 0e index is de meest dominante index.

dominantSpeakers?: string[]

Waarde van eigenschap

string[]

isTogetherModeActive

Geeft aan of de samenmodus actief is

isTogetherModeActive?: boolean

Waarde van eigenschap

boolean

layout

Indeling van de videotegels.

layout?: VideoGalleryLayout

Waarde van eigenschap

VideoGalleryLayout

localParticipant

Lokale video particpant

localParticipant: VideoGalleryLocalParticipant

Waarde van eigenschap

VideoGalleryLocalParticipant

localScreenShareView

Hiermee bepaalt u de weergave van de lokale schermdeelstream in de galerij

localScreenShareView?: LocalScreenShareView

Waarde van eigenschap

LocalScreenShareView

localVideoCameraCycleButtonProps

Informatie over camerabesturing voor knop om van camera te wisselen.

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

Waarde van eigenschap

LocalVideoCameraCycleButtonProps

localVideoTileSize

Hiermee bepaalt u de hoogte-breedteverhouding van de lokale videotegel in de videogalerie.

localVideoTileSize?: LocalVideoTileSize

Waarde van eigenschap

LocalVideoTileSize

Opmerkingen

'followDeviceOrientation' reageert op de schermoriëntatie en verandert tussen de beeldverhoudingen 9:16 (staand) en 16:9 (liggend).

localVideoViewOptions

Opties voor lokale videoweergave

localVideoViewOptions?: VideoStreamOptions

Waarde van eigenschap

VideoStreamOptions

maxParticipantsToSpotlight

Maximaal aantal deelnemers dat in de schijnwerpers kan worden gezet

maxParticipantsToSpotlight?: number

Waarde van eigenschap

number

maxRemoteVideoStreams

Maximum aantal externe videostreams van deelnemers dat wordt weergegeven.

maxRemoteVideoStreams?: number

Waarde van eigenschap

number

onCreateLocalStreamView

Callback voor het maken van de lokale videostreamweergave

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

Waarde van eigenschap

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

onCreateRemoteStreamView

Callback voor het maken van een externe videostreamweergave

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

Waarde van eigenschap

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

onCreateTogetherModeStreamView

Aanbellen om een streamweergave in de samenmodus te maken

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

Waarde van eigenschap

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

onDisposeLocalScreenShareStreamView

Terugbellen om een lokale streamweergave voor het delen van schermen te verwijderen

onDisposeLocalScreenShareStreamView?: () => Promise<void>

Waarde van eigenschap

() => Promise<void>

onDisposeLocalStreamView

Callback om de lokale videostreamweergave te verwijderen

onDisposeLocalStreamView?: () => void

Waarde van eigenschap

() => void

onDisposeRemoteScreenShareStreamView

Terugbellen om een externe weergave van de schermdeling te verwijderen

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

Waarde van eigenschap

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Waarschuwing

Deze API is nu afgeschaft.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead

Callback to dispose a remote video stream view

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

Waarde van eigenschap

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

Callback voor het verwijderen van een externe videostreamweergave

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

Waarde van eigenschap

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Aanbellen om een streamweergave in de samenmodus te verwijderen

onDisposeTogetherModeStreamView?: () => Promise<void>

Waarde van eigenschap

() => Promise<void>

onForbidAudio

Deze callback is om audio te verbieden voor externe deelnemer(s)

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

Waarde van eigenschap

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

onForbidVideo

Deze callback is om video te verbieden voor externe deelnemer(s)

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

Waarde van eigenschap

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

onMuteParticipant

Deze callback is bedoeld om een externe deelnemer te dempen

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

Waarde van eigenschap

(userId: string) => Promise<void>

onPermitAudio

Deze callback is bedoeld om audio toe te staan voor externe deelnemer(s)

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

Waarde van eigenschap

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

onPermitVideo

Deze callback is bedoeld om video toe te staan voor externe deelnemer(s)

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

Waarde van eigenschap

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

onPinParticipant

Deze callback wordt aangeroepen wanneer een videotegel van een deelnemer wordt vastgemaakt.

onPinParticipant?: (userId: string) => void

Waarde van eigenschap

(userId: string) => void

onRenderAvatar

Terugbellen om een avatar van een deelnemer weer te geven

onRenderAvatar?: OnRenderAvatarCallback

Waarde van eigenschap

OnRenderAvatarCallback

onRenderLocalVideoTile

Callback om de lokale videotegel weer te geven

onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => Element

Waarde van eigenschap

(localParticipant: VideoGalleryLocalParticipant) => Element

onRenderRemoteVideoTile

Callback om een externe videotegel weer te geven

onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element

Waarde van eigenschap

(remoteParticipant: VideoGalleryRemoteParticipant) => Element

onSetTogetherModeSceneSize

Deze callback is om de scènegrootte in te stellen voor de samen-modus

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

Waarde van eigenschap

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

onStartLocalSpotlight

Deze callback is bedoeld om de schijnwerpers te starten voor de videotegel van lokale deelnemers.

onStartLocalSpotlight?: () => Promise<void>

Waarde van eigenschap

() => Promise<void>

onStartRemoteSpotlight

Deze callback is bedoeld om de schijnwerper voor de videotegel van lokale deelnemers te stoppen.

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

Waarde van eigenschap

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

onStartTogetherMode

Deze callback is om samen modus te starten

onStartTogetherMode?: () => Promise<void>

Waarde van eigenschap

() => Promise<void>

onStopLocalSpotlight

Deze callback is bedoeld om de spotlight te starten voor videotegels voor externe deelnemers.

onStopLocalSpotlight?: () => Promise<void>

Waarde van eigenschap

() => Promise<void>

onStopRemoteSpotlight

Deze callback is bedoeld om de spotlight te stoppen voor videotegels voor externe deelnemers.

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

Waarde van eigenschap

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

onUnpinParticipant

Deze callback wordt aangeroepen wanneer de videotegel van een deelnemer wordt losgemaakt.

onUnpinParticipant?: (userId: string) => void

Waarde van eigenschap

(userId: string) => void

overflowGalleryPosition

Bepaalt de lay-out van de overloopgalerij in de VideoGallery.

overflowGalleryPosition?: OverflowGalleryPosition

Waarde van eigenschap

OverflowGalleryPosition

pinnedParticipants

Lijst met vastgemaakte userId's van deelnemers.

pinnedParticipants?: string[]

Waarde van eigenschap

string[]

reactionResources

Reactiemiddelen voor like, hart, lach, applaus en verrast.

reactionResources?: ReactionResources

Waarde van eigenschap

ReactionResources

remoteParticipants

Lijst met externe videoonderdelen

remoteParticipants?: VideoGalleryRemoteParticipant[]

Waarde van eigenschap

VideoGalleryRemoteParticipant[]

remoteVideoTileMenu

Opties voor het weergeven van het menu van de externe videotegel.

remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

Waarde van eigenschap

false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

remoteVideoViewOptions

Weergaveopties voor externe video's

remoteVideoViewOptions?: VideoStreamOptions

Waarde van eigenschap

VideoStreamOptions

showCameraSwitcherInLocalPreview

Of de lokale videocamerawisselaarknop moet worden weergegeven

showCameraSwitcherInLocalPreview?: boolean

Waarde van eigenschap

boolean

showMuteIndicator

Of u een demppictogram naast de weergavenaam van de gebruiker wilt weergeven.

showMuteIndicator?: boolean

Waarde van eigenschap

boolean

spotlightedParticipants

Lijst met uitgelichte gebruikers-id's van deelnemers.

spotlightedParticipants?: string[]

Waarde van eigenschap

string[]

startTogetherModeEnabled

Geeft aan of de lokale deelnemer de samenmodus kan starten

startTogetherModeEnabled?: boolean

Waarde van eigenschap

boolean

strings

Optionele tekenreeksen die moeten worden overschreven in onderdeel

strings?: Partial<VideoGalleryStrings>

Waarde van eigenschap

Partial<VideoGalleryStrings>

styles

Hiermee kunnen gebruikers een object met aangepaste CSS-stijlen doorgeven voor de galeriecontainer.

styles?: VideoGalleryStyles

Waarde van eigenschap

VideoGalleryStyles

togetherModeSeatingCoordinates

Zitpositie van de deelnemers in de samen-modus

togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition

Waarde van eigenschap

VideoGalleryTogetherModeParticipantPosition

togetherModeStreams

Videostreams in de Together-modus

togetherModeStreams?: VideoGalleryTogetherModeStreams

Waarde van eigenschap

VideoGalleryTogetherModeStreams

videoTilesOptions

Extra opties voor videotegels

videoTilesOptions?: VideoTilesOptions

Waarde van eigenschap

VideoTilesOptions