VideoGalleryProps interface

الحزمة:

@azure/communication-react

خصائص VideoGallery.

الخصائص

dominantSpeakers	قائمة المستخدمين المتحدثين المهيمنين بترتيب هيمنتهم. الفهرس العاشر هو الأكثر شيوعا.
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	يحدد تخطيط overflowGallery داخل VideoGallery.
pinnedParticipants	قائمة بمعرفات المستخدمين للمشاركين المثبتة.
reactionResources	موارد رد الفعل للإعجاب والقلب والضحك والتصفيق والمفاجأة.
remoteParticipants	قائمة بأجزاء الفيديو البعيدة
remoteVideoTileMenu	خيارات لإظهار قائمة لوحة الفيديو البعيدة.
remoteVideoViewOptions	خيارات عرض مقاطع الفيديو عن بعد
showCameraSwitcherInLocalPreview	ما إذا كنت تريد عرض زر مبدل كاميرا الفيديو المحلي
showMuteIndicator	ما إذا كنت تريد عرض أيقونة كتم الصوت بجانب اسم عرض المستخدم.
spotlightedParticipants	قائمة بمعرفات المستخدمين للمشاركين الذين تم تسليط الضوء عليهم.
startTogetherModeEnabled	يشير إلى ما إذا كان بإمكان المشارك المحلي بدء الوضع معا
strings	سلاسل اختيارية لتجاوزها في المكون
styles	يسمح للمستخدمين بتمرير كائن يحتوي على أنماط CSS مخصصة لحاوية المعرض.
togetherModeSeatingCoordinates	وضعية جلوس المشاركين في وضع معا
togetherModeStreams	تدفقات الفيديو في وضع معا
videoTilesOptions	خيارات إضافية للوحات الفيديو

تفاصيل الخاصية

dominantSpeakers

قائمة المستخدمين المتحدثين المهيمنين بترتيب هيمنتهم. الفهرس العاشر هو الأكثر شيوعا.

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

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

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

يحدد تخطيط overflowGallery داخل VideoGallery.

overflowGalleryPosition?: OverflowGalleryPosition

قيمة الخاصية

OverflowGalleryPosition

pinnedParticipants

قائمة بمعرفات المستخدمين للمشاركين المثبتة.

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