VideoGalleryProps interface

  • Reference
Package:
@azure/communication-react

Props for VideoGallery.

Properties

dominantSpeakers

List of dominant speaker userIds in the order of their dominance. 0th index is the most dominant.
layout

Layout of the video tiles.
localParticipant

Local video particpant
localVideoCameraCycleButtonProps

Camera control information for button to switch cameras.
localVideoViewOptions

Local video view options
maxRemoteVideoStreams

Maximum number of participant remote video streams that is rendered.
onCreateLocalStreamView

Callback to create the local video stream view
onCreateRemoteStreamView

Callback to create a remote video stream view
onDisposeLocalStreamView

Callback to dispose of the local video stream view
onDisposeRemoteStreamView

Callback to dispose a remote video stream view
onRenderAvatar

Callback to render a particpant avatar
onRenderLocalVideoTile

Callback to render the local video tile
onRenderRemoteVideoTile

Callback to render a remote video tile
remoteParticipants

List of remote video particpants
remoteVideoViewOptions

Remote videos view options
showCameraSwitcherInLocalPreview

Whether to display the local video camera switcher button
showMuteIndicator

Whether to display a mute icon beside the user's display name.
strings

Optional strings to override in component
styles

Allows users to pass an object containing custom CSS styles for the gallery container.

Property Details

dominantSpeakers

List of dominant speaker userIds in the order of their dominance. 0th index is the most dominant.

dominantSpeakers?: string[]

Property Value

string[]

layout

Layout of the video tiles.

layout?: VideoGalleryLayout

Property Value

VideoGalleryLayout

localParticipant

Local video particpant

localParticipant: VideoGalleryParticipant

Property Value

VideoGalleryParticipant

localVideoCameraCycleButtonProps

Camera control information for button to switch cameras.

localVideoCameraCycleButtonProps?: LocalVideoCameraCycleButtonProps

Property Value

LocalVideoCameraCycleButtonProps

localVideoViewOptions

Local video view options

localVideoViewOptions?: VideoStreamOptions

Property Value

VideoStreamOptions

maxRemoteVideoStreams

Maximum number of participant remote video streams that is rendered.

maxRemoteVideoStreams?: number

Property Value

number

onCreateLocalStreamView

Callback to create the local video stream view

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

Property Value

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

onCreateRemoteStreamView

Callback to create a remote video stream view

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

Property Value

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

onDisposeLocalStreamView

Callback to dispose of the local video stream view

onDisposeLocalStreamView?: () => void

Property Value

() => void

onDisposeRemoteStreamView

Callback to dispose a remote video stream view

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

Property Value

(userId: string) => Promise<void>

onRenderAvatar

Callback to render a particpant avatar

onRenderAvatar?: OnRenderAvatarCallback

Property Value

OnRenderAvatarCallback

onRenderLocalVideoTile

Callback to render the local video tile

onRenderLocalVideoTile?: (localParticipant: VideoGalleryParticipant) => Element

Property Value

(localParticipant: VideoGalleryParticipant) => Element

onRenderRemoteVideoTile

Callback to render a remote video tile

onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => Element

Property Value

(remoteParticipant: VideoGalleryRemoteParticipant) => Element

remoteParticipants

List of remote video particpants

remoteParticipants?: VideoGalleryRemoteParticipant[]

Property Value

VideoGalleryRemoteParticipant[]

remoteVideoViewOptions

Remote videos view options

remoteVideoViewOptions?: VideoStreamOptions

Property Value

VideoStreamOptions

showCameraSwitcherInLocalPreview

Whether to display the local video camera switcher button

showCameraSwitcherInLocalPreview?: boolean

Property Value

boolean

showMuteIndicator

Whether to display a mute icon beside the user's display name.

showMuteIndicator?: boolean

Property Value

boolean

strings

Optional strings to override in component

strings?: Partial<VideoGalleryStrings>

Property Value

Partial<VideoGalleryStrings>

styles

Allows users to pass an object containing custom CSS styles for the gallery container.

styles?: VideoGalleryStyles

Property Value

VideoGalleryStyles