VideoGalleryProps interface
Proprietà per VideoGallery.
Proprietà
| dominant |
Elenco di userId del parlante dominante nell'ordine di dominanza. 0° indice è il più dominante. |
| is |
Indica se la modalità insieme è attiva |
| layout | Layout dei riquadri video. |
| local |
Particpant video locale |
| local |
Controlla la visualizzazione del flusso di condivisione dello schermo locale nella galleria |
| local |
Informazioni sul controllo della fotocamera per il pulsante per cambiare telecamere. |
| local |
Determina le proporzioni del riquadro video locale nella raccolta video. |
| local |
Opzioni di visualizzazione video locale |
| max |
Numero massimo di partecipanti che possono essere messi in evidenza |
| max |
Numero massimo di flussi video remoti dei partecipanti di cui viene eseguito il rendering. |
| on |
Callback per creare la visualizzazione del flusso video locale |
| on |
Callback per creare una visualizzazione del flusso video remoto |
| on |
Richiamata per creare una visualizzazione del flusso in modalità insieme |
| on |
Richiamata per eliminare una visualizzazione del flusso di condivisione dello schermo locale |
| on |
Callback per eliminare la visualizzazione del flusso video locale |
| on |
Richiamata per eliminare una visualizzazione del flusso di condivisione dello schermo remoto |
| on |
|
| on |
Callback per eliminare una visualizzazione del flusso video remoto |
| on |
Callback per eliminare una visualizzazione del flusso in modalità insieme |
| on |
Questa richiamata serve a vietare l'audio ai partecipanti remoti |
| on |
Questa richiamata serve a vietare il video ai partecipanti remoti |
| on |
Questo callback serve per disattivare l'audio di un partecipante remoto |
| on |
Questo callback serve a consentire l'audio per i partecipanti remoti |
| on |
Questo callback serve a consentire il video per i partecipanti remoti |
| on |
Questo callback verrà chiamato quando viene aggiunto un riquadro video partecipante. |
| on |
Richiamata per il rendering dell'avatar di un partecipante |
| on |
Callback per eseguire il rendering del riquadro video locale |
| on |
Callback per eseguire il rendering di un riquadro video remoto |
| on |
Questa richiamata serve per impostare le dimensioni della scena per la modalità insieme |
| on |
Questo callback serve ad avviare Spotlight per il riquadro video del partecipante locale. |
| on |
Questo callback serve a fermare Spotlight per il riquadro video del partecipante locale. |
| on |
Questa richiamata serve per avviare la modalità insieme |
| on |
Questo callback serve ad avviare Spotlight per i riquadri video dei partecipanti remoti. |
| on |
Questo callback serve a fermare Spotlight per i riquadri video dei partecipanti remoti. |
| on |
Questo callback verrà chiamato quando un riquadro video partecipante viene sbloccato. |
| overflow |
Determina il layout dell'overflowGallery all'interno di VideoGallery. |
| pinned |
Elenco degli userID dei partecipanti bloccati. |
| reaction |
Risorse di reazione per mi piace, cuore, risate, applausi e sorpresa. |
| remote |
Elenco di particpants video remoti |
| remote |
Opzioni per visualizzare il menu del riquadro video remoto. |
| remote |
Opzioni di visualizzazione video remoti |
| show |
Indica se visualizzare il pulsante di commutazione della videocamera locale |
| show |
Indica se visualizzare un'icona di disattivazione disattivata accanto al nome visualizzato dell'utente. |
| spotlighted |
Elenco degli userID dei partecipanti in evidenza. |
| start |
Indica se il partecipante locale può avviare la modalità insieme |
| strings | Stringhe facoltative di cui eseguire l'override nel componente |
| styles | Consente agli utenti di passare un oggetto contenente stili CSS personalizzati per il contenitore della raccolta. |
| together |
Posizione di seduta dei partecipanti in modalità insieme |
| together |
Flussi video in modalità Insieme |
| video |
Opzioni aggiuntive per i riquadri video |
Dettagli proprietà
dominantSpeakers
Elenco di userId del parlante dominante nell'ordine di dominanza. 0° indice è il più dominante.
dominantSpeakers?: string[]Valore della proprietà
string[]
isTogetherModeActive
Indica se la modalità insieme è attiva
isTogetherModeActive?: booleanValore della proprietà
boolean
layout
localParticipant
Particpant video locale
localParticipant: VideoGalleryLocalParticipantValore della proprietà
localScreenShareView
Controlla la visualizzazione del flusso di condivisione dello schermo locale nella galleria
localScreenShareView?: LocalScreenShareViewValore della proprietà
localVideoCameraCycleButtonProps
Informazioni sul controllo della fotocamera per il pulsante per cambiare telecamere.
localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonPropsValore della proprietà
localVideoTileSize
Determina le proporzioni del riquadro video locale nella raccolta video.
localVideoTileSize?: LocalVideoTileSizeValore della proprietà
Commenti
'followDeviceOrientation' risponderà all'orientamento dello schermo e cambierà tra le proporzioni 9:16 (verticale) e 16:9 (orizzontale).
localVideoViewOptions
Opzioni di visualizzazione video locale
localVideoViewOptions?: VideoStreamOptionsValore della proprietà
maxParticipantsToSpotlight
Numero massimo di partecipanti che possono essere messi in evidenza
maxParticipantsToSpotlight?: numberValore della proprietà
number
maxRemoteVideoStreams
Numero massimo di flussi video remoti dei partecipanti di cui viene eseguito il rendering.
maxRemoteVideoStreams?: numberValore della proprietà
number
onCreateLocalStreamView
Callback per creare la visualizzazione del flusso video locale
onCreateLocalStreamView?: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>Valore della proprietà
(options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
onCreateRemoteStreamView
Callback per creare una visualizzazione del flusso video remoto
onCreateRemoteStreamView?: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>Valore della proprietà
(userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
onCreateTogetherModeStreamView
Richiamata per creare una visualizzazione del flusso in modalità insieme
onCreateTogetherModeStreamView?: (options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>Valore della proprietà
(options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>
onDisposeLocalScreenShareStreamView
Richiamata per eliminare una visualizzazione del flusso di condivisione dello schermo locale
onDisposeLocalScreenShareStreamView?: () => Promise<void>Valore della proprietà
() => Promise<void>
onDisposeLocalStreamView
Callback per eliminare la visualizzazione del flusso video locale
onDisposeLocalStreamView?: () => voidValore della proprietà
() => void
onDisposeRemoteScreenShareStreamView
Richiamata per eliminare una visualizzazione del flusso di condivisione dello schermo remoto
onDisposeRemoteScreenShareStreamView?: (userId: string) => Promise<void>Valore della proprietà
(userId: string) => Promise<void>
onDisposeRemoteStreamView
Avviso
Questa API è ora deprecata.
use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead
Callback to dispose a remote video stream view
onDisposeRemoteStreamView?: (userId: string) => Promise<void>Valore della proprietà
(userId: string) => Promise<void>
onDisposeRemoteVideoStreamView
Callback per eliminare una visualizzazione del flusso video remoto
onDisposeRemoteVideoStreamView?: (userId: string) => Promise<void>Valore della proprietà
(userId: string) => Promise<void>
onDisposeTogetherModeStreamView
Callback per eliminare una visualizzazione del flusso in modalità insieme
onDisposeTogetherModeStreamView?: () => Promise<void>Valore della proprietà
() => Promise<void>
onForbidAudio
Questa richiamata serve a vietare l'audio ai partecipanti remoti
onForbidAudio?: (userIds: string[]) => Promise<void>Valore della proprietà
(userIds: string[]) => Promise<void>
onForbidVideo
Questa richiamata serve a vietare il video ai partecipanti remoti
onForbidVideo?: (userIds: string[]) => Promise<void>Valore della proprietà
(userIds: string[]) => Promise<void>
onMuteParticipant
Questo callback serve per disattivare l'audio di un partecipante remoto
onMuteParticipant?: (userId: string) => Promise<void>Valore della proprietà
(userId: string) => Promise<void>
onPermitAudio
Questo callback serve a consentire l'audio per i partecipanti remoti
onPermitAudio?: (userIds: string[]) => Promise<void>Valore della proprietà
(userIds: string[]) => Promise<void>
onPermitVideo
Questo callback serve a consentire il video per i partecipanti remoti
onPermitVideo?: (userIds: string[]) => Promise<void>Valore della proprietà
(userIds: string[]) => Promise<void>
onPinParticipant
Questo callback verrà chiamato quando viene aggiunto un riquadro video partecipante.
onPinParticipant?: (userId: string) => voidValore della proprietà
(userId: string) => void
onRenderAvatar
Richiamata per il rendering dell'avatar di un partecipante
onRenderAvatar?: OnRenderAvatarCallbackValore della proprietà
onRenderLocalVideoTile
Callback per eseguire il rendering del riquadro video locale
onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => ElementValore della proprietà
(localParticipant: VideoGalleryLocalParticipant) => Element
onRenderRemoteVideoTile
Callback per eseguire il rendering di un riquadro video remoto
onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => ElementValore della proprietà
(remoteParticipant: VideoGalleryRemoteParticipant) => Element
onSetTogetherModeSceneSize
Questa richiamata serve per impostare le dimensioni della scena per la modalità insieme
onSetTogetherModeSceneSize?: (width: number, height: number) => voidValore della proprietà
(width: number, height: number) => void
onStartLocalSpotlight
Questo callback serve ad avviare Spotlight per il riquadro video del partecipante locale.
onStartLocalSpotlight?: () => Promise<void>Valore della proprietà
() => Promise<void>
onStartRemoteSpotlight
Questo callback serve a fermare Spotlight per il riquadro video del partecipante locale.
onStartRemoteSpotlight?: (userIds: string[]) => Promise<void>Valore della proprietà
(userIds: string[]) => Promise<void>
onStartTogetherMode
Questa richiamata serve per avviare la modalità insieme
onStartTogetherMode?: () => Promise<void>Valore della proprietà
() => Promise<void>
onStopLocalSpotlight
Questo callback serve ad avviare Spotlight per i riquadri video dei partecipanti remoti.
onStopLocalSpotlight?: () => Promise<void>Valore della proprietà
() => Promise<void>
onStopRemoteSpotlight
Questo callback serve a fermare Spotlight per i riquadri video dei partecipanti remoti.
onStopRemoteSpotlight?: (userIds: string[]) => Promise<void>Valore della proprietà
(userIds: string[]) => Promise<void>
onUnpinParticipant
Questo callback verrà chiamato quando un riquadro video partecipante viene sbloccato.
onUnpinParticipant?: (userId: string) => voidValore della proprietà
(userId: string) => void
overflowGalleryPosition
Determina il layout dell'overflowGallery all'interno di VideoGallery.
overflowGalleryPosition?: OverflowGalleryPositionValore della proprietà
pinnedParticipants
Elenco degli userID dei partecipanti bloccati.
pinnedParticipants?: string[]Valore della proprietà
string[]
reactionResources
Risorse di reazione per mi piace, cuore, risate, applausi e sorpresa.
reactionResources?: ReactionResourcesValore della proprietà
remoteParticipants
Elenco di particpants video remoti
remoteParticipants?: VideoGalleryRemoteParticipant[]Valore della proprietà
remoteVideoTileMenu
Opzioni per visualizzare il menu del riquadro video remoto.
remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuPropsValore della proprietà
remoteVideoViewOptions
Opzioni di visualizzazione video remoti
remoteVideoViewOptions?: VideoStreamOptionsValore della proprietà
showCameraSwitcherInLocalPreview
Indica se visualizzare il pulsante di commutazione della videocamera locale
showCameraSwitcherInLocalPreview?: booleanValore della proprietà
boolean
showMuteIndicator
Indica se visualizzare un'icona di disattivazione disattivata accanto al nome visualizzato dell'utente.
showMuteIndicator?: booleanValore della proprietà
boolean
spotlightedParticipants
Elenco degli userID dei partecipanti in evidenza.
spotlightedParticipants?: string[]Valore della proprietà
string[]
startTogetherModeEnabled
Indica se il partecipante locale può avviare la modalità insieme
startTogetherModeEnabled?: booleanValore della proprietà
boolean
strings
Stringhe facoltative di cui eseguire l'override nel componente
strings?: Partial<VideoGalleryStrings>Valore della proprietà
Partial<VideoGalleryStrings>
styles
Consente agli utenti di passare un oggetto contenente stili CSS personalizzati per il contenitore della raccolta.
styles?: VideoGalleryStylesValore della proprietà
togetherModeSeatingCoordinates
Posizione di seduta dei partecipanti in modalità insieme
togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPositionValore della proprietà
togetherModeStreams
Flussi video in modalità Insieme
togetherModeStreams?: VideoGalleryTogetherModeStreamsValore della proprietà
videoTilesOptions
Opzioni aggiuntive per i riquadri video
videoTilesOptions?: VideoTilesOptions