غرف RTC والويب SDK
تدفق التكامل
Section titled “تدفق التكامل”- إنشاء مشروع ومفتاح محدد النطاق في وحدة تحكم RTC.
- تقوم الخلفية الخاصة بك بإنشاء غرفة باستخدام الخادم API.
- يقوم تطبيقك بالمصادقة على المستخدم والتحقق من عضويته في الغرفة.
- تطلب الخلفية الخاصة بك بيانات اعتماد المشاركين لتلك الغرفة المصرح بها.
- ينضم العميل باستخدام بيانات الاعتماد هذه وينشر الوسائط إذا سُمح بذلك.
- تقوم الخلفية الخاصة بك بإنهاء الغرفة عند انتهاء الجلسة.
لا يتلقى المستخدمون النهائيون APIمفتاح المشروع. وتظل أنت مسؤولاً عن هوية التطبيق، والعضوية، والموافقة، وواجهة المستخدم.
إنشاء غرفة من الخلفية الخاصة بك
Section titled “إنشاء غرفة من الخلفية الخاصة بك”# Replace the sample UUID with the project ID copied from your console.curl --fail-with-body \ --request POST https://api.rtc.champrep.com/v1/rooms \ --header "Authorization: Bearer $RTC_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"projectId":"00000000-0000-4000-8000-000000000001","name":"Product support","maxParticipants":4}'حفظ ما تم إرجاعه id في تسجيل غرفة تطبيقك. maxParticipants
يجب أن يتوافق مع كل من القيدAPI الحالي وحد الخطة النشطة. لا تقم بتكرار إنشاء الغرفة تلقائيًا بعد انتهاء مهلة غامضة: فقد يكون الطلب الأول قد نجح. تحقق من القائمة أولاً.
الحصول على بيانات اعتماد المشاركين
Section titled “الحصول على بيانات اعتماد المشاركين”بعد التحقق من وصول المستخدم، ترسل الخلفية الخاصة بك:
curl --fail-with-body \ --request POST "https://api.rtc.champrep.com/v1/rooms/$RTC_ROOM_ID/tokens" \ --header "Authorization: Bearer $RTC_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"canPublish":true}'تحتوي الاستجابة على token, participantId, expiresIn, url، و
iceServers. قم بتمرير مجموعة بيانات الاعتماد هذه إلى العميل المصرح له عبر نقطة النهاية الخاصة بك التي تمت مصادقتها مع تعطيل التخزين المؤقت. تعامل مع كل ذلك على أنه معلومات حساسة. تنتهي صلاحية بيانات الاعتماد بعد خمس دقائق من الانضمام ولا يمكن إعادة استخدامها بعد الانضمام بنجاح. هذا لا يعني أن مدة المكالمة القصوى هي خمس دقائق.
المتصفح SDK
Section titled “المتصفح SDK”استخدم توزيعSDK الويب المدعوم بلغة JavaScript/TypeScript.
اتصل بنا CHAMPREP للحصول على تعليمات الوصول إلى الحزمة و تثبيتها. لا تقم بتثبيت حزمة تابعة لجهة خارجية تحمل اسمًا مشابهًا. يفترض المثال التالي أن لديك بالفعل ما تم توفيره RtcSession
في تطبيقك. يعتمد مسار استيراده على ذلك التوزيع.
const session = new RtcSession();
session.addEventListener('state', (event) => { updateConnectionLabel((event as CustomEvent).detail);});session.addEventListener('track', (event) => { const { id, stream, kind } = (event as CustomEvent).detail; attachRemoteMedia(id, stream, kind);});session.addEventListener('trackremoved', (event) => { removeRemoteMedia((event as CustomEvent).detail);});session.addEventListener('localtrack', (event) => { showLocalPreview((event as CustomEvent).detail);});session.addEventListener('error', (event) => { showCallError((event as CustomEvent).detail);});
await session.connect(async () => { // Your server authenticates this session and authorizes its room membership. // Implement CSRF protection appropriate to your application's session model. const response = await fetch('/your-app/rtc/join', { method: 'POST', credentials: 'same-origin', cache: 'no-store', }); if (!response.ok) throw new Error('Unable to join this room'); return response.json();});
// Call from your application's explicit microphone/camera consent flow.await session.publish(true);
// Call when leaving or unmounting the call screen.// session.close();تعد الدوال الخاصة بعرض الوسائط والأخطاء عناصر نائبة خاصة بالتطبيق . قم بربط كل دفق يتم إرجاعه بعنصر الصوت أو الفيديو المناسب، وقم بكتم صوت المعاينة المحلية، وقم بتعيين playsInline للفيديو، والتعامل مع رفض التشغيل التلقائي باستخدام عنصر تحكم «تشغيل» يُفعَّل بواسطة المستخدم. المسار الصوتي البعيد يحتاج إلى عنصر يدعم الصوت حتى في حالة عدم وجود فيديو.
SDK عناصر التحكم
Section titled “SDK عناصر التحكم”| طريقة | السلوك |
|---|---|
connect(tokenProvider) | الانضمام باستخدام دالة تُرجع بيانات اعتماد جديدة |
publish(true) | طلب الميكروفون والكاميرا ونشر مساراتهما |
publish(false) | نشر صوت الميكروفون بدون فيديو الكاميرا |
setMuted(true) / setMuted(false) | كتم صوت أو إلغاء كتم صوت مصدر الميكروفون |
setCamera(false) / setCamera(true) | قم بتعطيل أو تمكين منتج الكاميرا |
shareScreen() | افتح أداة اختيار المتصفح وانشر مسار شاشة للفيديو فقط |
setReceiveQuality('low') | اطلب فيديو مستلم بجودة أقل |
setReceiveQuality('auto') | استعادة تفضيلات الفيديو المستلم العادية |
close() | المغادرة، وإغلاق عمليات النقل، وإطلاق المسارات الملتقطة |
لا تستدعِ publish للمشارك الذي يقتصر دوره على الاستقبال فقط. امنع تكرار إجراءات النشر في واجهة المستخدم الخاصة بك. لا يتم التقاط صوت الشاشة بواسطة هذا API. لإيقاف المشاركة، استخدم عنصر التحكم «إيقاف المشاركة» في المتصفح. كتم الصوت يختلف عن مغادرة المكالمة؛ اتصل close() لإطلاق الجلسة والأجهزة الملتقطة التابعة لها.
تغييرات الشبكة ودورة الحياة
Section titled “تغييرات الشبكة ودورة الحياة”يحاولSDK إعادة الاتصال بعد انقطاع الإشارات ويستخدم وظيفة مزود الرمز مرة أخرى. قم دائمًا بإصدار جديد رمز بعد التحقق من الوصول؛ لا تقم أبدًا بتخزين رمز تم استخدامه في ذاكرة التخزين المؤقت. إعادة الاتصال محدودة وقد تفشل. اعرض حالات الاتصال والأخطاء، وقدم مسارًا لإعادة الانضمام يتحكم فيه المستخدم.
يؤدي وضع النطاق الترددي المنخفض إلى انخفاض جودة الفيديو المستلم؛ ولا يمكنه ضمان إجراء مكالمة عبر اتصال غير صالح للاستخدام. ضع في اعتبارك النشر الصوتي فقط عند الاقتضاء. كما يقبل أيضًاSDK new RtcSession({ iceTransportPolicy: 'relay' }) للاتصالات المخصصة للترحيل فقط، والتي تتطلب خدمة ترحيل يمكن الوصول إليها.
اختبر الأجهزة الحقيقية، وأذونات المتصفح، والشبكات المقيدة، والتشغيل في الخلفية، ومشاركة الشاشة، وسلوك إعادة الاتصال قبل الإصدار. لا تزال أدلة Python وNode.js SDKs وMEAN/MERN/MEN متوفرة بنود خارطة الطريق.