VideoGalleryProps interface

Csomag:

@azure/communication-react

VideoGallerykellékei.

Tulajdonságok

dominantSpeakers	A domináns beszélő felhasználói azonosítóinak listája a dominancia sorrendjében. A 0. index a legmeghatározóbb.
isTogetherModeActive	Azt jelzi, hogy az együtt mód aktív-e
layout	A videócsempék elrendezése.
localParticipant	Helyi videó particpant
localScreenShareView	A helyi képernyőmegosztási adatfolyam nézetét vezérli a galériában
localVideoCameraCycleButtonProps	Kameravezérlési információk a kamerák közötti váltáshoz szükséges gombról.
localVideoTileSize	Meghatározza a helyi videocsempe méretarányát a videógalériában.
localVideoViewOptions	Helyi videónézet beállításai
maxParticipantsToSpotlight	A kiemelhető résztvevők maximális száma
maxRemoteVideoStreams	A megjelenített résztvevő távoli videóstreamjeinek maximális száma.
onCreateLocalStreamView	Visszahívás a helyi videóstream nézet létrehozásához
onCreateRemoteStreamView	Visszahívás távoli videostream nézet létrehozásához
onCreateTogetherModeStreamView	Visszahívás közös módú streamnézet létrehozásához
onDisposeLocalScreenShareStreamView	Visszahívás a helyi képernyőmegosztási adatfolyam nézet megsemmisítéséhez
onDisposeLocalStreamView	Visszahívás a helyi videóstream nézet eltávolítása érdekében
onDisposeRemoteScreenShareStreamView	Visszahívás távoli képernyőmegosztási adatfolyam nézet megsemmisítéséhez
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView	Visszahívás távoli videostream nézet elvetéséhez
onDisposeTogetherModeStreamView	Visszahívás egy együttes módú adatfolyam-nézet megsemmisítéséhez
onForbidAudio	Ez a visszahívás tiltja a hangot a távoli résztvevő(k) számára
onForbidVideo	Ez a visszahívás tiltja a videót a távoli résztvevő(k) számára
onMuteParticipant	Ez a visszahívás egy távoli résztvevő elnémítását szolgálja
onPermitAudio	Ez a visszahívás a távoli résztvevő(k) hangjának engedélyezésére szolgál
onPermitVideo	Ez a visszahívás lehetővé teszi a videofelvételt a távoli résztvevő(k) számára
onPinParticipant	Ez a visszahívás akkor lesz meghívva, ha egy résztvevő videocsempe van rögzítve.
onRenderAvatar	Visszahívás a résztvevő avatarjának megjelenítéséhez
onRenderLocalVideoTile	Visszahívás a helyi videocsempe megjelenítéséhez
onRenderRemoteVideoTile	Visszahívás távoli videócsempe megjelenítéséhez
onSetTogetherModeSceneSize	Ez a visszahívás a jelenet méretének beállítására szolgál az együtt módhoz
onStartLocalSpotlight	Ez a visszahívás a helyi résztvevő videocsempéjének reflektorfénybe helyezését szolgálja.
onStartRemoteSpotlight	Ez a visszahívás a helyi résztvevő videocsempe reflektorfényének leállítására szolgál.
onStartTogetherMode	Ez a visszahívás az együtt mód elindítására szolgál
onStopLocalSpotlight	Ez a visszahívás a távoli résztvevők videocsempéinek reflektorfényének elindítására szolgál.
onStopRemoteSpotlight	Ez a visszahívás a távoli résztvevők videocsempéinek reflektorfényének leállítására szolgál.
onUnpinParticipant	Ez a visszahívás akkor lesz meghívva, ha egy résztvevő videocsempéje nincs rögzítve.
overflowGalleryPosition	Meghatározza az overflowGallery elrendezését a VideoGallery-ben.
pinnedParticipants	A rögzített résztvevők userId-jeinek listája.
reactionResources	Reakcióforrások hasonló, szív, nevetés, taps és meglepetés.
remoteParticipants	Távoli videó particensek listája
remoteVideoTileMenu	A távoli videocsempe menüjének megjelenítési lehetőségei.
remoteVideoViewOptions	Távoli videók nézetbeállításai
showCameraSwitcherInLocalPreview	A helyi videokamera-kapcsoló gomb megjelenítése
showMuteIndicator	Megjeleníthet-e elnémítás ikont a felhasználó megjelenítendő neve mellett.
spotlightedParticipants	A kiemelt résztvevők userId-jeinek listája.
startTogetherModeEnabled	Azt jelzi, hogy a helyi résztvevő elindíthatja-e az együtt módot
strings	Nem kötelező sztringek felülírása az összetevőben
styles	Lehetővé teszi a felhasználók számára, hogy egyéni CSS-stílusokat tartalmazó objektumot adjanak át a katalógustárolóhoz.
togetherModeSeatingCoordinates	A résztvevők üléshelyzete együtt módban
togetherModeStreams	Együtt módú videofolyamok
videoTilesOptions	További lehetőségek a videocsempékhez

Tulajdonság adatai

dominantSpeakers

A domináns beszélő felhasználói azonosítóinak listája a dominancia sorrendjében. A 0. index a legmeghatározóbb.

dominantSpeakers?: string[]

Tulajdonság értéke

string[]

isTogetherModeActive

Azt jelzi, hogy az együtt mód aktív-e

isTogetherModeActive?: boolean

Tulajdonság értéke

boolean

layout

A videócsempék elrendezése.

layout?: VideoGalleryLayout

Tulajdonság értéke

VideoGalleryLayout

localParticipant

Helyi videó particpant

localParticipant: VideoGalleryLocalParticipant

Tulajdonság értéke

VideoGalleryLocalParticipant

localScreenShareView

A helyi képernyőmegosztási adatfolyam nézetét vezérli a galériában

localScreenShareView?: LocalScreenShareView

Tulajdonság értéke

LocalScreenShareView

localVideoCameraCycleButtonProps

Kameravezérlési információk a kamerák közötti váltáshoz szükséges gombról.

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

Tulajdonság értéke

LocalVideoCameraCycleButtonProps

localVideoTileSize

Meghatározza a helyi videocsempe méretarányát a videógalériában.

localVideoTileSize?: LocalVideoTileSize

Tulajdonság értéke

LocalVideoTileSize

Megjegyzések

A "followDeviceOrientation" reagál a képernyő tájolására, és 9:16 (álló) és 16:9 (fekvő) képarány között változik.

localVideoViewOptions

Helyi videónézet beállításai

localVideoViewOptions?: VideoStreamOptions

Tulajdonság értéke

VideoStreamOptions

maxParticipantsToSpotlight

A kiemelhető résztvevők maximális száma

maxParticipantsToSpotlight?: number

Tulajdonság értéke

number

maxRemoteVideoStreams

A megjelenített résztvevő távoli videóstreamjeinek maximális száma.

maxRemoteVideoStreams?: number

Tulajdonság értéke

number

onCreateLocalStreamView

Visszahívás a helyi videóstream nézet létrehozásához

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

Tulajdonság értéke

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

onCreateRemoteStreamView

Visszahívás távoli videostream nézet létrehozásához

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

Tulajdonság értéke

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

onCreateTogetherModeStreamView

Visszahívás közös módú streamnézet létrehozásához

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

Tulajdonság értéke

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

onDisposeLocalScreenShareStreamView

Visszahívás a helyi képernyőmegosztási adatfolyam nézet megsemmisítéséhez

onDisposeLocalScreenShareStreamView?: () => Promise<void>

Tulajdonság értéke

() => Promise<void>

onDisposeLocalStreamView

Visszahívás a helyi videóstream nézet eltávolítása érdekében

onDisposeLocalStreamView?: () => void

Tulajdonság értéke

() => void

onDisposeRemoteScreenShareStreamView

Visszahívás távoli képernyőmegosztási adatfolyam nézet megsemmisítéséhez

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

Tulajdonság értéke

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Figyelmeztetés

Ez az API már elavult.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead

Callback to dispose a remote video stream view

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

Tulajdonság értéke

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

Visszahívás távoli videostream nézet elvetéséhez

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

Tulajdonság értéke

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Visszahívás egy együttes módú adatfolyam-nézet megsemmisítéséhez

onDisposeTogetherModeStreamView?: () => Promise<void>

Tulajdonság értéke

() => Promise<void>

onForbidAudio

Ez a visszahívás tiltja a hangot a távoli résztvevő(k) számára

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

Tulajdonság értéke

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

onForbidVideo

Ez a visszahívás tiltja a videót a távoli résztvevő(k) számára

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

Tulajdonság értéke

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

onMuteParticipant

Ez a visszahívás egy távoli résztvevő elnémítását szolgálja

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

Tulajdonság értéke

(userId: string) => Promise<void>

onPermitAudio

Ez a visszahívás a távoli résztvevő(k) hangjának engedélyezésére szolgál

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

Tulajdonság értéke

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

onPermitVideo

Ez a visszahívás lehetővé teszi a videofelvételt a távoli résztvevő(k) számára

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

Tulajdonság értéke

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

onPinParticipant

Ez a visszahívás akkor lesz meghívva, ha egy résztvevő videocsempe van rögzítve.

onPinParticipant?: (userId: string) => void

Tulajdonság értéke

(userId: string) => void

onRenderAvatar

Visszahívás a résztvevő avatarjának megjelenítéséhez

onRenderAvatar?: OnRenderAvatarCallback

Tulajdonság értéke

OnRenderAvatarCallback

onRenderLocalVideoTile

Visszahívás a helyi videocsempe megjelenítéséhez

onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => Element

Tulajdonság értéke

(localParticipant: VideoGalleryLocalParticipant) => Element

onRenderRemoteVideoTile

Visszahívás távoli videócsempe megjelenítéséhez

onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element

Tulajdonság értéke

(remoteParticipant: VideoGalleryRemoteParticipant) => Element

onSetTogetherModeSceneSize

Ez a visszahívás a jelenet méretének beállítására szolgál az együtt módhoz

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

Tulajdonság értéke

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

onStartLocalSpotlight

Ez a visszahívás a helyi résztvevő videocsempéjének reflektorfénybe helyezését szolgálja.

onStartLocalSpotlight?: () => Promise<void>

Tulajdonság értéke

() => Promise<void>

onStartRemoteSpotlight

Ez a visszahívás a helyi résztvevő videocsempe reflektorfényének leállítására szolgál.

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

Tulajdonság értéke

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

onStartTogetherMode

Ez a visszahívás az együtt mód elindítására szolgál

onStartTogetherMode?: () => Promise<void>

Tulajdonság értéke

() => Promise<void>

onStopLocalSpotlight

Ez a visszahívás a távoli résztvevők videocsempéinek reflektorfényének elindítására szolgál.

onStopLocalSpotlight?: () => Promise<void>

Tulajdonság értéke

() => Promise<void>

onStopRemoteSpotlight

Ez a visszahívás a távoli résztvevők videocsempéinek reflektorfényének leállítására szolgál.

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

Tulajdonság értéke

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

onUnpinParticipant

Ez a visszahívás akkor lesz meghívva, ha egy résztvevő videocsempéje nincs rögzítve.

onUnpinParticipant?: (userId: string) => void

Tulajdonság értéke

(userId: string) => void

overflowGalleryPosition

Meghatározza az overflowGallery elrendezését a VideoGallery-ben.

overflowGalleryPosition?: OverflowGalleryPosition

Tulajdonság értéke

OverflowGalleryPosition

pinnedParticipants

A rögzített résztvevők userId-jeinek listája.

pinnedParticipants?: string[]

Tulajdonság értéke

string[]

reactionResources

Reakcióforrások hasonló, szív, nevetés, taps és meglepetés.

reactionResources?: ReactionResources

Tulajdonság értéke

ReactionResources

remoteParticipants

Távoli videó particensek listája

remoteParticipants?: VideoGalleryRemoteParticipant[]

Tulajdonság értéke

VideoGalleryRemoteParticipant[]

remoteVideoTileMenu

A távoli videocsempe menüjének megjelenítési lehetőségei.

remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

Tulajdonság értéke

false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

remoteVideoViewOptions

Távoli videók nézetbeállításai

remoteVideoViewOptions?: VideoStreamOptions

Tulajdonság értéke

VideoStreamOptions

showCameraSwitcherInLocalPreview

A helyi videokamera-kapcsoló gomb megjelenítése

showCameraSwitcherInLocalPreview?: boolean

Tulajdonság értéke

boolean

showMuteIndicator

Megjeleníthet-e elnémítás ikont a felhasználó megjelenítendő neve mellett.

showMuteIndicator?: boolean

Tulajdonság értéke

boolean

spotlightedParticipants

A kiemelt résztvevők userId-jeinek listája.

spotlightedParticipants?: string[]

Tulajdonság értéke

string[]

startTogetherModeEnabled

Azt jelzi, hogy a helyi résztvevő elindíthatja-e az együtt módot

startTogetherModeEnabled?: boolean

Tulajdonság értéke

boolean

strings

Nem kötelező sztringek felülírása az összetevőben

strings?: Partial<VideoGalleryStrings>

Tulajdonság értéke

Partial<VideoGalleryStrings>

styles

Lehetővé teszi a felhasználók számára, hogy egyéni CSS-stílusokat tartalmazó objektumot adjanak át a katalógustárolóhoz.

styles?: VideoGalleryStyles

Tulajdonság értéke

VideoGalleryStyles

togetherModeSeatingCoordinates

A résztvevők üléshelyzete együtt módban

togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition

Tulajdonság értéke

VideoGalleryTogetherModeParticipantPosition

togetherModeStreams

Együtt módú videofolyamok

togetherModeStreams?: VideoGalleryTogetherModeStreams

Tulajdonság értéke

VideoGalleryTogetherModeStreams

videoTilesOptions

További lehetőségek a videocsempékhez

videoTilesOptions?: VideoTilesOptions

Tulajdonság értéke

VideoTilesOptions