VideoGalleryProps interface
Props para VideoGallery.
Propriedades
| dominant |
Lista de userIds de alto-falantes dominantes na ordem de sua dominância. O índice 0 é o mais dominante. |
| is |
Indica se o modo de conjunto está ativo |
| layout | Layout dos blocos de vídeo. |
| local |
Vídeo participante local |
| local |
Controla a exibição do fluxo de compartilhamento de tela local na galeria |
| local |
Informações de controle da câmera para botão para alternar câmeras. |
| local |
Determina a proporção do bloco de vídeo local na galeria de vídeos. |
| local |
Opções de visualização de vídeo local |
| max |
Máximo de participantes que podem ser destacados |
| max |
Número máximo de fluxos de vídeo remotos participantes que é renderizado. |
| on |
Retorno de chamada para criar a visualização do fluxo de vídeo local |
| on |
Retorno de chamada para criar uma visualização remota de fluxo de vídeo |
| on |
Retorno de chamada para criar uma exibição de fluxo em modo conjunto |
| on |
Retorno de chamada para descartar uma exibição de fluxo de compartilhamento de tela local |
| on |
Retorno de chamada para eliminar a visualização do fluxo de vídeo local |
| on |
Retorno de chamada para descartar uma exibição de fluxo de compartilhamento de tela remota |
| on |
|
| on |
Retorno de chamada para descartar uma visualização remota de fluxo de vídeo |
| on |
Retorno de chamada para descartar uma exibição de fluxo em modo conjunto |
| on |
Este retorno de chamada é para proibir áudio para participantes remotos |
| on |
Este retorno de chamada é para proibir vídeo para participantes remotos |
| on |
Este retorno de chamada é para silenciar um participante remoto |
| on |
Este retorno de chamada é para permitir áudio para participantes remotos |
| on |
Este retorno de chamada é para permitir vídeo para participantes remotos |
| on |
Esse retorno de chamada será chamado quando um bloco de vídeo do participante for fixado. |
| on |
Retorno de chamada para renderizar um avatar de participante |
| on |
Retorno de chamada para renderizar o bloco de vídeo local |
| on |
Retorno de chamada para renderizar um bloco de vídeo remoto |
| on |
Este retorno de chamada é para definir o tamanho da cena para o modo de conjunto |
| on |
Este retorno de chamada é para iniciar o destaque para o bloco de vídeo do participante local. |
| on |
Este retorno de chamada é para parar o destaque para o bloco de vídeo do participante local. |
| on |
Este retorno de chamada é para iniciar o modo de conjunto |
| on |
Este retorno de chamada é para iniciar o destaque para blocos de vídeo de participantes remotos. |
| on |
Este retorno de chamada é para parar o destaque para blocos de vídeo de participantes remotos. |
| on |
Esse retorno de chamada será chamado quando um bloco de vídeo do participante for desfixado. |
| overflow |
Determina o layout da overflowGallery dentro da VideoGallery. |
| pinned |
Lista de userIds participantes fixos. |
| reaction |
Recursos de reação para like, coração, riso, aplausos e surpresa. |
| remote |
Lista de participantes de vídeo remotos |
| remote |
Opções para mostrar o menu de mosaico de vídeo remoto. |
| remote |
Opções de visualização remota de vídeos |
| show |
Se deseja exibir o botão do comutador de câmera de vídeo local |
| show |
Se deseja exibir um ícone de mudo ao lado do nome de exibição do usuário. |
| spotlighted |
Lista de userIds participantes em destaque. |
| start |
Indica se o participante local pode iniciar o modo de conjunto |
| strings | Cadeias de caracteres opcionais a serem substituídas no componente |
| styles | Permite que os usuários passem um objeto contendo estilos CSS personalizados para o contêiner da galeria. |
| together |
Posição sentada dos participantes em modo conjunto |
| together |
Streams de vídeo em modo conjunto |
| video |
Opções adicionais para blocos de vídeo |
Detalhes de Propriedade
dominantSpeakers
Lista de userIds de alto-falantes dominantes na ordem de sua dominância. O índice 0 é o mais dominante.
dominantSpeakers?: string[]Valor de Propriedade
string[]
isTogetherModeActive
Indica se o modo de conjunto está ativo
isTogetherModeActive?: booleanValor de Propriedade
boolean
layout
localParticipant
Vídeo participante local
localParticipant: VideoGalleryLocalParticipantValor de Propriedade
localScreenShareView
Controla a exibição do fluxo de compartilhamento de tela local na galeria
localScreenShareView?: LocalScreenShareViewValor de Propriedade
localVideoCameraCycleButtonProps
Informações de controle da câmera para botão para alternar câmeras.
localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonPropsValor de Propriedade
localVideoTileSize
Determina a proporção do bloco de vídeo local na galeria de vídeos.
localVideoTileSize?: LocalVideoTileSizeValor de Propriedade
Observações
'followDeviceOrientation' responderá à orientação da tela e mudará entre as proporções 9:16 (retrato) e 16:9 (paisagem).
localVideoViewOptions
Opções de visualização de vídeo local
localVideoViewOptions?: VideoStreamOptionsValor de Propriedade
maxParticipantsToSpotlight
Máximo de participantes que podem ser destacados
maxParticipantsToSpotlight?: numberValor de Propriedade
number
maxRemoteVideoStreams
Número máximo de fluxos de vídeo remotos participantes que é renderizado.
maxRemoteVideoStreams?: numberValor de Propriedade
number
onCreateLocalStreamView
Retorno de chamada para criar a visualização do fluxo de vídeo local
onCreateLocalStreamView?: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>Valor de Propriedade
(options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
onCreateRemoteStreamView
Retorno de chamada para criar uma visualização remota de fluxo de vídeo
onCreateRemoteStreamView?: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>Valor de Propriedade
(userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
onCreateTogetherModeStreamView
Retorno de chamada para criar uma exibição de fluxo em modo conjunto
onCreateTogetherModeStreamView?: (options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>Valor de Propriedade
(options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>
onDisposeLocalScreenShareStreamView
Retorno de chamada para descartar uma exibição de fluxo de compartilhamento de tela local
onDisposeLocalScreenShareStreamView?: () => Promise<void>Valor de Propriedade
() => Promise<void>
onDisposeLocalStreamView
Retorno de chamada para eliminar a visualização do fluxo de vídeo local
onDisposeLocalStreamView?: () => voidValor de Propriedade
() => void
onDisposeRemoteScreenShareStreamView
Retorno de chamada para descartar uma exibição de fluxo de compartilhamento de tela remota
onDisposeRemoteScreenShareStreamView?: (userId: string) => Promise<void>Valor de Propriedade
(userId: string) => Promise<void>
onDisposeRemoteStreamView
Aviso
Esta API foi preterida.
use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead
Callback to dispose a remote video stream view
onDisposeRemoteStreamView?: (userId: string) => Promise<void>Valor de Propriedade
(userId: string) => Promise<void>
onDisposeRemoteVideoStreamView
Retorno de chamada para descartar uma visualização remota de fluxo de vídeo
onDisposeRemoteVideoStreamView?: (userId: string) => Promise<void>Valor de Propriedade
(userId: string) => Promise<void>
onDisposeTogetherModeStreamView
Retorno de chamada para descartar uma exibição de fluxo em modo conjunto
onDisposeTogetherModeStreamView?: () => Promise<void>Valor de Propriedade
() => Promise<void>
onForbidAudio
Este retorno de chamada é para proibir áudio para participantes remotos
onForbidAudio?: (userIds: string[]) => Promise<void>Valor de Propriedade
(userIds: string[]) => Promise<void>
onForbidVideo
Este retorno de chamada é para proibir vídeo para participantes remotos
onForbidVideo?: (userIds: string[]) => Promise<void>Valor de Propriedade
(userIds: string[]) => Promise<void>
onMuteParticipant
Este retorno de chamada é para silenciar um participante remoto
onMuteParticipant?: (userId: string) => Promise<void>Valor de Propriedade
(userId: string) => Promise<void>
onPermitAudio
Este retorno de chamada é para permitir áudio para participantes remotos
onPermitAudio?: (userIds: string[]) => Promise<void>Valor de Propriedade
(userIds: string[]) => Promise<void>
onPermitVideo
Este retorno de chamada é para permitir vídeo para participantes remotos
onPermitVideo?: (userIds: string[]) => Promise<void>Valor de Propriedade
(userIds: string[]) => Promise<void>
onPinParticipant
Esse retorno de chamada será chamado quando um bloco de vídeo do participante for fixado.
onPinParticipant?: (userId: string) => voidValor de Propriedade
(userId: string) => void
onRenderAvatar
Retorno de chamada para renderizar um avatar de participante
onRenderAvatar?: OnRenderAvatarCallbackValor de Propriedade
onRenderLocalVideoTile
Retorno de chamada para renderizar o bloco de vídeo local
onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => ElementValor de Propriedade
(localParticipant: VideoGalleryLocalParticipant) => Element
onRenderRemoteVideoTile
Retorno de chamada para renderizar um bloco de vídeo remoto
onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => ElementValor de Propriedade
(remoteParticipant: VideoGalleryRemoteParticipant) => Element
onSetTogetherModeSceneSize
Este retorno de chamada é para definir o tamanho da cena para o modo de conjunto
onSetTogetherModeSceneSize?: (width: number, height: number) => voidValor de Propriedade
(width: number, height: number) => void
onStartLocalSpotlight
Este retorno de chamada é para iniciar o destaque para o bloco de vídeo do participante local.
onStartLocalSpotlight?: () => Promise<void>Valor de Propriedade
() => Promise<void>
onStartRemoteSpotlight
Este retorno de chamada é para parar o destaque para o bloco de vídeo do participante local.
onStartRemoteSpotlight?: (userIds: string[]) => Promise<void>Valor de Propriedade
(userIds: string[]) => Promise<void>
onStartTogetherMode
Este retorno de chamada é para iniciar o modo de conjunto
onStartTogetherMode?: () => Promise<void>Valor de Propriedade
() => Promise<void>
onStopLocalSpotlight
Este retorno de chamada é para iniciar o destaque para blocos de vídeo de participantes remotos.
onStopLocalSpotlight?: () => Promise<void>Valor de Propriedade
() => Promise<void>
onStopRemoteSpotlight
Este retorno de chamada é para parar o destaque para blocos de vídeo de participantes remotos.
onStopRemoteSpotlight?: (userIds: string[]) => Promise<void>Valor de Propriedade
(userIds: string[]) => Promise<void>
onUnpinParticipant
Esse retorno de chamada será chamado quando um bloco de vídeo do participante for desfixado.
onUnpinParticipant?: (userId: string) => voidValor de Propriedade
(userId: string) => void
overflowGalleryPosition
Determina o layout da overflowGallery dentro da VideoGallery.
overflowGalleryPosition?: OverflowGalleryPositionValor de Propriedade
pinnedParticipants
Lista de userIds participantes fixos.
pinnedParticipants?: string[]Valor de Propriedade
string[]
reactionResources
Recursos de reação para like, coração, riso, aplausos e surpresa.
reactionResources?: ReactionResourcesValor de Propriedade
remoteParticipants
Lista de participantes de vídeo remotos
remoteParticipants?: VideoGalleryRemoteParticipant[]Valor de Propriedade
remoteVideoTileMenu
Opções para mostrar o menu de mosaico de vídeo remoto.
remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuPropsValor de Propriedade
remoteVideoViewOptions
Opções de visualização remota de vídeos
remoteVideoViewOptions?: VideoStreamOptionsValor de Propriedade
showCameraSwitcherInLocalPreview
Se deseja exibir o botão do comutador de câmera de vídeo local
showCameraSwitcherInLocalPreview?: booleanValor de Propriedade
boolean
showMuteIndicator
Se deseja exibir um ícone de mudo ao lado do nome de exibição do usuário.
showMuteIndicator?: booleanValor de Propriedade
boolean
spotlightedParticipants
Lista de userIds participantes em destaque.
spotlightedParticipants?: string[]Valor de Propriedade
string[]
startTogetherModeEnabled
Indica se o participante local pode iniciar o modo de conjunto
startTogetherModeEnabled?: booleanValor de Propriedade
boolean
strings
Cadeias de caracteres opcionais a serem substituídas no componente
strings?: Partial<VideoGalleryStrings>Valor de Propriedade
Partial<VideoGalleryStrings>
styles
Permite que os usuários passem um objeto contendo estilos CSS personalizados para o contêiner da galeria.
styles?: VideoGalleryStylesValor de Propriedade
togetherModeSeatingCoordinates
Posição sentada dos participantes em modo conjunto
togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPositionValor de Propriedade
togetherModeStreams
Streams de vídeo em modo conjunto
togetherModeStreams?: VideoGalleryTogetherModeStreamsValor de Propriedade
videoTilesOptions
Opções adicionais para blocos de vídeo
videoTilesOptions?: VideoTilesOptions