VideoGalleryProps interface

Paquete:

@azure/communication-react

Propiedades de VideoGallery.

Propiedades

dominantSpeakers	Lista de los identificadores de usuario dominantes del hablante en el orden de su dominación. 0º índice es el más dominante.
isTogetherModeActive	Indica si el modo conjunto está activo
layout	Diseño de los iconos de vídeo.
localParticipant	Vídeo local particpant
localScreenShareView	Controla la vista de la transmisión local de pantalla compartida en la galería
localVideoCameraCycleButtonProps	Información de control de cámara para el botón para cambiar las cámaras.
localVideoTileSize	Determina la relación de aspecto del mosaico de vídeo local en la galería de vídeos.
localVideoViewOptions	Opciones de vista de vídeo local
maxParticipantsToSpotlight	Número máximo de participantes que se pueden destacar
maxRemoteVideoStreams	Número máximo de secuencias de vídeo remotas participantes que se representan.
onCreateLocalStreamView	Devolución de llamada para crear la vista de secuencia de vídeo local
onCreateRemoteStreamView	Devolución de llamada para crear una vista remota de secuencia de vídeo
onCreateTogetherModeStreamView	Devolución de llamada para crear una vista de transmisión en modo conjunto
onDisposeLocalScreenShareStreamView	Devolución de llamada para eliminar una vista de transmisión de uso compartido de pantalla local
onDisposeLocalStreamView	Devolución de llamada para eliminar la vista de secuencia de vídeo local
onDisposeRemoteScreenShareStreamView	Devolución de llamada para eliminar una vista de transmisión de uso compartido de pantalla remota
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView	Devolución de llamada para eliminar una vista remota de secuencias de vídeo
onDisposeTogetherModeStreamView	Devolución de llamada para eliminar una vista de secuencia en modo conjunto
onForbidAudio	Esta devolución de llamada es para prohibir el audio para los participantes remotos
onForbidVideo	Esta devolución de llamada es para prohibir el video para los participantes remotos
onMuteParticipant	Esta devolución de llamada es para silenciar a un participante remoto
onPermitAudio	Esta devolución de llamada es para permitir el audio para los participantes remotos
onPermitVideo	Esta devolución de llamada es para permitir el video para los participantes remotos
onPinParticipant	Se llamará a esta devolución de llamada cuando se ancle un icono de vídeo de participante.
onRenderAvatar	Devolución de llamada para renderizar un avatar de participante
onRenderLocalVideoTile	Devolución de llamada para representar el icono de vídeo local
onRenderRemoteVideoTile	Devolución de llamada para representar un icono de vídeo remoto
onSetTogetherModeSceneSize	Esta devolución de llamada es para establecer el tamaño de la escena para el modo juntos
onStartLocalSpotlight	Esta devolución de llamada es para iniciar el foco de atención para el mosaico de video del participante local.
onStartRemoteSpotlight	Esta devolución de llamada es para detener el foco de atención para el mosaico de video del participante local.
onStartTogetherMode	Esta devolución de llamada es para iniciar el modo juntos
onStopLocalSpotlight	Esta devolución de llamada es para iniciar Spotlight para mosaicos de video de participantes remotos.
onStopRemoteSpotlight	Esta devolución de llamada es para detener el foco de atención para los mosaicos de video de participantes remotos.
onUnpinParticipant	Se llamará a esta devolución de llamada cuando se desancle el icono de vídeo de un participante.
overflowGalleryPosition	Determina el diseño de overflowGallery dentro de VideoGallery.
pinnedParticipants	Lista de userIds de participantes anclados.
reactionResources	Recursos de reacción para el like, el corazón, la risa, el aplauso y la sorpresa.
remoteParticipants	Lista de vídeos particpants remotos
remoteVideoTileMenu	Opciones para mostrar el menú de mosaico de vídeo remoto.
remoteVideoViewOptions	Opciones de vista de vídeos remotos
showCameraSwitcherInLocalPreview	Indica si se va a mostrar el botón del conmutador de cámara de vídeo local
showMuteIndicator	Indica si se va a mostrar un icono de silenciar junto al nombre para mostrar del usuario.
spotlightedParticipants	Lista de userIds de participantes destacados.
startTogetherModeEnabled	Indica si el participante local puede iniciar el modo conjunto
strings	Cadenas opcionales que se van a invalidar en el componente
styles	Permite a los usuarios pasar un objeto que contiene estilos CSS personalizados para el contenedor de la galería.
togetherModeSeatingCoordinates	Posición de los asientos de los participantes en modo juntos
togetherModeStreams	Transmisiones de vídeo en modo conjunto
videoTilesOptions	Opciones adicionales para mosaicos de video

Detalles de las propiedades

dominantSpeakers

Lista de los identificadores de usuario dominantes del hablante en el orden de su dominación. 0º índice es el más dominante.

dominantSpeakers?: string[]

Valor de propiedad

string[]

isTogetherModeActive

Indica si el modo conjunto está activo

isTogetherModeActive?: boolean

Valor de propiedad

boolean

layout

Diseño de los iconos de vídeo.

layout?: VideoGalleryLayout

Valor de propiedad

VideoGalleryLayout

localParticipant

Vídeo local particpant

localParticipant: VideoGalleryLocalParticipant

Valor de propiedad

VideoGalleryLocalParticipant

localScreenShareView

Controla la vista de la transmisión local de pantalla compartida en la galería

localScreenShareView?: LocalScreenShareView

Valor de propiedad

LocalScreenShareView

localVideoCameraCycleButtonProps

Información de control de cámara para el botón para cambiar las cámaras.

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

Valor de propiedad

LocalVideoCameraCycleButtonProps

localVideoTileSize

Determina la relación de aspecto del mosaico de vídeo local en la galería de vídeos.

localVideoTileSize?: LocalVideoTileSize

Valor de propiedad

LocalVideoTileSize

Comentarios

'followDeviceOrientation' responderá a la orientación de la pantalla y cambiará entre las relaciones de aspecto 9:16 (vertical) y 16:9 (horizontal).

localVideoViewOptions

Opciones de vista de vídeo local

localVideoViewOptions?: VideoStreamOptions

Valor de propiedad

VideoStreamOptions

maxParticipantsToSpotlight

Número máximo de participantes que se pueden destacar

maxParticipantsToSpotlight?: number

Valor de propiedad

number

maxRemoteVideoStreams

Número máximo de secuencias de vídeo remotas participantes que se representan.

maxRemoteVideoStreams?: number

Valor de propiedad

number

onCreateLocalStreamView

Devolución de llamada para crear la vista de secuencia de vídeo local

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

Valor de propiedad

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

onCreateRemoteStreamView

Devolución de llamada para crear una vista remota de secuencia de vídeo

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

Valor de propiedad

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

onCreateTogetherModeStreamView

Devolución de llamada para crear una vista de transmisión en modo conjunto

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

Valor de propiedad

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

onDisposeLocalScreenShareStreamView

Devolución de llamada para eliminar una vista de transmisión de uso compartido de pantalla local

onDisposeLocalScreenShareStreamView?: () => Promise<void>

Valor de propiedad

() => Promise<void>

onDisposeLocalStreamView

Devolución de llamada para eliminar la vista de secuencia de vídeo local

onDisposeLocalStreamView?: () => void

Valor de propiedad

() => void

onDisposeRemoteScreenShareStreamView

Devolución de llamada para eliminar una vista de transmisión de uso compartido de pantalla remota

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

Valor de propiedad

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Advertencia

Esta API ya está en desuso.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead

Callback to dispose a remote video stream view

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

Valor de propiedad

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

Devolución de llamada para eliminar una vista remota de secuencias de vídeo

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

Valor de propiedad

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Devolución de llamada para eliminar una vista de secuencia en modo conjunto

onDisposeTogetherModeStreamView?: () => Promise<void>

Valor de propiedad

() => Promise<void>

onForbidAudio

Esta devolución de llamada es para prohibir el audio para los participantes remotos

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

Valor de propiedad

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

onForbidVideo

Esta devolución de llamada es para prohibir el video para los participantes remotos

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

Valor de propiedad

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

onMuteParticipant

Esta devolución de llamada es para silenciar a un participante remoto

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

Valor de propiedad

(userId: string) => Promise<void>

onPermitAudio

Esta devolución de llamada es para permitir el audio para los participantes remotos

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

Valor de propiedad

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

onPermitVideo

Esta devolución de llamada es para permitir el video para los participantes remotos

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

Valor de propiedad

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

onPinParticipant

Se llamará a esta devolución de llamada cuando se ancle un icono de vídeo de participante.

onPinParticipant?: (userId: string) => void

Valor de propiedad

(userId: string) => void

onRenderAvatar

Devolución de llamada para renderizar un avatar de participante

onRenderAvatar?: OnRenderAvatarCallback

Valor de propiedad

OnRenderAvatarCallback

onRenderLocalVideoTile

Devolución de llamada para representar el icono de vídeo local

onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => Element

Valor de propiedad

(localParticipant: VideoGalleryLocalParticipant) => Element

onRenderRemoteVideoTile

Devolución de llamada para representar un icono de vídeo remoto

onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element

Valor de propiedad

(remoteParticipant: VideoGalleryRemoteParticipant) => Element

onSetTogetherModeSceneSize

Esta devolución de llamada es para establecer el tamaño de la escena para el modo juntos

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

Valor de propiedad

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

onStartLocalSpotlight

Esta devolución de llamada es para iniciar el foco de atención para el mosaico de video del participante local.

onStartLocalSpotlight?: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStartRemoteSpotlight

Esta devolución de llamada es para detener el foco de atención para el mosaico de video del participante local.

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

Valor de propiedad

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

onStartTogetherMode

Esta devolución de llamada es para iniciar el modo juntos

onStartTogetherMode?: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStopLocalSpotlight

Esta devolución de llamada es para iniciar Spotlight para mosaicos de video de participantes remotos.

onStopLocalSpotlight?: () => Promise<void>

Valor de propiedad

() => Promise<void>

onStopRemoteSpotlight

Esta devolución de llamada es para detener el foco de atención para los mosaicos de video de participantes remotos.

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

Valor de propiedad

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

onUnpinParticipant

Se llamará a esta devolución de llamada cuando se desancle el icono de vídeo de un participante.

onUnpinParticipant?: (userId: string) => void

Valor de propiedad

(userId: string) => void

overflowGalleryPosition

Determina el diseño de overflowGallery dentro de VideoGallery.

overflowGalleryPosition?: OverflowGalleryPosition

Valor de propiedad

OverflowGalleryPosition

pinnedParticipants

Lista de userIds de participantes anclados.

pinnedParticipants?: string[]

Valor de propiedad

string[]

reactionResources

Recursos de reacción para el like, el corazón, la risa, el aplauso y la sorpresa.

reactionResources?: ReactionResources

Valor de propiedad

ReactionResources

remoteParticipants

Lista de vídeos particpants remotos

remoteParticipants?: VideoGalleryRemoteParticipant[]

Valor de propiedad

VideoGalleryRemoteParticipant[]

remoteVideoTileMenu

Opciones para mostrar el menú de mosaico de vídeo remoto.

remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

Valor de propiedad

false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

remoteVideoViewOptions

Opciones de vista de vídeos remotos

remoteVideoViewOptions?: VideoStreamOptions

Valor de propiedad

VideoStreamOptions

showCameraSwitcherInLocalPreview

Indica si se va a mostrar el botón del conmutador de cámara de vídeo local

showCameraSwitcherInLocalPreview?: boolean

Valor de propiedad

boolean

showMuteIndicator

Indica si se va a mostrar un icono de silenciar junto al nombre para mostrar del usuario.

showMuteIndicator?: boolean

Valor de propiedad

boolean

spotlightedParticipants

Lista de userIds de participantes destacados.

spotlightedParticipants?: string[]

Valor de propiedad

string[]

startTogetherModeEnabled

Indica si el participante local puede iniciar el modo conjunto

startTogetherModeEnabled?: boolean

Valor de propiedad

boolean

strings

Cadenas opcionales que se van a invalidar en el componente

strings?: Partial<VideoGalleryStrings>

Valor de propiedad

Partial<VideoGalleryStrings>

styles

Permite a los usuarios pasar un objeto que contiene estilos CSS personalizados para el contenedor de la galería.

styles?: VideoGalleryStyles

Valor de propiedad

VideoGalleryStyles

togetherModeSeatingCoordinates

Posición de los asientos de los participantes en modo juntos

togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition

Valor de propiedad

VideoGalleryTogetherModeParticipantPosition

togetherModeStreams

Transmisiones de vídeo en modo conjunto

togetherModeStreams?: VideoGalleryTogetherModeStreams

Valor de propiedad

VideoGalleryTogetherModeStreams

videoTilesOptions

Opciones adicionales para mosaicos de video

videoTilesOptions?: VideoTilesOptions

Valor de propiedad

VideoTilesOptions