VideoTileProps interface

Paket:

@azure/communication-react

Alat peraga untuk VideoTile.

Properti

alwaysShowLabelBackground	Tampilkan latar belakang label pada VideoTile
children	Komponen React Child. Komponen Anak akan ditampilkan sebagai komponen overlay di VideoTile.
contextualMenu	Tampilkan item menu kustom di menu kontekstual VideoTile. Menggunakan Fluent UI ContextualMenu. Ikon elipsis akan ditampilkan untuk membuka menu kontekstual jika prop ini ditentukan.
displayName	Tampilkan Nama Peserta yang akan diperlihatkan dalam label.
initialsName	Nama peserta yang digunakan untuk menghasilkan inisial. Misalnya, nama John Doe akan ditampilkan JD sebagai inisial.
isMirrored	Menentukan apakah video dicerminkan atau tidak.
isMuted	Apakah video dibisukan atau tidak.
isPinned	Jika benar, ubin video akan menampilkan ikon pin.
isSpeaking	Apakah peserta dalam videoTile berbicara. Memperlihatkan indikator berbicara (batas).
isSpotlighted	Jika benar, ubin video akan menampilkan ikon yang disorot.
mediaAccess	Status akses media peserta.
noVideoAvailableAriaLabel	Properti opsional untuk mengatur label aria petak peta video jika tidak ada aliran yang tersedia.
onLongTouch	Callback dipicu oleh petak peta video saat disentuh dan ditahan.
onRenderPlaceholder	Fungsi Komponen render kustom untuk tidak ada video yang tersedia. Merender Ikon Persona jika tidak ditentukan.
overlay	Komponen overlay yang bertanggung jawab untuk merender reaksi
participantState	Status koneksi panggilan peserta. Misalnya, Hold berarti peserta ditahan.
personaMaxSize	Ukuran maksimum avatar pribadi dalam px. Avatar persona adalah tempat penampung default yang ditampilkan ketika tidak ada streaming video yang tersedia. Untuk informasi selengkapnya, lihat https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
personaMinSize	Ukuran minimum avatar persona dalam px. Avatar persona adalah tempat penampung default yang ditampilkan ketika tidak ada streaming video yang tersedia. Untuk informasi selengkapnya, lihat https://developer.microsoft.com/en-us/fluentui#/controls/web/persona
raisedHand	Apakah peserta mengangkat tangan. Menampilkan indikator (batas) dan ikon dengan pesanan
reactionResources	URL dan metadata sumber daya reaksi.
renderElement	Komponen dengan aliran video.
showLabel	Tampilkan label pada VideoTile
showMuteIndicator	Apakah akan menampilkan ikon bisukan di samping nama tampilan pengguna.
strings	String untuk diganti dalam komponen.
styles	Memungkinkan pengguna untuk meneruskan objek berisi gaya CSS kustom.
userId	id pengguna untuk tempat penampung VideoTile.

Detail Properti

alwaysShowLabelBackground

Tampilkan latar belakang label pada VideoTile

alwaysShowLabelBackground?: boolean

Nilai Properti

boolean

children

Komponen React Child. Komponen Anak akan ditampilkan sebagai komponen overlay di VideoTile.

children?: ReactNode

Nilai Properti

ReactNode

contextualMenu

Tampilkan item menu kustom di menu kontekstual VideoTile. Menggunakan Fluent UI ContextualMenu. Ikon elipsis akan ditampilkan untuk membuka menu kontekstual jika prop ini ditentukan.

contextualMenu?: IContextualMenuProps

Nilai Properti

IContextualMenuProps

displayName

Tampilkan Nama Peserta yang akan diperlihatkan dalam label.

displayName?: string

Nilai Properti

string

Keterangan

displayName digunakan untuk menghasilkan inisial avatar jika initialsName tidak disediakan.

initialsName

Nama peserta yang digunakan untuk menghasilkan inisial. Misalnya, nama John Doe akan ditampilkan JD sebagai inisial.

initialsName?: string

Nilai Properti

string

Keterangan

displayName digunakan jika properti ini tidak ditentukan.

isMirrored

Menentukan apakah video dicerminkan atau tidak.

isMirrored?: boolean

Nilai Properti

boolean

isMuted

Apakah video dibisukan atau tidak.

isMuted?: boolean

Nilai Properti

boolean

isPinned

Jika benar, ubin video akan menampilkan ikon pin.

isPinned?: boolean

Nilai Properti

boolean

isSpeaking

Apakah peserta dalam videoTile berbicara. Memperlihatkan indikator berbicara (batas).

isSpeaking?: boolean

Nilai Properti

boolean

isSpotlighted

Jika benar, ubin video akan menampilkan ikon yang disorot.

isSpotlighted?: boolean

Nilai Properti

boolean

mediaAccess

Status akses media peserta.

mediaAccess?: MediaAccess

Nilai Properti

MediaAccess

noVideoAvailableAriaLabel

Properti opsional untuk mengatur label aria petak peta video jika tidak ada aliran yang tersedia.

noVideoAvailableAriaLabel?: string

Nilai Properti

string

onLongTouch

Callback dipicu oleh petak peta video saat disentuh dan ditahan.

onLongTouch?: () => void

Nilai Properti

() => void

onRenderPlaceholder

Fungsi Komponen render kustom untuk tidak ada video yang tersedia. Merender Ikon Persona jika tidak ditentukan.

onRenderPlaceholder?: OnRenderAvatarCallback

Nilai Properti

OnRenderAvatarCallback

overlay

Komponen overlay yang bertanggung jawab untuk merender reaksi

overlay?: null | Element

Nilai Properti

null | Element

participantState

Status koneksi panggilan peserta. Misalnya, Hold berarti peserta ditahan.

participantState?: ParticipantState

Nilai Properti

ParticipantState

personaMaxSize

Ukuran maksimum avatar pribadi dalam px. Avatar persona adalah tempat penampung default yang ditampilkan ketika tidak ada streaming video yang tersedia. Untuk informasi selengkapnya, lihat https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMaxSize?: number

Nilai Properti

number

personaMinSize

Ukuran minimum avatar persona dalam px. Avatar persona adalah tempat penampung default yang ditampilkan ketika tidak ada streaming video yang tersedia. Untuk informasi selengkapnya, lihat https://developer.microsoft.com/en-us/fluentui#/controls/web/persona

personaMinSize?: number

Nilai Properti

number

raisedHand

Apakah peserta mengangkat tangan. Menampilkan indikator (batas) dan ikon dengan pesanan

raisedHand?: RaisedHand

Nilai Properti

RaisedHand

reactionResources

URL dan metadata sumber daya reaksi.

reactionResources?: ReactionResources

Nilai Properti

ReactionResources

renderElement

Komponen dengan aliran video.

renderElement?: null | Element

Nilai Properti

null | Element

showLabel

Tampilkan label pada VideoTile

showLabel?: boolean

Nilai Properti

boolean

showMuteIndicator

Apakah akan menampilkan ikon bisukan di samping nama tampilan pengguna.

showMuteIndicator?: boolean

Nilai Properti

boolean

strings

String untuk diganti dalam komponen.

strings?: VideoTileStrings

Nilai Properti

VideoTileStrings

styles

Memungkinkan pengguna untuk meneruskan objek berisi gaya CSS kustom.

styles?: VideoTileStylesProps

Nilai Properti

VideoTileStylesProps

userId

id pengguna untuk tempat penampung VideoTile.

userId?: string

Nilai Properti

string