VideoGalleryProps interface

Пакет:

@azure/communication-react

Реквизиты для VideoGallery.

Свойства

dominantSpeakers	Список доминирующих пользовательских идентификаторов говорящего в порядке их преобладания. 0-й индекс является самым доминирующим.
isTogetherModeActive	Указывает, активен ли режим «Вместе»
layout	Макет плиток видео.
localParticipant	Локальный видеосекунт
localScreenShareView	Управляет просмотром локального потока демонстрации экрана в галерее
localVideoCameraCycleButtonProps	Сведения об управлении камерой для кнопки для переключения камер.
localVideoTileSize	Определяет соотношение сторон локальной видеоплитки в видеогалерее.
localVideoViewOptions	Параметры просмотра локального видео
maxParticipantsToSpotlight	Максимальное количество участников, которые могут быть выделены
maxRemoteVideoStreams	Максимальное количество отрисовок удаленных видеопотоков участников.
onCreateLocalStreamView	Обратный вызов для создания представления локального видеопотока
onCreateRemoteStreamView	Обратный вызов для создания представления удаленного видеопотока
onCreateTogetherModeStreamView	Обратный вызов для создания представления потока в совместном режиме
onDisposeLocalScreenShareStreamView	Обратный вызов для размещения локального просмотра потока демонстрации экрана
onDisposeLocalStreamView	Обратный вызов для удаления локального представления видеопотока
onDisposeRemoteScreenShareStreamView	Обратный вызов для удаления удаленного просмотра потока демонстрации экрана
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView	Обратный вызов для удаления удаленного представления видеопотока
onDisposeTogetherModeStreamView	Обратный вызов для удаления представления потока в совместном режиме
onForbidAudio	Этот обратный вызов запрещает аудио для удаленных участников.
onForbidVideo	Этот оповещение запрещает видео для удаленных участников.
onMuteParticipant	Этот обратный вызов предназначен для отключения звука удаленного участника
onPermitAudio	Этот обратный вызов предназначен для разрешения звука для удаленных участников
onPermitVideo	Этот обратный вызов предназначен для разрешения видео для удаленных участников
onPinParticipant	Этот обратный вызов будет вызван при закреплении плитки видео участника.
onRenderAvatar	Обратный вызов для рендеринга аватара участника
onRenderLocalVideoTile	Обратный вызов для отрисовки локальной плитки видео
onRenderRemoteVideoTile	Обратный вызов для отрисовки удаленной плитки видео
onSetTogetherModeSceneSize	Этот обратный вызов предназначен для установки размера сцены для совместного режима
onStartLocalSpotlight	Этот обратный вызов предназначен для запуска spotlight для видеоплитки локального участника.
onStartRemoteSpotlight	Этот обратный вызов предназначен для остановки spotlight для видеоплитки локального участника.
onStartTogetherMode	Этот обратный вызов предназначен для запуска совместного режима
onStopLocalSpotlight	Этот обратный вызов предназначен для запуска spotlight для видеоплиток удаленных участников.
onStopRemoteSpotlight	Этот обратный вызов предназначен для остановки spotlight для видеоплиток удаленных участников.
onUnpinParticipant	Этот обратный вызов будет вызван, когда плитка видео участника будет откреплена.
overflowGalleryPosition	Определяет макет overflowGallery внутри VideoGallery.
pinnedParticipants	Список закрепленных идентификаторов userId.
reactionResources	Ресурсы реакции для лайка, сердца, смеха, аплодисментов и удивления.
remoteParticipants	Список удаленных видеочастиц
remoteVideoTileMenu	Параметры отображения меню удаленной плитки видео.
remoteVideoViewOptions	Параметры просмотра удаленных видео
showCameraSwitcherInLocalPreview	Отображение кнопки переключателя локальной видеокамеры
showMuteIndicator	Отображается ли значок отключения звука рядом с отображаемого имени пользователя.
spotlightedParticipants	Список выделенных идентификаторов пользователей.
startTogetherModeEnabled	Указывает, может ли локальный участник начать совместный режим
strings	Необязательные строки для переопределения в компоненте
styles	Позволяет пользователям передавать объект, содержащий пользовательские стили CSS для контейнера коллекции.
togetherModeSeatingCoordinates	Сидячее положение участников в режиме «вместе»
togetherModeStreams	Видеопотоки в режиме «Вместе»
videoTilesOptions	Дополнительные опции для видеоплиток

Сведения о свойстве

dominantSpeakers

Список доминирующих пользовательских идентификаторов говорящего в порядке их преобладания. 0-й индекс является самым доминирующим.

dominantSpeakers?: string[]

Значение свойства

string[]

isTogetherModeActive

Указывает, активен ли режим «Вместе»

isTogetherModeActive?: boolean

Значение свойства

boolean

layout

Макет плиток видео.

layout?: VideoGalleryLayout

Значение свойства

VideoGalleryLayout

localParticipant

Локальный видеосекунт

localParticipant: VideoGalleryLocalParticipant

Значение свойства

VideoGalleryLocalParticipant

localScreenShareView

Управляет просмотром локального потока демонстрации экрана в галерее

localScreenShareView?: LocalScreenShareView

Значение свойства

LocalScreenShareView

localVideoCameraCycleButtonProps

Сведения об управлении камерой для кнопки для переключения камер.

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

Значение свойства

LocalVideoCameraCycleButtonProps

localVideoTileSize

Определяет соотношение сторон локальной видеоплитки в видеогалерее.

localVideoTileSize?: LocalVideoTileSize

Значение свойства

LocalVideoTileSize

Комментарии

'followDeviceOrientation' будет реагировать на ориентацию экрана и будет изменяться между соотношением сторон 9:16 (книжная) и 16:9 (альбомная).

localVideoViewOptions

Параметры просмотра локального видео

localVideoViewOptions?: VideoStreamOptions

Значение свойства

VideoStreamOptions

maxParticipantsToSpotlight

Максимальное количество участников, которые могут быть выделены

maxParticipantsToSpotlight?: number

Значение свойства

number

maxRemoteVideoStreams

Максимальное количество отрисовок удаленных видеопотоков участников.

maxRemoteVideoStreams?: number

Значение свойства

number

onCreateLocalStreamView

Обратный вызов для создания представления локального видеопотока

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

Значение свойства

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

onCreateRemoteStreamView

Обратный вызов для создания представления удаленного видеопотока

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

Значение свойства

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

onCreateTogetherModeStreamView

Обратный вызов для создания представления потока в совместном режиме

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

Значение свойства

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

onDisposeLocalScreenShareStreamView

Обратный вызов для размещения локального просмотра потока демонстрации экрана

onDisposeLocalScreenShareStreamView?: () => Promise<void>

Значение свойства

() => Promise<void>

onDisposeLocalStreamView

Обратный вызов для удаления локального представления видеопотока

onDisposeLocalStreamView?: () => void

Значение свойства

() => void

onDisposeRemoteScreenShareStreamView

Обратный вызов для удаления удаленного просмотра потока демонстрации экрана

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

Значение свойства

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Предупреждение

Теперь этот API является нерекомендуемым.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead

Callback to dispose a remote video stream view

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

Значение свойства

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

Обратный вызов для удаления удаленного представления видеопотока

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

Значение свойства

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Обратный вызов для удаления представления потока в совместном режиме

onDisposeTogetherModeStreamView?: () => Promise<void>

Значение свойства

() => Promise<void>

onForbidAudio

Этот обратный вызов запрещает аудио для удаленных участников.

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

Значение свойства

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

onForbidVideo

Этот оповещение запрещает видео для удаленных участников.

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

Значение свойства

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

onMuteParticipant

Этот обратный вызов предназначен для отключения звука удаленного участника

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

Значение свойства

(userId: string) => Promise<void>

onPermitAudio

Этот обратный вызов предназначен для разрешения звука для удаленных участников

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

Значение свойства

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

onPermitVideo

Этот обратный вызов предназначен для разрешения видео для удаленных участников

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

Значение свойства

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

onPinParticipant

Этот обратный вызов будет вызван при закреплении плитки видео участника.

onPinParticipant?: (userId: string) => void

Значение свойства

(userId: string) => void

onRenderAvatar

Обратный вызов для рендеринга аватара участника

onRenderAvatar?: OnRenderAvatarCallback

Значение свойства

OnRenderAvatarCallback

onRenderLocalVideoTile

Обратный вызов для отрисовки локальной плитки видео

onRenderLocalVideoTile?: (localParticipant: VideoGalleryLocalParticipant) => Element

Значение свойства

(localParticipant: VideoGalleryLocalParticipant) => Element

onRenderRemoteVideoTile

Обратный вызов для отрисовки удаленной плитки видео

onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element

Значение свойства

(remoteParticipant: VideoGalleryRemoteParticipant) => Element

onSetTogetherModeSceneSize

Этот обратный вызов предназначен для установки размера сцены для совместного режима

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

Значение свойства

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

onStartLocalSpotlight

Этот обратный вызов предназначен для запуска spotlight для видеоплитки локального участника.

onStartLocalSpotlight?: () => Promise<void>

Значение свойства

() => Promise<void>

onStartRemoteSpotlight

Этот обратный вызов предназначен для остановки spotlight для видеоплитки локального участника.

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

Значение свойства

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

onStartTogetherMode

Этот обратный вызов предназначен для запуска совместного режима

onStartTogetherMode?: () => Promise<void>

Значение свойства

() => Promise<void>

onStopLocalSpotlight

Этот обратный вызов предназначен для запуска spotlight для видеоплиток удаленных участников.

onStopLocalSpotlight?: () => Promise<void>

Значение свойства

() => Promise<void>

onStopRemoteSpotlight

Этот обратный вызов предназначен для остановки spotlight для видеоплиток удаленных участников.

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

Значение свойства

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

onUnpinParticipant

Этот обратный вызов будет вызван, когда плитка видео участника будет откреплена.

onUnpinParticipant?: (userId: string) => void

Значение свойства

(userId: string) => void

overflowGalleryPosition

Определяет макет overflowGallery внутри VideoGallery.

overflowGalleryPosition?: OverflowGalleryPosition

Значение свойства

OverflowGalleryPosition

pinnedParticipants

Список закрепленных идентификаторов userId.

pinnedParticipants?: string[]

Значение свойства

string[]

reactionResources

Ресурсы реакции для лайка, сердца, смеха, аплодисментов и удивления.

reactionResources?: ReactionResources

Значение свойства

ReactionResources

remoteParticipants

Список удаленных видеочастиц

remoteParticipants?: VideoGalleryRemoteParticipant[]

Значение свойства

VideoGalleryRemoteParticipant[]

remoteVideoTileMenu

Параметры отображения меню удаленной плитки видео.

remoteVideoTileMenu?: false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

Значение свойства

false | VideoTileContextualMenuProps | VideoTileDrawerMenuProps

remoteVideoViewOptions

Параметры просмотра удаленных видео

remoteVideoViewOptions?: VideoStreamOptions

Значение свойства

VideoStreamOptions

showCameraSwitcherInLocalPreview

Отображение кнопки переключателя локальной видеокамеры

showCameraSwitcherInLocalPreview?: boolean

Значение свойства

boolean

showMuteIndicator

Отображается ли значок отключения звука рядом с отображаемого имени пользователя.

showMuteIndicator?: boolean

Значение свойства

boolean

spotlightedParticipants

Список выделенных идентификаторов пользователей.

spotlightedParticipants?: string[]

Значение свойства

string[]

startTogetherModeEnabled

Указывает, может ли локальный участник начать совместный режим

startTogetherModeEnabled?: boolean

Значение свойства

boolean

strings

Необязательные строки для переопределения в компоненте

strings?: Partial<VideoGalleryStrings>

Значение свойства

Partial<VideoGalleryStrings>

styles

Позволяет пользователям передавать объект, содержащий пользовательские стили CSS для контейнера коллекции.

styles?: VideoGalleryStyles

Значение свойства

VideoGalleryStyles

togetherModeSeatingCoordinates

Сидячее положение участников в режиме «вместе»

togetherModeSeatingCoordinates?: VideoGalleryTogetherModeParticipantPosition

Значение свойства

VideoGalleryTogetherModeParticipantPosition

togetherModeStreams

Видеопотоки в режиме «Вместе»

togetherModeStreams?: VideoGalleryTogetherModeStreams

Значение свойства

VideoGalleryTogetherModeStreams

videoTilesOptions

Дополнительные опции для видеоплиток

videoTilesOptions?: VideoTilesOptions

Значение свойства

VideoTilesOptions