VideoGalleryProps interface

Balíček:: @azure/communication-react

Vlastnosti

dominantSpeakers	Seznam id uživatele dominantního mluvčího v pořadí jejich dominantního postavení. 0. index je nejvíce dominantní.
isTogetherModeActive	Označuje, zda je aktivní režim společně
layout	Rozložení dlaždic videa
localParticipant	Místní video particpant
localScreenShareView	Řídí zobrazení místního streamu sdílení obrazovky v galerii
localVideoCameraCycleButtonProps	Informace o ovládacím prvku kamery pro tlačítko pro přepínání fotoaparátů.
localVideoTileSize	Určuje poměr stran místní dlaždice videa v galerii videa.
localVideoViewOptions	Možnosti místního zobrazení videa
maxParticipantsToSpotlight	Maximální počet účastníků, kteří mohou být zvýrazněni
maxRemoteVideoStreams	Maximální počet vzdálených datových proudů videa účastníka, které se vykreslují.
onCreateLocalStreamView	Zpětné volání pro vytvoření místního zobrazení streamu videa
onCreateRemoteStreamView	Zpětné volání pro vytvoření vzdáleného zobrazení streamu videa
onCreateTogetherModeStreamView	Zpětné volání pro vytvoření zobrazení datového proudu v režimu Společně
onDisposeLocalScreenShareStreamView	Zpětné volání pro uvolnění zobrazení streamu místní sdílené obrazovky
onDisposeLocalStreamView	Zpětné volání pro odstranění zobrazení místního streamu videa
onDisposeRemoteScreenShareStreamView	Zpětné volání pro uvolnění vzdáleného zobrazení streamu sdílené obrazovky
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView	Zpětné volání pro odstranění vzdáleného zobrazení streamu videa
onDisposeTogetherModeStreamView	Zpětné volání pro uvolnění zobrazení datového proudu v režimu společně
onForbidAudio	Toto zpětné volání má zakázat zvuk pro vzdáleného účastníka (účastníky)
onForbidVideo	Toto zpětné volání má zakázat video vzdáleným účastníkům
onMuteParticipant	Toto zpětné volání slouží ke ztlumení vzdáleného účastníka
onPermitAudio	Toto zpětné volání slouží k povolení zvuku pro vzdálené účastníky.
onPermitVideo	Toto zpětné volání slouží k povolení videa pro vzdálené účastníky.
onPinParticipant	Toto zpětné volání bude voláno při připnutí dlaždice videa účastníka.
onRenderAvatar	Zpětné volání pro vykreslení avatara účastníka
onRenderLocalVideoTile	Zpětné volání pro vykreslení místní dlaždice videa
onRenderRemoteVideoTile	Zpětné volání pro vykreslení dlaždice vzdáleného videa
onSetTogetherModeSceneSize	Toto zpětné volání slouží k nastavení velikosti scény pro režim together
onStartLocalSpotlight	Toto zpětné volání slouží ke spuštění zvýraznění dlaždice videa místního účastníka.
onStartRemoteSpotlight	Toto zpětné volání slouží k zastavení pozornosti pro dlaždici videa místního účastníka.
onStartTogetherMode	Toto zpětné volání slouží ke spuštění v režimu společného
onStopLocalSpotlight	Toto zpětné volání slouží ke spuštění spotlightu pro dlaždice videa vzdáleného účastníka.
onStopRemoteSpotlight	Toto zpětné volání slouží k zastavení zvýraznění dlaždic videa vzdáleného účastníka.
onUnpinParticipant	Toto zpětné volání bude voláno, když je dlaždice videa účastníka odepnuta.
overflowGalleryPosition	Určuje rozvržení objektu overflowGallery uvnitř VideoGallery.
pinnedParticipants	Seznam připnutých ID uživatelů účastníků.
reactionResources	Reakční zdroje pro lajk, srdce, smích, potlesk a překvapení.
remoteParticipants	Seznam particpantů pro vzdálené video
remoteVideoTileMenu	Možnosti pro zobrazení nabídky dlaždice vzdáleného videa.
remoteVideoViewOptions	Možnosti zobrazení vzdálených videí
showCameraSwitcherInLocalPreview	Zda se má zobrazit tlačítko přepínače místní kamery videa
showMuteIndicator	Určuje, jestli se má vedle zobrazovaného jména uživatele zobrazit ikona ztlumení.
spotlightedParticipants	Seznam zvýrazněných ID uživatelů účastníků.
startTogetherModeEnabled	Označuje, zda může místní účastník spustit společný režim
strings	Volitelné řetězce, které se mají přepsat v komponentě
styles	Umožňuje uživatelům předat objekt obsahující vlastní styly CSS pro kontejner galerie.
togetherModeSeatingCoordinates	Poloha sedadel účastníků v režimu společně
togetherModeStreams	Streamy videa v režimu Společně
videoTilesOptions	Další možnosti pro dlaždice videa

Podrobnosti vlastnosti

dominantSpeakers

Seznam id uživatele dominantního mluvčího v pořadí jejich dominantního postavení. 0. index je nejvíce dominantní.

dominantSpeakers?: string[]

Hodnota vlastnosti

string[]

isTogetherModeActive

Označuje, zda je aktivní režim společně

isTogetherModeActive?: boolean

Hodnota vlastnosti

boolean

layout

Rozložení dlaždic videa

layout?: VideoGalleryLayout

Hodnota vlastnosti

VideoGalleryLayout

localParticipant

Místní video particpant

localParticipant: VideoGalleryLocalParticipant

Hodnota vlastnosti

VideoGalleryLocalParticipant

localScreenShareView

Řídí zobrazení místního streamu sdílení obrazovky v galerii

localScreenShareView?: LocalScreenShareView

Hodnota vlastnosti

LocalScreenShareView

localVideoCameraCycleButtonProps

Informace o ovládacím prvku kamery pro tlačítko pro přepínání fotoaparátů.

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

Hodnota vlastnosti

LocalVideoCameraCycleButtonProps

localVideoTileSize

Určuje poměr stran místní dlaždice videa v galerii videa.

localVideoTileSize?: LocalVideoTileSize

Hodnota vlastnosti

LocalVideoTileSize

Poznámky

Příkaz "followDeviceOrientation" bude reagovat na orientaci obrazovky a bude se měnit v poměru stran 9:16 (na výšku) a 16:9 (na šířku).

localVideoViewOptions

Možnosti místního zobrazení videa

localVideoViewOptions?: VideoStreamOptions

Hodnota vlastnosti

VideoStreamOptions

maxParticipantsToSpotlight

Maximální počet účastníků, kteří mohou být zvýrazněni

maxParticipantsToSpotlight?: number

Hodnota vlastnosti

number

maxRemoteVideoStreams

Maximální počet vzdálených datových proudů videa účastníka, které se vykreslují.

maxRemoteVideoStreams?: number

Hodnota vlastnosti

number

onCreateLocalStreamView

Zpětné volání pro vytvoření místního zobrazení streamu videa

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

Hodnota vlastnosti

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

onCreateRemoteStreamView

Zpětné volání pro vytvoření vzdáleného zobrazení streamu videa

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

Hodnota vlastnosti

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

onCreateTogetherModeStreamView

Zpětné volání pro vytvoření zobrazení datového proudu v režimu Společně

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

Hodnota vlastnosti

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

onDisposeLocalScreenShareStreamView

Zpětné volání pro uvolnění zobrazení streamu místní sdílené obrazovky

onDisposeLocalScreenShareStreamView?: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onDisposeLocalStreamView

Zpětné volání pro odstranění zobrazení místního streamu videa

onDisposeLocalStreamView?: () => void

Hodnota vlastnosti

() => void

onDisposeRemoteScreenShareStreamView

Zpětné volání pro uvolnění vzdáleného zobrazení streamu sdílené obrazovky

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

Hodnota vlastnosti

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Upozornění

Toto rozhraní API je teď zastaralé.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead

Callback to dispose a remote video stream view

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

Hodnota vlastnosti

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

Zpětné volání pro odstranění vzdáleného zobrazení streamu videa

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

Hodnota vlastnosti

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Zpětné volání pro uvolnění zobrazení datového proudu v režimu společně

onDisposeTogetherModeStreamView?: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onForbidAudio

Toto zpětné volání má zakázat zvuk pro vzdáleného účastníka (účastníky)

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

Hodnota vlastnosti

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

onForbidVideo

Toto zpětné volání má zakázat video vzdáleným účastníkům

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

Hodnota vlastnosti

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

onMuteParticipant

Toto zpětné volání slouží ke ztlumení vzdáleného účastníka

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

Hodnota vlastnosti

(userId: string) => Promise<void>

onPermitAudio

Toto zpětné volání slouží k povolení zvuku pro vzdálené účastníky.

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

Hodnota vlastnosti

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

onPermitVideo

Toto zpětné volání slouží k povolení videa pro vzdálené účastníky.

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

Hodnota vlastnosti

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

onPinParticipant

Toto zpětné volání bude voláno při připnutí dlaždice videa účastníka.

onPinParticipant?: (userId: string) => void

Hodnota vlastnosti

(userId: string) => void

onRenderAvatar

Zpětné volání pro vykreslení avatara účastníka

onRenderAvatar?: OnRenderAvatarCallback

Hodnota vlastnosti

OnRenderAvatarCallback

onRenderLocalVideoTile

Zpětné volání pro vykreslení místní dlaždice videa

onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => Element

Hodnota vlastnosti

(localParticipant: VideoGalleryLocalParticipant) => Element

onRenderRemoteVideoTile

Zpětné volání pro vykreslení dlaždice vzdáleného videa

onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element

Hodnota vlastnosti

(remoteParticipant: VideoGalleryRemoteParticipant) => Element

onSetTogetherModeSceneSize

Toto zpětné volání slouží k nastavení velikosti scény pro režim together

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

Hodnota vlastnosti

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

onStartLocalSpotlight

Toto zpětné volání slouží ke spuštění zvýraznění dlaždice videa místního účastníka.

onStartLocalSpotlight?: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStartRemoteSpotlight

Toto zpětné volání slouží k zastavení pozornosti pro dlaždici videa místního účastníka.

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

Hodnota vlastnosti

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

onStartTogetherMode

Toto zpětné volání slouží ke spuštění v režimu společného

onStartTogetherMode?: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStopLocalSpotlight

Toto zpětné volání slouží ke spuštění spotlightu pro dlaždice videa vzdáleného účastníka.

onStopLocalSpotlight?: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStopRemoteSpotlight

Toto zpětné volání slouží k zastavení zvýraznění dlaždic videa vzdáleného účastníka.

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

Hodnota vlastnosti

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

onUnpinParticipant

Toto zpětné volání bude voláno, když je dlaždice videa účastníka odepnuta.

onUnpinParticipant?: (userId: string) => void

Hodnota vlastnosti

(userId: string) => void

overflowGalleryPosition

Určuje rozvržení objektu overflowGallery uvnitř VideoGallery.

overflowGalleryPosition?: OverflowGalleryPosition

Hodnota vlastnosti

OverflowGalleryPosition

pinnedParticipants

Seznam připnutých ID uživatelů účastníků.

pinnedParticipants?: string[]

Hodnota vlastnosti

string[]

reactionResources

Reakční zdroje pro lajk, srdce, smích, potlesk a překvapení.

reactionResources?: ReactionResources

Hodnota vlastnosti

ReactionResources

remoteParticipants

Seznam particpantů pro vzdálené video

remoteParticipants?: VideoGalleryRemoteParticipant[]

Hodnota vlastnosti

VideoGalleryRemoteParticipant[]

remoteVideoTileMenu

Možnosti pro zobrazení nabídky dlaždice vzdáleného videa.

remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

Hodnota vlastnosti

false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

remoteVideoViewOptions

Možnosti zobrazení vzdálených videí

remoteVideoViewOptions?: VideoStreamOptions

Hodnota vlastnosti

VideoStreamOptions

showCameraSwitcherInLocalPreview

Zda se má zobrazit tlačítko přepínače místní kamery videa

showCameraSwitcherInLocalPreview?: boolean

Hodnota vlastnosti

boolean

showMuteIndicator

Určuje, jestli se má vedle zobrazovaného jména uživatele zobrazit ikona ztlumení.

showMuteIndicator?: boolean

Hodnota vlastnosti

boolean

spotlightedParticipants

Seznam zvýrazněných ID uživatelů účastníků.

spotlightedParticipants?: string[]

Hodnota vlastnosti

string[]

startTogetherModeEnabled

Označuje, zda může místní účastník spustit společný režim

startTogetherModeEnabled?: boolean

Hodnota vlastnosti

boolean

strings

Volitelné řetězce, které se mají přepsat v komponentě

strings?: Partial<VideoGalleryStrings>

Hodnota vlastnosti

Partial<VideoGalleryStrings>

styles

Umožňuje uživatelům předat objekt obsahující vlastní styly CSS pro kontejner galerie.

styles?: VideoGalleryStyles

Hodnota vlastnosti

VideoGalleryStyles

togetherModeSeatingCoordinates

Poloha sedadel účastníků v režimu společně

togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition

Hodnota vlastnosti

VideoGalleryTogetherModeParticipantPosition

togetherModeStreams

Streamy videa v režimu Společně

togetherModeStreams?: VideoGalleryTogetherModeStreams

Hodnota vlastnosti

VideoGalleryTogetherModeStreams

videoTilesOptions

Další možnosti pro dlaždice videa

videoTilesOptions?: VideoTilesOptions

Hodnota vlastnosti

VideoTilesOptions