VideoGalleryStrings interface

Package:

@azure/communication-react

All strings that may be shown on the UI in the VideoGallery.

Properties

addSpotlightVideoTileMenuLabel	Menu text shown in Video Tile contextual menu to add spotlight to participant's video tile
attendeeRole	String for the attendee role
displayNamePlaceholder	placeholder text for participants who does not have a display name
fillRemoteParticipantFrame	Menu text shown in Video Tile contextual menu for setting a remote participants video to fill the frame
fitRemoteParticipantToFrame	Menu text shown in Video Tile contextual menu for setting a remote participants video to fit in frame
localScreenShareLoadingMessage	String to show when local screen share stream is loading
localVideoCameraSwitcherLabel	String for local video camera switcher
localVideoLabel	String for local video label. Default is "You"
localVideoMovementAriaLabel	Aria-label for announcing the local video tile can be moved by keyboard controls
localVideoMovementLabel	String for announcing the local video tile can be moved by keyboard controls
localVideoSelectedDescription	String for announcing the selected camera
muteParticipantMenuItemLabel	Menu text shown in Video Tile contextual menu to mute a remote participant
pinnedParticipantAnnouncementAriaLabel	Aria label to announce when remote participant's video tile is pinned
pinParticipantForMe	Menu text shown in Video Tile contextual menu for pinning a remote participant's video tile
pinParticipantMenuItemAriaLabel	Aria label for pin participant menu item of remote participant's video tile
screenIsBeingSharedMessage	String to notify that local user is sharing their screen
screenShareLoadingMessage	String to show when remote screen share stream is loading
spotlightLimitReachedMenuTitle	Menu title for start spotlight menu item when spotlight limit is reached
startSpotlightVideoTileMenuLabel	Menu text shown in Video Tile contextual menu to start spotlight on participant's video tile
stopSpotlightOnSelfVideoTileMenuLabel	Menu text shown in Video Tile contextual menu to stop spotlight on local user's video tile
stopSpotlightVideoTileMenuLabel	Menu text shown in Video Tile contextual menu to stop spotlight on participant's video tile
unpinnedParticipantAnnouncementAriaLabel	Aria label to announce when remote participant's video tile is unpinned
unpinParticipantForMe	Menu text shown in Video Tile contextual menu for unpinning a remote participant's video tile
unpinParticipantMenuItemAriaLabel	Aria label for unpin participant menu item of remote participant's video tile
waitingScreenText	Text shown when waiting for others to join the call

Property Details

addSpotlightVideoTileMenuLabel

Menu text shown in Video Tile contextual menu to add spotlight to participant's video tile

addSpotlightVideoTileMenuLabel: string

Property Value

string

attendeeRole

String for the attendee role

attendeeRole: string

Property Value

string

displayNamePlaceholder

placeholder text for participants who does not have a display name

displayNamePlaceholder: string

Property Value

string

fillRemoteParticipantFrame

Menu text shown in Video Tile contextual menu for setting a remote participants video to fill the frame

fillRemoteParticipantFrame: string

Property Value

string

fitRemoteParticipantToFrame

Menu text shown in Video Tile contextual menu for setting a remote participants video to fit in frame

fitRemoteParticipantToFrame: string

Property Value

string

localScreenShareLoadingMessage

String to show when local screen share stream is loading

localScreenShareLoadingMessage: string

Property Value

string

localVideoCameraSwitcherLabel

String for local video camera switcher

localVideoCameraSwitcherLabel: string

Property Value

string

localVideoLabel

String for local video label. Default is "You"

localVideoLabel: string

Property Value

string

localVideoMovementAriaLabel

Aria-label for announcing the local video tile can be moved by keyboard controls

localVideoMovementAriaLabel: string

Property Value

string

localVideoMovementLabel

String for announcing the local video tile can be moved by keyboard controls

localVideoMovementLabel: string

Property Value

string

localVideoSelectedDescription

String for announcing the selected camera

localVideoSelectedDescription: string

Property Value

string

muteParticipantMenuItemLabel

Menu text shown in Video Tile contextual menu to mute a remote participant

muteParticipantMenuItemLabel: string

Property Value

string

pinnedParticipantAnnouncementAriaLabel

Aria label to announce when remote participant's video tile is pinned

pinnedParticipantAnnouncementAriaLabel: string

Property Value

string

pinParticipantForMe

Menu text shown in Video Tile contextual menu for pinning a remote participant's video tile

pinParticipantForMe: string

Property Value

string

pinParticipantMenuItemAriaLabel

Aria label for pin participant menu item of remote participant's video tile

pinParticipantMenuItemAriaLabel: string

Property Value

string

screenIsBeingSharedMessage

String to notify that local user is sharing their screen

screenIsBeingSharedMessage: string

Property Value

string

screenShareLoadingMessage

String to show when remote screen share stream is loading

screenShareLoadingMessage: string

Property Value

string

spotlightLimitReachedMenuTitle

Menu title for start spotlight menu item when spotlight limit is reached

spotlightLimitReachedMenuTitle: string

Property Value

string

startSpotlightVideoTileMenuLabel

Menu text shown in Video Tile contextual menu to start spotlight on participant's video tile

startSpotlightVideoTileMenuLabel: string

Property Value

string

stopSpotlightOnSelfVideoTileMenuLabel

Menu text shown in Video Tile contextual menu to stop spotlight on local user's video tile

stopSpotlightOnSelfVideoTileMenuLabel: string

Property Value

string

stopSpotlightVideoTileMenuLabel

Menu text shown in Video Tile contextual menu to stop spotlight on participant's video tile

stopSpotlightVideoTileMenuLabel: string

Property Value

string

unpinnedParticipantAnnouncementAriaLabel

Aria label to announce when remote participant's video tile is unpinned

unpinnedParticipantAnnouncementAriaLabel: string

Property Value

string

unpinParticipantForMe

Menu text shown in Video Tile contextual menu for unpinning a remote participant's video tile

unpinParticipantForMe: string

Property Value

string

unpinParticipantMenuItemAriaLabel

Aria label for unpin participant menu item of remote participant's video tile

unpinParticipantMenuItemAriaLabel: string

Property Value

string

waitingScreenText

Text shown when waiting for others to join the call

waitingScreenText: string

Property Value

string