VideoGalleryProps interface

패키지:

@azure/communication-react

VideoGallery대한 소품입니다.

속성

dominantSpeakers	지배적 인 스피커 userIds의 지배 순서의 목록입니다. 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	이 콜백은 로컬 참가자 비디오 타일에 대한 스포트라이트를 시작하기 위한 것입니다.
onStartRemoteSpotlight	이 콜백은 로컬 참가자 비디오 타일에 대한 스포트라이트를 중지하기 위한 것입니다.
onStartTogetherMode	이 콜백은 함께 모드를 시작하기 위한 것입니다.
onStopLocalSpotlight	이 콜백은 원격 참가자 비디오 타일에 대한 스포트라이트를 시작하기 위한 것입니다.
onStopRemoteSpotlight	이 콜백은 원격 참가자 비디오 타일에 대한 스포트라이트를 중지하기 위한 것입니다.
onUnpinParticipant	이 콜백은 참가자 비디오 타일의 고정이 해제될 때 호출됩니다.
overflowGalleryPosition	VideoGallery 내부의 overflowGallery 레이아웃을 결정합니다.
pinnedParticipants	고정된 참가자 userId의 목록입니다.
reactionResources	좋아요, 마음, 웃음, 박수 및 놀라움에 대한 반응 리소스.
remoteParticipants	원격 비디오 미립자 목록
remoteVideoTileMenu	원격 비디오 타일 메뉴를 표시하기 위한 옵션입니다.
remoteVideoViewOptions	원격 비디오 보기 옵션
showCameraSwitcherInLocalPreview	로컬 비디오 카메라 스위처 단추를 표시할지 여부
showMuteIndicator	사용자의 표시 이름 옆에 음소거 아이콘을 표시할지 여부입니다.
spotlightedParticipants	스포트라이트된 참가자 userId의 목록입니다.
startTogetherModeEnabled	로컬 참가자가 함께 모드를 시작할 수 있는지 여부를 나타냅니다
strings	구성 요소에서 재정의할 선택적 문자열
styles	사용자가 갤러리 컨테이너에 대한 사용자 지정 CSS 스타일이 포함된 개체를 전달할 수 있습니다.
togetherModeSeatingCoordinates	함께 모드에서 참가자의 좌석 위치
togetherModeStreams	함께 모드 비디오 스트림
videoTilesOptions	비디오 타일에 대한 추가 옵션

속성 세부 정보

dominantSpeakers

지배적 인 스피커 userIds의 지배 순서의 목록입니다. 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

이 콜백은 로컬 참가자 비디오 타일에 대한 스포트라이트를 시작하기 위한 것입니다.

onStartLocalSpotlight?: () => Promise<void>

속성 값

() => Promise<void>

onStartRemoteSpotlight

이 콜백은 로컬 참가자 비디오 타일에 대한 스포트라이트를 중지하기 위한 것입니다.

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

속성 값

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

onStartTogetherMode

이 콜백은 함께 모드를 시작하기 위한 것입니다.

onStartTogetherMode?: () => Promise<void>

속성 값

() => Promise<void>

onStopLocalSpotlight

이 콜백은 원격 참가자 비디오 타일에 대한 스포트라이트를 시작하기 위한 것입니다.

onStopLocalSpotlight?: () => Promise<void>

속성 값

() => Promise<void>

onStopRemoteSpotlight

이 콜백은 원격 참가자 비디오 타일에 대한 스포트라이트를 중지하기 위한 것입니다.

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

속성 값

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

onUnpinParticipant

이 콜백은 참가자 비디오 타일의 고정이 해제될 때 호출됩니다.

onUnpinParticipant?: (userId: string) => void

속성 값

(userId: string) => void

overflowGalleryPosition

VideoGallery 내부의 overflowGallery 레이아웃을 결정합니다.

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

스포트라이트된 참가자 userId의 목록입니다.

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