Hugging Face's logo

Spaces:
manhteky123
/
CloudflareCallDoc
Running

App Files Community
manhteky123 commited on
Commit
a8c4cef
·
verified ·
1 Parent(s): 76f3758

Upload 58 files

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. .gitattributes +6 -0
  2. CloudflareCalls.html +6336 -0
  3. api/assets/apple-touch-icondfdb.png +0 -0
  4. api/assets/bootstrap.mindfdb.css +0 -0
  5. api/assets/favicon-16x16dfdb.png +0 -0
  6. api/assets/favicon-32x32dfdb.png +0 -0
  7. api/assets/favicondfdb.ico +0 -0
  8. api/assets/glyphicons-halflings-regular.eot +0 -0
  9. api/assets/glyphicons-halflings-regular.svg +0 -0
  10. api/assets/glyphicons-halflings-regular.ttf +0 -0
  11. api/assets/glyphicons-halflings-regular.woff +0 -0
  12. api/assets/glyphicons-halflings-regular.woff2 +0 -0
  13. api/assets/glyphicons-halflings-regulard41d.eot +0 -0
  14. api/assets/main.bundledfdb.js +0 -0
  15. api/assets/maindfdb.css +623 -0
  16. api/assets/prism-diff-highlightdfdb.css +13 -0
  17. api/assets/prism-toolbardfdb.css +65 -0
  18. api/assets/prismdfdb.css +122 -0
  19. api/fonts/glyphicons-halflings-regular-2.html +10 -0
  20. api/fonts/glyphicons-halflings-regular-3.html +10 -0
  21. api/fonts/glyphicons-halflings-regular-4.html +10 -0
  22. api/fonts/glyphicons-halflings-regular-5.html +10 -0
  23. api/fonts/glyphicons-halflings-regular.html +10 -0
  24. api/fonts/glyphicons-halflings-regulard41d.html +10 -0
  25. api/index.html +1052 -0
  26. fonts/Montserrat/Montserrat-Bold.eot +3 -0
  27. fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  28. fonts/Montserrat/Montserrat-Bold.woff +3 -0
  29. fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  30. fonts/Montserrat/Montserrat-Boldd41d.eot +3 -0
  31. fonts/Montserrat/Montserrat-Regular.eot +3 -0
  32. fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  33. fonts/Montserrat/Montserrat-Regular.woff +3 -0
  34. fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  35. fonts/Montserrat/Montserrat-Regulard41d.eot +3 -0
  36. fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  37. fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +978 -0
  38. fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  39. fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  40. fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  41. fonts/Source-Sans-Pro/sourcesanspro-light-webfontd41d.eot +0 -0
  42. fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  43. fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
  44. fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  45. fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  46. fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  47. fonts/Source-Sans-Pro/sourcesanspro-regular-webfontd41d.eot +0 -0
  48. global.html +2886 -0
  49. index-2.html +127 -0
  50. index.html +127 -0
.gitattributes CHANGED
@@ -39,3 +39,9 @@ docs/fonts/Montserrat/Montserrat-Boldd41d.eot filter=lfs diff=lfs merge=lfs -tex
39
  docs/fonts/Montserrat/Montserrat-Regular.eot filter=lfs diff=lfs merge=lfs -text
40
  docs/fonts/Montserrat/Montserrat-Regular.woff filter=lfs diff=lfs merge=lfs -text
41
  docs/fonts/Montserrat/Montserrat-Regulard41d.eot filter=lfs diff=lfs merge=lfs -text
 
 
 
 
 
 
 
39
  docs/fonts/Montserrat/Montserrat-Regular.eot filter=lfs diff=lfs merge=lfs -text
40
  docs/fonts/Montserrat/Montserrat-Regular.woff filter=lfs diff=lfs merge=lfs -text
41
  docs/fonts/Montserrat/Montserrat-Regulard41d.eot filter=lfs diff=lfs merge=lfs -text
42
+ fonts/Montserrat/Montserrat-Bold.eot filter=lfs diff=lfs merge=lfs -text
43
+ fonts/Montserrat/Montserrat-Bold.woff filter=lfs diff=lfs merge=lfs -text
44
+ fonts/Montserrat/Montserrat-Boldd41d.eot filter=lfs diff=lfs merge=lfs -text
45
+ fonts/Montserrat/Montserrat-Regular.eot filter=lfs diff=lfs merge=lfs -text
46
+ fonts/Montserrat/Montserrat-Regular.woff filter=lfs diff=lfs merge=lfs -text
47
+ fonts/Montserrat/Montserrat-Regulard41d.eot filter=lfs diff=lfs merge=lfs -text
CloudflareCalls.html ADDED
@@ -0,0 +1,6336 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <!-- Mirrored from cloudflarecalls.jamesfuthey.com/docs/CloudflareCalls.html by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 19 Feb 2025 14:59:44 GMT -->
5
+ <!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=UTF-8" /><!-- /Added by HTTrack -->
6
+ <head>
7
+
8
+ <meta charset="utf-8">
9
+ <title>CloudflareCalls - Documentation</title>
10
+
11
+
12
+ <script src="scripts/prettify/prettify.js"></script>
13
+ <script src="scripts/prettify/lang-css.js"></script>
14
+ <!--[if lt IE 9]>
15
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
+ <![endif]-->
17
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
18
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
19
+ <script src="scripts/nav.js" defer></script>
20
+
21
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
22
+ </head>
23
+ <body>
24
+
25
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
26
+ <label for="nav-trigger" class="navicon-button x">
27
+ <div class="navicon"></div>
28
+ </label>
29
+
30
+ <label for="nav-trigger" class="overlay"></label>
31
+
32
+ <nav >
33
+
34
+
35
+ <h2><a href="index-2.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CloudflareCalls.html">CloudflareCalls</a><ul class='methods'><li data-type='method'><a href="CloudflareCalls.html#createRoom">createRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#getAvailableDevices">getAvailableDevices</a></li><li data-type='method'><a href="CloudflareCalls.html#getConnectionStats">getConnectionStats</a></li><li data-type='method'><a href="CloudflareCalls.html#getSessionState">getSessionState</a></li><li data-type='method'><a href="CloudflareCalls.html#getTrackStatus">getTrackStatus</a></li><li data-type='method'><a href="CloudflareCalls.html#getUserInfo">getUserInfo</a></li><li data-type='method'><a href="CloudflareCalls.html#getUserMetadata">getUserMetadata</a></li><li data-type='method'><a href="CloudflareCalls.html#joinRoom">joinRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#leaveRoom">leaveRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#listParticipants">listParticipants</a></li><li data-type='method'><a href="CloudflareCalls.html#listRooms">listRooms</a></li><li data-type='method'><a href="CloudflareCalls.html#onConnectionStats">onConnectionStats</a></li><li data-type='method'><a href="CloudflareCalls.html#onDataMessage">onDataMessage</a></li><li data-type='method'><a href="CloudflareCalls.html#onParticipantJoined">onParticipantJoined</a></li><li data-type='method'><a href="CloudflareCalls.html#onParticipantLeft">onParticipantLeft</a></li><li data-type='method'><a href="CloudflareCalls.html#onRemoteTrack">onRemoteTrack</a></li><li data-type='method'><a href="CloudflareCalls.html#onRemoteTrackUnpublished">onRemoteTrackUnpublished</a></li><li data-type='method'><a href="CloudflareCalls.html#onRoomMetadataUpdated">onRoomMetadataUpdated</a></li><li data-type='method'><a href="CloudflareCalls.html#onTrackStatusChanged">onTrackStatusChanged</a></li><li data-type='method'><a href="CloudflareCalls.html#onWebSocketMessage">onWebSocketMessage</a></li><li data-type='method'><a href="CloudflareCalls.html#previewMedia">previewMedia</a></li><li data-type='method'><a href="CloudflareCalls.html#publishTracks">publishTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#selectAudioInputDevice">selectAudioInputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#selectAudioOutputDevice">selectAudioOutputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#selectVideoInputDevice">selectVideoInputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#sendDataToAll">sendDataToAll</a></li><li data-type='method'><a href="CloudflareCalls.html#setDebugMode">setDebugMode</a></li><li data-type='method'><a href="CloudflareCalls.html#setMediaQuality">setMediaQuality</a></li><li data-type='method'><a href="CloudflareCalls.html#setToken">setToken</a></li><li data-type='method'><a href="CloudflareCalls.html#setUserMetadata">setUserMetadata</a></li><li data-type='method'><a href="CloudflareCalls.html#shareScreen">shareScreen</a></li><li data-type='method'><a href="CloudflareCalls.html#startStatsMonitoring">startStatsMonitoring</a></li><li data-type='method'><a href="CloudflareCalls.html#stopStatsMonitoring">stopStatsMonitoring</a></li><li data-type='method'><a href="CloudflareCalls.html#toggleMedia">toggleMedia</a></li><li data-type='method'><a href="CloudflareCalls.html#unpublishAllTracks">unpublishAllTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#updatePublishedTracks">updatePublishedTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#updateRoomMetadata">updateRoomMetadata</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#broadcastToRoom">broadcastToRoom</a></li><li><a href="global.html#getRoomIdByUserId">getRoomIdByUserId</a></li><li><a href="global.html#getWebSocketByUserId">getWebSocketByUserId</a></li><li><a href="global.html#handleDataMessage">handleDataMessage</a></li><li><a href="global.html#handleWSDisconnect">handleWSDisconnect</a></li><li><a href="global.html#handleWSJoin">handleWSJoin</a></li><li><a href="global.html#rooms">rooms</a></li><li><a href="global.html#server">server</a></li></ul>
36
+
37
+ </nav>
38
+
39
+ <div id="main">
40
+
41
+ <h1 class="page-title">CloudflareCalls</h1>
42
+
43
+
44
+
45
+
46
+
47
+
48
+
49
+ <section>
50
+
51
+ <header>
52
+
53
+ <h2>
54
+
55
+ CloudflareCalls
56
+
57
+ </h2>
58
+
59
+ <div class="class-description usertext">Represents the CloudflareCalls library for managing real-time communications.</div>
60
+
61
+
62
+ </header>
63
+
64
+ <article>
65
+
66
+ <div class="container-overview">
67
+
68
+
69
+
70
+
71
+ <h2>Constructor</h2>
72
+
73
+
74
+ <h4 class="name" id="CloudflareCalls"><span class="type-signature"></span>new CloudflareCalls<span class="signature">(config)</span><span class="type-signature"></span></h4>
75
+
76
+
77
+
78
+
79
+
80
+
81
+ <dl class="details">
82
+
83
+ <dt class="tag-description">Description:</dt>
84
+ <dd class="tag-description"><ul class="dummy"><li>Creates an instance of CloudflareCalls.</li></ul></dd>
85
+
86
+
87
+
88
+ <dt class="tag-source">Source:</dt>
89
+ <dd class="tag-source"><ul class="dummy"><li>
90
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line11">line 11</a>
91
+ </li></ul></dd>
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ </dl>
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+ <h5 class="h5-parameters">Parameters:</h5>
138
+
139
+
140
+ <table class="params">
141
+ <thead>
142
+ <tr>
143
+
144
+ <th>Name</th>
145
+
146
+
147
+ <th>Type</th>
148
+
149
+
150
+
151
+
152
+
153
+ <th class="last">Description</th>
154
+ </tr>
155
+ </thead>
156
+
157
+ <tbody>
158
+
159
+
160
+ <tr>
161
+
162
+ <td class="name"><code>config</code></td>
163
+
164
+
165
+ <td class="type">
166
+
167
+
168
+ <span class="param-type">Object</span>
169
+
170
+
171
+
172
+
173
+ </td>
174
+
175
+
176
+
177
+
178
+
179
+ <td class="description last">Configuration object.
180
+ <h6>Properties</h6>
181
+
182
+
183
+ <table class="params">
184
+ <thead>
185
+ <tr>
186
+
187
+ <th>Name</th>
188
+
189
+
190
+ <th>Type</th>
191
+
192
+
193
+
194
+
195
+
196
+ <th class="last">Description</th>
197
+ </tr>
198
+ </thead>
199
+
200
+ <tbody>
201
+
202
+
203
+ <tr>
204
+
205
+ <td class="name"><code>backendUrl</code></td>
206
+
207
+
208
+ <td class="type">
209
+
210
+
211
+ <span class="param-type">string</span>
212
+
213
+
214
+
215
+
216
+ </td>
217
+
218
+
219
+
220
+
221
+
222
+ <td class="description last">The backend server URL.</td>
223
+ </tr>
224
+
225
+
226
+
227
+ <tr>
228
+
229
+ <td class="name"><code>websocketUrl</code></td>
230
+
231
+
232
+ <td class="type">
233
+
234
+
235
+ <span class="param-type">string</span>
236
+
237
+
238
+
239
+
240
+ </td>
241
+
242
+
243
+
244
+
245
+
246
+ <td class="description last">The WebSocket server URL.</td>
247
+ </tr>
248
+
249
+
250
+ </tbody>
251
+ </table>
252
+
253
+ </td>
254
+ </tr>
255
+
256
+
257
+ </tbody>
258
+ </table>
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+ </div>
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+ <h3 class="subsection-title">Members</h3>
296
+
297
+
298
+
299
+ <h4 class="name" id="QUALITY_PRESETS"><span class="type-signature"></span>QUALITY_PRESETS<span class="type-signature"> :Object.&lt;string, <a href="global.html#QualityPreset">QualityPreset</a>></span></h4>
300
+
301
+
302
+
303
+
304
+
305
+ <dl class="details">
306
+
307
+
308
+
309
+ <dt class="tag-source">Source:</dt>
310
+ <dd class="tag-source"><ul class="dummy"><li>
311
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line118">line 118</a>
312
+ </li></ul></dd>
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+ </dl>
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+ <h5 class="h5-types">Type:</h5>
353
+ <ul>
354
+ <li>
355
+
356
+ <span class="param-type">Object.&lt;string, <a href="global.html#QualityPreset">QualityPreset</a>></span>
357
+
358
+
359
+
360
+ </li>
361
+ </ul>
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+ <h4 class="name" id="pendingQualitySettings"><span class="type-signature"></span>pendingQualitySettings<span class="type-signature"> :<a href="global.html#QualityPreset">QualityPreset</a></span></h4>
371
+
372
+
373
+
374
+
375
+
376
+ <dl class="details">
377
+
378
+
379
+
380
+ <dt class="tag-source">Source:</dt>
381
+ <dd class="tag-source"><ul class="dummy"><li>
382
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line113">line 113</a>
383
+ </li></ul></dd>
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+ </dl>
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+ <h5 class="h5-types">Type:</h5>
424
+ <ul>
425
+ <li>
426
+
427
+ <span class="param-type"><a href="global.html#QualityPreset">QualityPreset</a></span>
428
+
429
+
430
+
431
+ </li>
432
+ </ul>
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+ <h4 class="name" id="statsMonitoringState"><span class="type-signature"></span>statsMonitoringState<span class="type-signature"> :'stopped'|'monitoring'</span></h4>
442
+
443
+
444
+
445
+
446
+
447
+ <dl class="details">
448
+
449
+
450
+
451
+ <dt class="tag-source">Source:</dt>
452
+ <dd class="tag-source"><ul class="dummy"><li>
453
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line125">line 125</a>
454
+ </li></ul></dd>
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+ </dl>
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+ <h5 class="h5-types">Type:</h5>
495
+ <ul>
496
+ <li>
497
+
498
+ <span class="param-type">'stopped'</span>
499
+ |
500
+
501
+ <span class="param-type">'monitoring'</span>
502
+
503
+
504
+
505
+ </li>
506
+ </ul>
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+ <h3 class="subsection-title">Methods</h3>
518
+
519
+
520
+
521
+
522
+
523
+
524
+ <h4 class="name" id="createRoom"><span class="type-signature type-signature-async">(async) </span>createRoom<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
525
+
526
+
527
+
528
+
529
+
530
+
531
+ <dl class="details">
532
+
533
+ <dt class="tag-description">Description:</dt>
534
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new room with optional metadata.</li></ul></dd>
535
+
536
+
537
+
538
+ <dt class="tag-source">Source:</dt>
539
+ <dd class="tag-source"><ul class="dummy"><li>
540
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line342">line 342</a>
541
+ </li></ul></dd>
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+ </dl>
574
+
575
+
576
+
577
+
578
+
579
+
580
+
581
+
582
+
583
+
584
+
585
+
586
+
587
+ <h5 class="h5-parameters">Parameters:</h5>
588
+
589
+
590
+ <table class="params">
591
+ <thead>
592
+ <tr>
593
+
594
+ <th>Name</th>
595
+
596
+
597
+ <th>Type</th>
598
+
599
+
600
+
601
+
602
+
603
+ <th class="last">Description</th>
604
+ </tr>
605
+ </thead>
606
+
607
+ <tbody>
608
+
609
+
610
+ <tr>
611
+
612
+ <td class="name"><code>options</code></td>
613
+
614
+
615
+ <td class="type">
616
+
617
+
618
+ <span class="param-type">Object</span>
619
+
620
+
621
+
622
+
623
+ </td>
624
+
625
+
626
+
627
+
628
+
629
+ <td class="description last">Room creation options
630
+ <h6>Properties</h6>
631
+
632
+
633
+ <table class="params">
634
+ <thead>
635
+ <tr>
636
+
637
+ <th>Name</th>
638
+
639
+
640
+ <th>Type</th>
641
+
642
+
643
+ <th>Attributes</th>
644
+
645
+
646
+
647
+
648
+ <th class="last">Description</th>
649
+ </tr>
650
+ </thead>
651
+
652
+ <tbody>
653
+
654
+
655
+ <tr>
656
+
657
+ <td class="name"><code>name</code></td>
658
+
659
+
660
+ <td class="type">
661
+
662
+
663
+ <span class="param-type">string</span>
664
+
665
+
666
+
667
+
668
+ </td>
669
+
670
+
671
+ <td class="attributes">
672
+
673
+ &lt;optional><br>
674
+
675
+
676
+
677
+
678
+
679
+ </td>
680
+
681
+
682
+
683
+
684
+ <td class="description last">Room name</td>
685
+ </tr>
686
+
687
+
688
+
689
+ <tr>
690
+
691
+ <td class="name"><code>metadata</code></td>
692
+
693
+
694
+ <td class="type">
695
+
696
+
697
+ <span class="param-type">Object</span>
698
+
699
+
700
+
701
+
702
+ </td>
703
+
704
+
705
+ <td class="attributes">
706
+
707
+ &lt;optional><br>
708
+
709
+
710
+
711
+
712
+
713
+ </td>
714
+
715
+
716
+
717
+
718
+ <td class="description last">Room metadata</td>
719
+ </tr>
720
+
721
+
722
+ </tbody>
723
+ </table>
724
+
725
+ </td>
726
+ </tr>
727
+
728
+
729
+ </tbody>
730
+ </table>
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+ <h5 class="h5-returns">Returns:</h5>
748
+
749
+
750
+ <div class="param-desc">
751
+ Created room information including roomId, name, metadata, etc.
752
+ </div>
753
+
754
+
755
+
756
+ <dl class="param-type">
757
+ <dt>
758
+ Type
759
+ </dt>
760
+ <dd>
761
+
762
+ <span class="param-type">Promise.&lt;Object></span>
763
+
764
+
765
+
766
+ </dd>
767
+ </dl>
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+ <h4 class="name" id="getAvailableDevices"><span class="type-signature type-signature-async">(async) </span>getAvailableDevices<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
779
+
780
+
781
+
782
+
783
+
784
+
785
+ <dl class="details">
786
+
787
+ <dt class="tag-description">Description:</dt>
788
+ <dd class="tag-description"><ul class="dummy"><li>Retrieves the list of available media devices.</li></ul></dd>
789
+
790
+
791
+
792
+ <dt class="tag-source">Source:</dt>
793
+ <dd class="tag-source"><ul class="dummy"><li>
794
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1044">line 1044</a>
795
+ </li></ul></dd>
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+
818
+
819
+
820
+
821
+
822
+
823
+
824
+
825
+
826
+
827
+ </dl>
828
+
829
+
830
+
831
+
832
+
833
+
834
+
835
+
836
+
837
+
838
+
839
+
840
+
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+
850
+
851
+
852
+
853
+
854
+
855
+ <h5 class="h5-returns">Returns:</h5>
856
+
857
+
858
+ <div class="param-desc">
859
+ An object containing arrays of audio input, video input, and audio output devices.
860
+ </div>
861
+
862
+
863
+
864
+ <dl class="param-type">
865
+ <dt>
866
+ Type
867
+ </dt>
868
+ <dd>
869
+
870
+ <span class="param-type">Promise.&lt;Object></span>
871
+
872
+
873
+
874
+ </dd>
875
+ </dl>
876
+
877
+
878
+
879
+
880
+
881
+
882
+
883
+
884
+
885
+
886
+ <h4 class="name" id="getConnectionStats"><span class="type-signature type-signature-async">(async) </span>getConnectionStats<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#ConnectionStats">ConnectionStats</a>>}</span></h4>
887
+
888
+
889
+
890
+
891
+
892
+
893
+ <dl class="details">
894
+
895
+ <dt class="tag-description">Description:</dt>
896
+ <dd class="tag-description"><ul class="dummy"><li>Get a snapshot of current connection statistics</li></ul></dd>
897
+
898
+
899
+
900
+ <dt class="tag-source">Source:</dt>
901
+ <dd class="tag-source"><ul class="dummy"><li>
902
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1849">line 1849</a>
903
+ </li></ul></dd>
904
+
905
+
906
+
907
+
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+
933
+
934
+
935
+ </dl>
936
+
937
+
938
+
939
+
940
+
941
+
942
+
943
+
944
+
945
+
946
+
947
+
948
+
949
+
950
+
951
+
952
+
953
+
954
+
955
+
956
+
957
+
958
+
959
+
960
+
961
+
962
+
963
+ <h5 class="h5-returns">Returns:</h5>
964
+
965
+
966
+ <div class="param-desc">
967
+ Current connection statistics
968
+ </div>
969
+
970
+
971
+
972
+ <dl class="param-type">
973
+ <dt>
974
+ Type
975
+ </dt>
976
+ <dd>
977
+
978
+ <span class="param-type">Promise.&lt;<a href="global.html#ConnectionStats">ConnectionStats</a>></span>
979
+
980
+
981
+
982
+ </dd>
983
+ </dl>
984
+
985
+
986
+
987
+
988
+
989
+
990
+
991
+
992
+
993
+
994
+ <h4 class="name" id="getSessionState"><span class="type-signature type-signature-async">(async) </span>getSessionState<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
995
+
996
+
997
+
998
+
999
+
1000
+
1001
+ <dl class="details">
1002
+
1003
+ <dt class="tag-description">Description:</dt>
1004
+ <dd class="tag-description"><ul class="dummy"><li>Gets the session state</li></ul></dd>
1005
+
1006
+
1007
+
1008
+ <dt class="tag-source">Source:</dt>
1009
+ <dd class="tag-source"><ul class="dummy"><li>
1010
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1393">line 1393</a>
1011
+ </li></ul></dd>
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+
1024
+
1025
+
1026
+
1027
+
1028
+
1029
+
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+
1042
+
1043
+ </dl>
1044
+
1045
+
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+ <h5 class="h5-returns">Returns:</h5>
1072
+
1073
+
1074
+ <div class="param-desc">
1075
+ The session state
1076
+ </div>
1077
+
1078
+
1079
+
1080
+ <dl class="param-type">
1081
+ <dt>
1082
+ Type
1083
+ </dt>
1084
+ <dd>
1085
+
1086
+ <span class="param-type">Promise.&lt;Object></span>
1087
+
1088
+
1089
+
1090
+ </dd>
1091
+ </dl>
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+
1102
+ <h4 class="name" id="getTrackStatus"><span class="type-signature type-signature-async">(async) </span>getTrackStatus<span class="signature">(trackName)</span><span class="type-signature"> &rarr; {Promise.&lt;string>}</span></h4>
1103
+
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+ <dl class="details">
1110
+
1111
+ <dt class="tag-description">Description:</dt>
1112
+ <dd class="tag-description"><ul class="dummy"><li>Gets the track status</li></ul></dd>
1113
+
1114
+
1115
+
1116
+ <dt class="tag-source">Source:</dt>
1117
+ <dd class="tag-source"><ul class="dummy"><li>
1118
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1422">line 1422</a>
1119
+ </li></ul></dd>
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+
1137
+
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+ </dl>
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+
1161
+
1162
+
1163
+
1164
+
1165
+ <h5 class="h5-parameters">Parameters:</h5>
1166
+
1167
+
1168
+ <table class="params">
1169
+ <thead>
1170
+ <tr>
1171
+
1172
+ <th>Name</th>
1173
+
1174
+
1175
+ <th>Type</th>
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+ <th class="last">Description</th>
1182
+ </tr>
1183
+ </thead>
1184
+
1185
+ <tbody>
1186
+
1187
+
1188
+ <tr>
1189
+
1190
+ <td class="name"><code>trackName</code></td>
1191
+
1192
+
1193
+ <td class="type">
1194
+
1195
+
1196
+ <span class="param-type">string</span>
1197
+
1198
+
1199
+
1200
+
1201
+ </td>
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+ <td class="description last">The track name</td>
1208
+ </tr>
1209
+
1210
+
1211
+ </tbody>
1212
+ </table>
1213
+
1214
+
1215
+
1216
+
1217
+
1218
+
1219
+
1220
+
1221
+
1222
+
1223
+
1224
+
1225
+
1226
+
1227
+
1228
+
1229
+ <h5 class="h5-returns">Returns:</h5>
1230
+
1231
+
1232
+ <div class="param-desc">
1233
+ The track status
1234
+ </div>
1235
+
1236
+
1237
+
1238
+ <dl class="param-type">
1239
+ <dt>
1240
+ Type
1241
+ </dt>
1242
+ <dd>
1243
+
1244
+ <span class="param-type">Promise.&lt;string></span>
1245
+
1246
+
1247
+
1248
+ </dd>
1249
+ </dl>
1250
+
1251
+
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+ <h4 class="name" id="getUserInfo"><span class="type-signature type-signature-async">(async) </span>getUserInfo<span class="signature">(userId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+ <dl class="details">
1268
+
1269
+ <dt class="tag-description">Description:</dt>
1270
+ <dd class="tag-description"><ul class="dummy"><li>Gets information about a user</li></ul></dd>
1271
+
1272
+
1273
+
1274
+ <dt class="tag-source">Source:</dt>
1275
+ <dd class="tag-source"><ul class="dummy"><li>
1276
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1492">line 1492</a>
1277
+ </li></ul></dd>
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+
1288
+
1289
+
1290
+
1291
+
1292
+
1293
+
1294
+
1295
+
1296
+
1297
+
1298
+
1299
+
1300
+
1301
+
1302
+
1303
+
1304
+
1305
+
1306
+
1307
+
1308
+
1309
+ </dl>
1310
+
1311
+
1312
+
1313
+
1314
+
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+
1321
+
1322
+
1323
+ <h5 class="h5-parameters">Parameters:</h5>
1324
+
1325
+
1326
+ <table class="params">
1327
+ <thead>
1328
+ <tr>
1329
+
1330
+ <th>Name</th>
1331
+
1332
+
1333
+ <th>Type</th>
1334
+
1335
+
1336
+ <th>Attributes</th>
1337
+
1338
+
1339
+
1340
+ <th>Default</th>
1341
+
1342
+
1343
+ <th class="last">Description</th>
1344
+ </tr>
1345
+ </thead>
1346
+
1347
+ <tbody>
1348
+
1349
+
1350
+ <tr>
1351
+
1352
+ <td class="name"><code>userId</code></td>
1353
+
1354
+
1355
+ <td class="type">
1356
+
1357
+
1358
+ <span class="param-type">string</span>
1359
+
1360
+
1361
+
1362
+
1363
+ </td>
1364
+
1365
+
1366
+ <td class="attributes">
1367
+
1368
+ &lt;optional><br>
1369
+
1370
+
1371
+
1372
+
1373
+
1374
+ </td>
1375
+
1376
+
1377
+
1378
+ <td class="default">
1379
+
1380
+ <code>null</code>
1381
+
1382
+ </td>
1383
+
1384
+
1385
+ <td class="description last">Optional user ID. If omitted, returns current user's info</td>
1386
+ </tr>
1387
+
1388
+
1389
+ </tbody>
1390
+ </table>
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+
1398
+
1399
+
1400
+
1401
+
1402
+
1403
+
1404
+
1405
+
1406
+
1407
+ <h5 class="h5-returns">Returns:</h5>
1408
+
1409
+
1410
+ <div class="param-desc">
1411
+ User information including moderator status
1412
+ </div>
1413
+
1414
+
1415
+
1416
+ <dl class="param-type">
1417
+ <dt>
1418
+ Type
1419
+ </dt>
1420
+ <dd>
1421
+
1422
+ <span class="param-type">Promise.&lt;Object></span>
1423
+
1424
+
1425
+
1426
+ </dd>
1427
+ </dl>
1428
+
1429
+
1430
+
1431
+
1432
+
1433
+
1434
+
1435
+
1436
+
1437
+
1438
+ <h4 class="name" id="getUserMetadata"><span class="type-signature"></span>getUserMetadata<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
1439
+
1440
+
1441
+
1442
+
1443
+
1444
+
1445
+ <dl class="details">
1446
+
1447
+ <dt class="tag-description">Description:</dt>
1448
+ <dd class="tag-description"><ul class="dummy"><li>Retrieves the current user metadata.</li></ul></dd>
1449
+
1450
+
1451
+
1452
+ <dt class="tag-source">Source:</dt>
1453
+ <dd class="tag-source"><ul class="dummy"><li>
1454
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line295">line 295</a>
1455
+ </li></ul></dd>
1456
+
1457
+
1458
+
1459
+
1460
+
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+
1468
+
1469
+
1470
+
1471
+
1472
+
1473
+
1474
+
1475
+
1476
+
1477
+
1478
+
1479
+
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+
1486
+
1487
+ </dl>
1488
+
1489
+
1490
+
1491
+
1492
+
1493
+
1494
+
1495
+
1496
+
1497
+
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+
1512
+
1513
+
1514
+
1515
+ <h5 class="h5-returns">Returns:</h5>
1516
+
1517
+
1518
+ <div class="param-desc">
1519
+ The user metadata.
1520
+ </div>
1521
+
1522
+
1523
+
1524
+ <dl class="param-type">
1525
+ <dt>
1526
+ Type
1527
+ </dt>
1528
+ <dd>
1529
+
1530
+ <span class="param-type">Object</span>
1531
+
1532
+
1533
+
1534
+ </dd>
1535
+ </dl>
1536
+
1537
+
1538
+
1539
+
1540
+
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+ <h4 class="name" id="joinRoom"><span class="type-signature type-signature-async">(async) </span>joinRoom<span class="signature">(roomId, metadata<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+ <dl class="details">
1554
+
1555
+ <dt class="tag-description">Description:</dt>
1556
+ <dd class="tag-description"><ul class="dummy"><li>Joins an existing room.</li></ul></dd>
1557
+
1558
+
1559
+
1560
+ <dt class="tag-source">Source:</dt>
1561
+ <dd class="tag-source"><ul class="dummy"><li>
1562
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line363">line 363</a>
1563
+ </li></ul></dd>
1564
+
1565
+
1566
+
1567
+
1568
+
1569
+
1570
+
1571
+
1572
+
1573
+
1574
+
1575
+
1576
+
1577
+
1578
+
1579
+
1580
+
1581
+
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+
1589
+
1590
+
1591
+
1592
+
1593
+
1594
+
1595
+ </dl>
1596
+
1597
+
1598
+
1599
+
1600
+
1601
+
1602
+
1603
+
1604
+
1605
+
1606
+
1607
+
1608
+
1609
+ <h5 class="h5-parameters">Parameters:</h5>
1610
+
1611
+
1612
+ <table class="params">
1613
+ <thead>
1614
+ <tr>
1615
+
1616
+ <th>Name</th>
1617
+
1618
+
1619
+ <th>Type</th>
1620
+
1621
+
1622
+ <th>Attributes</th>
1623
+
1624
+
1625
+
1626
+ <th>Default</th>
1627
+
1628
+
1629
+ <th class="last">Description</th>
1630
+ </tr>
1631
+ </thead>
1632
+
1633
+ <tbody>
1634
+
1635
+
1636
+ <tr>
1637
+
1638
+ <td class="name"><code>roomId</code></td>
1639
+
1640
+
1641
+ <td class="type">
1642
+
1643
+
1644
+ <span class="param-type">string</span>
1645
+
1646
+
1647
+
1648
+
1649
+ </td>
1650
+
1651
+
1652
+ <td class="attributes">
1653
+
1654
+
1655
+
1656
+
1657
+
1658
+ </td>
1659
+
1660
+
1661
+
1662
+ <td class="default">
1663
+
1664
+ </td>
1665
+
1666
+
1667
+ <td class="description last">The ID of the room to join.</td>
1668
+ </tr>
1669
+
1670
+
1671
+
1672
+ <tr>
1673
+
1674
+ <td class="name"><code>metadata</code></td>
1675
+
1676
+
1677
+ <td class="type">
1678
+
1679
+
1680
+ <span class="param-type">Object</span>
1681
+
1682
+
1683
+
1684
+
1685
+ </td>
1686
+
1687
+
1688
+ <td class="attributes">
1689
+
1690
+ &lt;optional><br>
1691
+
1692
+
1693
+
1694
+
1695
+
1696
+ </td>
1697
+
1698
+
1699
+
1700
+ <td class="default">
1701
+
1702
+ <code>{}</code>
1703
+
1704
+ </td>
1705
+
1706
+
1707
+ <td class="description last">Optional metadata for the user.</td>
1708
+ </tr>
1709
+
1710
+
1711
+ </tbody>
1712
+ </table>
1713
+
1714
+
1715
+
1716
+
1717
+
1718
+
1719
+
1720
+
1721
+
1722
+
1723
+
1724
+
1725
+
1726
+
1727
+
1728
+
1729
+ <h5 class="h5-returns">Returns:</h5>
1730
+
1731
+
1732
+
1733
+
1734
+ <dl class="param-type">
1735
+ <dt>
1736
+ Type
1737
+ </dt>
1738
+ <dd>
1739
+
1740
+ <span class="param-type">Promise.&lt;void></span>
1741
+
1742
+
1743
+
1744
+ </dd>
1745
+ </dl>
1746
+
1747
+
1748
+
1749
+
1750
+
1751
+
1752
+
1753
+
1754
+
1755
+
1756
+ <h4 class="name" id="leaveRoom"><span class="type-signature type-signature-async">(async) </span>leaveRoom<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
1757
+
1758
+
1759
+
1760
+
1761
+
1762
+
1763
+ <dl class="details">
1764
+
1765
+ <dt class="tag-description">Description:</dt>
1766
+ <dd class="tag-description"><ul class="dummy"><li>Leaves the current room and cleans up connections.</li></ul></dd>
1767
+
1768
+
1769
+
1770
+ <dt class="tag-source">Source:</dt>
1771
+ <dd class="tag-source"><ul class="dummy"><li>
1772
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line437">line 437</a>
1773
+ </li></ul></dd>
1774
+
1775
+
1776
+
1777
+
1778
+
1779
+
1780
+
1781
+
1782
+
1783
+
1784
+
1785
+
1786
+
1787
+
1788
+
1789
+
1790
+
1791
+
1792
+
1793
+
1794
+
1795
+
1796
+
1797
+
1798
+
1799
+
1800
+
1801
+
1802
+
1803
+
1804
+
1805
+ </dl>
1806
+
1807
+
1808
+
1809
+
1810
+
1811
+
1812
+
1813
+
1814
+
1815
+
1816
+
1817
+
1818
+
1819
+
1820
+
1821
+
1822
+
1823
+
1824
+
1825
+
1826
+
1827
+
1828
+
1829
+
1830
+
1831
+
1832
+
1833
+ <h5 class="h5-returns">Returns:</h5>
1834
+
1835
+
1836
+
1837
+
1838
+ <dl class="param-type">
1839
+ <dt>
1840
+ Type
1841
+ </dt>
1842
+ <dd>
1843
+
1844
+ <span class="param-type">Promise.&lt;void></span>
1845
+
1846
+
1847
+
1848
+ </dd>
1849
+ </dl>
1850
+
1851
+
1852
+
1853
+
1854
+
1855
+
1856
+
1857
+
1858
+
1859
+
1860
+ <h4 class="name" id="listParticipants"><span class="type-signature type-signature-async">(async) </span>listParticipants<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;Object>>}</span></h4>
1861
+
1862
+
1863
+
1864
+
1865
+
1866
+
1867
+ <dl class="details">
1868
+
1869
+ <dt class="tag-description">Description:</dt>
1870
+ <dd class="tag-description"><ul class="dummy"><li>Lists all participants currently in the room.</li></ul></dd>
1871
+
1872
+
1873
+
1874
+ <dt class="tag-source">Source:</dt>
1875
+ <dd class="tag-source"><ul class="dummy"><li>
1876
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1289">line 1289</a>
1877
+ </li></ul></dd>
1878
+
1879
+
1880
+
1881
+
1882
+
1883
+
1884
+
1885
+
1886
+
1887
+
1888
+
1889
+
1890
+
1891
+
1892
+
1893
+
1894
+
1895
+
1896
+
1897
+
1898
+
1899
+
1900
+
1901
+
1902
+
1903
+
1904
+
1905
+
1906
+
1907
+
1908
+
1909
+ </dl>
1910
+
1911
+
1912
+
1913
+
1914
+
1915
+
1916
+
1917
+
1918
+
1919
+
1920
+
1921
+
1922
+
1923
+
1924
+
1925
+
1926
+
1927
+
1928
+
1929
+
1930
+
1931
+
1932
+
1933
+
1934
+
1935
+ <h5 class="h5-throws">Throws:</h5>
1936
+
1937
+
1938
+
1939
+ <dl>
1940
+ <dt>
1941
+ <div class="param-desc usertext">
1942
+ If not connected to any room.
1943
+ </div>
1944
+ </dt>
1945
+ <dd></dd>
1946
+ <dt>
1947
+ <dl class="param-type">
1948
+ <dt>
1949
+ Type
1950
+ </dt>
1951
+ <dd>
1952
+
1953
+ <span class="param-type">Error</span>
1954
+
1955
+
1956
+
1957
+ </dd>
1958
+ </dl>
1959
+ </dt>
1960
+ <dd></dd>
1961
+ </dl>
1962
+
1963
+
1964
+
1965
+
1966
+
1967
+ <h5 class="h5-returns">Returns:</h5>
1968
+
1969
+
1970
+ <div class="param-desc">
1971
+ An array of participant objects.
1972
+ </div>
1973
+
1974
+
1975
+
1976
+ <dl class="param-type">
1977
+ <dt>
1978
+ Type
1979
+ </dt>
1980
+ <dd>
1981
+
1982
+ <span class="param-type">Promise.&lt;Array.&lt;Object>></span>
1983
+
1984
+
1985
+
1986
+ </dd>
1987
+ </dl>
1988
+
1989
+
1990
+
1991
+
1992
+
1993
+
1994
+
1995
+
1996
+
1997
+
1998
+ <h4 class="name" id="listRooms"><span class="type-signature type-signature-async">(async) </span>listRooms<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array>}</span></h4>
1999
+
2000
+
2001
+
2002
+
2003
+
2004
+
2005
+ <dl class="details">
2006
+
2007
+ <dt class="tag-description">Description:</dt>
2008
+ <dd class="tag-description"><ul class="dummy"><li>Lists all available rooms.</li></ul></dd>
2009
+
2010
+
2011
+
2012
+ <dt class="tag-source">Source:</dt>
2013
+ <dd class="tag-source"><ul class="dummy"><li>
2014
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1598">line 1598</a>
2015
+ </li></ul></dd>
2016
+
2017
+
2018
+
2019
+
2020
+
2021
+
2022
+
2023
+
2024
+
2025
+
2026
+
2027
+
2028
+
2029
+
2030
+
2031
+
2032
+
2033
+
2034
+
2035
+
2036
+
2037
+
2038
+
2039
+
2040
+
2041
+
2042
+
2043
+
2044
+
2045
+
2046
+
2047
+ </dl>
2048
+
2049
+
2050
+
2051
+
2052
+
2053
+
2054
+
2055
+
2056
+
2057
+
2058
+
2059
+
2060
+
2061
+
2062
+
2063
+
2064
+
2065
+
2066
+
2067
+
2068
+
2069
+
2070
+
2071
+
2072
+
2073
+
2074
+
2075
+ <h5 class="h5-returns">Returns:</h5>
2076
+
2077
+
2078
+ <div class="param-desc">
2079
+ List of rooms
2080
+ </div>
2081
+
2082
+
2083
+
2084
+ <dl class="param-type">
2085
+ <dt>
2086
+ Type
2087
+ </dt>
2088
+ <dd>
2089
+
2090
+ <span class="param-type">Promise.&lt;Array></span>
2091
+
2092
+
2093
+
2094
+ </dd>
2095
+ </dl>
2096
+
2097
+
2098
+
2099
+
2100
+
2101
+
2102
+
2103
+
2104
+
2105
+
2106
+ <h4 class="name" id="onConnectionStats"><span class="type-signature"></span>onConnectionStats<span class="signature">(callback)</span><span class="type-signature"></span></h4>
2107
+
2108
+
2109
+
2110
+
2111
+
2112
+
2113
+ <dl class="details">
2114
+
2115
+ <dt class="tag-description">Description:</dt>
2116
+ <dd class="tag-description"><ul class="dummy"><li>Register a callback to receive connection statistics</li></ul></dd>
2117
+
2118
+
2119
+
2120
+ <dt class="tag-source">Source:</dt>
2121
+ <dd class="tag-source"><ul class="dummy"><li>
2122
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1754">line 1754</a>
2123
+ </li></ul></dd>
2124
+
2125
+
2126
+
2127
+
2128
+
2129
+
2130
+
2131
+
2132
+
2133
+
2134
+
2135
+
2136
+
2137
+
2138
+
2139
+
2140
+
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+
2147
+
2148
+
2149
+
2150
+
2151
+
2152
+
2153
+
2154
+
2155
+ </dl>
2156
+
2157
+
2158
+
2159
+
2160
+
2161
+
2162
+
2163
+
2164
+
2165
+
2166
+
2167
+
2168
+
2169
+ <h5 class="h5-parameters">Parameters:</h5>
2170
+
2171
+
2172
+ <table class="params">
2173
+ <thead>
2174
+ <tr>
2175
+
2176
+ <th>Name</th>
2177
+
2178
+
2179
+ <th>Type</th>
2180
+
2181
+
2182
+
2183
+
2184
+
2185
+ <th class="last">Description</th>
2186
+ </tr>
2187
+ </thead>
2188
+
2189
+ <tbody>
2190
+
2191
+
2192
+ <tr>
2193
+
2194
+ <td class="name"><code>callback</code></td>
2195
+
2196
+
2197
+ <td class="type">
2198
+
2199
+
2200
+ <span class="param-type">function</span>
2201
+
2202
+
2203
+
2204
+
2205
+ </td>
2206
+
2207
+
2208
+
2209
+
2210
+
2211
+ <td class="description last">Function to receive stats updates</td>
2212
+ </tr>
2213
+
2214
+
2215
+ </tbody>
2216
+ </table>
2217
+
2218
+
2219
+
2220
+
2221
+
2222
+
2223
+
2224
+
2225
+
2226
+
2227
+
2228
+
2229
+
2230
+
2231
+
2232
+
2233
+
2234
+
2235
+
2236
+
2237
+
2238
+
2239
+
2240
+
2241
+ <h4 class="name" id="onDataMessage"><span class="type-signature"></span>onDataMessage<span class="signature">(callback)</span><span class="type-signature"></span></h4>
2242
+
2243
+
2244
+
2245
+
2246
+
2247
+
2248
+ <dl class="details">
2249
+
2250
+ <dt class="tag-description">Description:</dt>
2251
+ <dd class="tag-description"><ul class="dummy"><li>Registers a callback for incoming data messages.</li></ul></dd>
2252
+
2253
+
2254
+
2255
+ <dt class="tag-source">Source:</dt>
2256
+ <dd class="tag-source"><ul class="dummy"><li>
2257
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line224">line 224</a>
2258
+ </li></ul></dd>
2259
+
2260
+
2261
+
2262
+
2263
+
2264
+
2265
+
2266
+
2267
+
2268
+
2269
+
2270
+
2271
+
2272
+
2273
+
2274
+
2275
+
2276
+
2277
+
2278
+
2279
+
2280
+
2281
+
2282
+
2283
+
2284
+
2285
+
2286
+
2287
+
2288
+
2289
+
2290
+ </dl>
2291
+
2292
+
2293
+
2294
+
2295
+
2296
+
2297
+
2298
+
2299
+
2300
+
2301
+
2302
+
2303
+
2304
+ <h5 class="h5-parameters">Parameters:</h5>
2305
+
2306
+
2307
+ <table class="params">
2308
+ <thead>
2309
+ <tr>
2310
+
2311
+ <th>Name</th>
2312
+
2313
+
2314
+ <th>Type</th>
2315
+
2316
+
2317
+
2318
+
2319
+
2320
+ <th class="last">Description</th>
2321
+ </tr>
2322
+ </thead>
2323
+
2324
+ <tbody>
2325
+
2326
+
2327
+ <tr>
2328
+
2329
+ <td class="name"><code>callback</code></td>
2330
+
2331
+
2332
+ <td class="type">
2333
+
2334
+
2335
+ <span class="param-type">function</span>
2336
+
2337
+
2338
+
2339
+
2340
+ </td>
2341
+
2342
+
2343
+
2344
+
2345
+
2346
+ <td class="description last">The callback function to handle data messages.</td>
2347
+ </tr>
2348
+
2349
+
2350
+ </tbody>
2351
+ </table>
2352
+
2353
+
2354
+
2355
+
2356
+
2357
+
2358
+
2359
+
2360
+
2361
+
2362
+
2363
+
2364
+
2365
+
2366
+
2367
+
2368
+
2369
+
2370
+
2371
+
2372
+
2373
+
2374
+
2375
+
2376
+ <h4 class="name" id="onParticipantJoined"><span class="type-signature"></span>onParticipantJoined<span class="signature">(callback)</span><span class="type-signature"></span></h4>
2377
+
2378
+
2379
+
2380
+
2381
+
2382
+
2383
+ <dl class="details">
2384
+
2385
+ <dt class="tag-description">Description:</dt>
2386
+ <dd class="tag-description"><ul class="dummy"><li>Registers a callback for participant joined events.</li></ul></dd>
2387
+
2388
+
2389
+
2390
+ <dt class="tag-source">Source:</dt>
2391
+ <dd class="tag-source"><ul class="dummy"><li>
2392
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line232">line 232</a>
2393
+ </li></ul></dd>
2394
+
2395
+
2396
+
2397
+
2398
+
2399
+
2400
+
2401
+
2402
+
2403
+
2404
+
2405
+
2406
+
2407
+
2408
+
2409
+
2410
+
2411
+
2412
+
2413
+
2414
+
2415
+
2416
+
2417
+
2418
+
2419
+
2420
+
2421
+
2422
+
2423
+
2424
+
2425
+ </dl>
2426
+
2427
+
2428
+
2429
+
2430
+
2431
+
2432
+
2433
+
2434
+
2435
+
2436
+
2437
+
2438
+
2439
+ <h5 class="h5-parameters">Parameters:</h5>
2440
+
2441
+
2442
+ <table class="params">
2443
+ <thead>
2444
+ <tr>
2445
+
2446
+ <th>Name</th>
2447
+
2448
+
2449
+ <th>Type</th>
2450
+
2451
+
2452
+
2453
+
2454
+
2455
+ <th class="last">Description</th>
2456
+ </tr>
2457
+ </thead>
2458
+
2459
+ <tbody>
2460
+
2461
+
2462
+ <tr>
2463
+
2464
+ <td class="name"><code>callback</code></td>
2465
+
2466
+
2467
+ <td class="type">
2468
+
2469
+
2470
+ <span class="param-type">function</span>
2471
+
2472
+
2473
+
2474
+
2475
+ </td>
2476
+
2477
+
2478
+
2479
+
2480
+
2481
+ <td class="description last">The callback function to handle participant joins.</td>
2482
+ </tr>
2483
+
2484
+
2485
+ </tbody>
2486
+ </table>
2487
+
2488
+
2489
+
2490
+
2491
+
2492
+
2493
+
2494
+
2495
+
2496
+
2497
+
2498
+
2499
+
2500
+
2501
+
2502
+
2503
+
2504
+
2505
+
2506
+
2507
+
2508
+
2509
+
2510
+
2511
+ <h4 class="name" id="onParticipantLeft"><span class="type-signature"></span>onParticipantLeft<span class="signature">(callback)</span><span class="type-signature"></span></h4>
2512
+
2513
+
2514
+
2515
+
2516
+
2517
+
2518
+ <dl class="details">
2519
+
2520
+ <dt class="tag-description">Description:</dt>
2521
+ <dd class="tag-description"><ul class="dummy"><li>Registers a callback for participant left events.</li></ul></dd>
2522
+
2523
+
2524
+
2525
+ <dt class="tag-source">Source:</dt>
2526
+ <dd class="tag-source"><ul class="dummy"><li>
2527
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line240">line 240</a>
2528
+ </li></ul></dd>
2529
+
2530
+
2531
+
2532
+
2533
+
2534
+
2535
+
2536
+
2537
+
2538
+
2539
+
2540
+
2541
+
2542
+
2543
+
2544
+
2545
+
2546
+
2547
+
2548
+
2549
+
2550
+
2551
+
2552
+
2553
+
2554
+
2555
+
2556
+
2557
+
2558
+
2559
+
2560
+ </dl>
2561
+
2562
+
2563
+
2564
+
2565
+
2566
+
2567
+
2568
+
2569
+
2570
+
2571
+
2572
+
2573
+
2574
+ <h5 class="h5-parameters">Parameters:</h5>
2575
+
2576
+
2577
+ <table class="params">
2578
+ <thead>
2579
+ <tr>
2580
+
2581
+ <th>Name</th>
2582
+
2583
+
2584
+ <th>Type</th>
2585
+
2586
+
2587
+
2588
+
2589
+
2590
+ <th class="last">Description</th>
2591
+ </tr>
2592
+ </thead>
2593
+
2594
+ <tbody>
2595
+
2596
+
2597
+ <tr>
2598
+
2599
+ <td class="name"><code>callback</code></td>
2600
+
2601
+
2602
+ <td class="type">
2603
+
2604
+
2605
+ <span class="param-type">function</span>
2606
+
2607
+
2608
+
2609
+
2610
+ </td>
2611
+
2612
+
2613
+
2614
+
2615
+
2616
+ <td class="description last">The callback function to handle participant departures.</td>
2617
+ </tr>
2618
+
2619
+
2620
+ </tbody>
2621
+ </table>
2622
+
2623
+
2624
+
2625
+
2626
+
2627
+
2628
+
2629
+
2630
+
2631
+
2632
+
2633
+
2634
+
2635
+
2636
+
2637
+
2638
+
2639
+
2640
+
2641
+
2642
+
2643
+
2644
+
2645
+
2646
+ <h4 class="name" id="onRemoteTrack"><span class="type-signature"></span>onRemoteTrack<span class="signature">(callback)</span><span class="type-signature"></span></h4>
2647
+
2648
+
2649
+
2650
+
2651
+
2652
+
2653
+ <dl class="details">
2654
+
2655
+ <dt class="tag-description">Description:</dt>
2656
+ <dd class="tag-description"><ul class="dummy"><li>Registers a callback for remote track events.</li></ul></dd>
2657
+
2658
+
2659
+
2660
+ <dt class="tag-source">Source:</dt>
2661
+ <dd class="tag-source"><ul class="dummy"><li>
2662
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line208">line 208</a>
2663
+ </li></ul></dd>
2664
+
2665
+
2666
+
2667
+
2668
+
2669
+
2670
+
2671
+
2672
+
2673
+
2674
+
2675
+
2676
+
2677
+
2678
+
2679
+
2680
+
2681
+
2682
+
2683
+
2684
+
2685
+
2686
+
2687
+
2688
+
2689
+
2690
+
2691
+
2692
+
2693
+
2694
+
2695
+ </dl>
2696
+
2697
+
2698
+
2699
+
2700
+
2701
+
2702
+
2703
+
2704
+
2705
+
2706
+
2707
+
2708
+
2709
+ <h5 class="h5-parameters">Parameters:</h5>
2710
+
2711
+
2712
+ <table class="params">
2713
+ <thead>
2714
+ <tr>
2715
+
2716
+ <th>Name</th>
2717
+
2718
+
2719
+ <th>Type</th>
2720
+
2721
+
2722
+
2723
+
2724
+
2725
+ <th class="last">Description</th>
2726
+ </tr>
2727
+ </thead>
2728
+
2729
+ <tbody>
2730
+
2731
+
2732
+ <tr>
2733
+
2734
+ <td class="name"><code>callback</code></td>
2735
+
2736
+
2737
+ <td class="type">
2738
+
2739
+
2740
+ <span class="param-type">function</span>
2741
+
2742
+
2743
+
2744
+
2745
+ </td>
2746
+
2747
+
2748
+
2749
+
2750
+
2751
+ <td class="description last">The callback function to handle remote tracks.</td>
2752
+ </tr>
2753
+
2754
+
2755
+ </tbody>
2756
+ </table>
2757
+
2758
+
2759
+
2760
+
2761
+
2762
+
2763
+
2764
+
2765
+
2766
+
2767
+
2768
+
2769
+
2770
+
2771
+
2772
+
2773
+
2774
+
2775
+
2776
+
2777
+
2778
+
2779
+
2780
+
2781
+ <h4 class="name" id="onRemoteTrackUnpublished"><span class="type-signature"></span>onRemoteTrackUnpublished<span class="signature">(callback)</span><span class="type-signature"></span></h4>
2782
+
2783
+
2784
+
2785
+
2786
+
2787
+
2788
+ <dl class="details">
2789
+
2790
+ <dt class="tag-description">Description:</dt>
2791
+ <dd class="tag-description"><ul class="dummy"><li>Registers a callback for remote track unpublished events.</li></ul></dd>
2792
+
2793
+
2794
+
2795
+ <dt class="tag-source">Source:</dt>
2796
+ <dd class="tag-source"><ul class="dummy"><li>
2797
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line216">line 216</a>
2798
+ </li></ul></dd>
2799
+
2800
+
2801
+
2802
+
2803
+
2804
+
2805
+
2806
+
2807
+
2808
+
2809
+
2810
+
2811
+
2812
+
2813
+
2814
+
2815
+
2816
+
2817
+
2818
+
2819
+
2820
+
2821
+
2822
+
2823
+
2824
+
2825
+
2826
+
2827
+
2828
+
2829
+
2830
+ </dl>
2831
+
2832
+
2833
+
2834
+
2835
+
2836
+
2837
+
2838
+
2839
+
2840
+
2841
+
2842
+
2843
+
2844
+ <h5 class="h5-parameters">Parameters:</h5>
2845
+
2846
+
2847
+ <table class="params">
2848
+ <thead>
2849
+ <tr>
2850
+
2851
+ <th>Name</th>
2852
+
2853
+
2854
+ <th>Type</th>
2855
+
2856
+
2857
+
2858
+
2859
+
2860
+ <th class="last">Description</th>
2861
+ </tr>
2862
+ </thead>
2863
+
2864
+ <tbody>
2865
+
2866
+
2867
+ <tr>
2868
+
2869
+ <td class="name"><code>callback</code></td>
2870
+
2871
+
2872
+ <td class="type">
2873
+
2874
+
2875
+ <span class="param-type">function</span>
2876
+
2877
+
2878
+
2879
+
2880
+ </td>
2881
+
2882
+
2883
+
2884
+
2885
+
2886
+ <td class="description last">The callback function to handle track unpublished events.</td>
2887
+ </tr>
2888
+
2889
+
2890
+ </tbody>
2891
+ </table>
2892
+
2893
+
2894
+
2895
+
2896
+
2897
+
2898
+
2899
+
2900
+
2901
+
2902
+
2903
+
2904
+
2905
+
2906
+
2907
+
2908
+
2909
+
2910
+
2911
+
2912
+
2913
+
2914
+
2915
+
2916
+ <h4 class="name" id="onRoomMetadataUpdated"><span class="type-signature"></span>onRoomMetadataUpdated<span class="signature">(callback)</span><span class="type-signature"></span></h4>
2917
+
2918
+
2919
+
2920
+
2921
+
2922
+
2923
+ <dl class="details">
2924
+
2925
+ <dt class="tag-description">Description:</dt>
2926
+ <dd class="tag-description"><ul class="dummy"><li>Register callback for room metadata updates</li></ul></dd>
2927
+
2928
+
2929
+
2930
+ <dt class="tag-source">Source:</dt>
2931
+ <dd class="tag-source"><ul class="dummy"><li>
2932
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line278">line 278</a>
2933
+ </li></ul></dd>
2934
+
2935
+
2936
+
2937
+
2938
+
2939
+
2940
+
2941
+
2942
+
2943
+
2944
+
2945
+
2946
+
2947
+
2948
+
2949
+
2950
+
2951
+
2952
+
2953
+
2954
+
2955
+
2956
+
2957
+
2958
+
2959
+
2960
+
2961
+
2962
+
2963
+
2964
+
2965
+ </dl>
2966
+
2967
+
2968
+
2969
+
2970
+
2971
+
2972
+
2973
+
2974
+
2975
+
2976
+
2977
+
2978
+
2979
+ <h5 class="h5-parameters">Parameters:</h5>
2980
+
2981
+
2982
+ <table class="params">
2983
+ <thead>
2984
+ <tr>
2985
+
2986
+ <th>Name</th>
2987
+
2988
+
2989
+ <th>Type</th>
2990
+
2991
+
2992
+
2993
+
2994
+
2995
+ <th class="last">Description</th>
2996
+ </tr>
2997
+ </thead>
2998
+
2999
+ <tbody>
3000
+
3001
+
3002
+ <tr>
3003
+
3004
+ <td class="name"><code>callback</code></td>
3005
+
3006
+
3007
+ <td class="type">
3008
+
3009
+
3010
+ <span class="param-type">function</span>
3011
+
3012
+
3013
+
3014
+
3015
+ </td>
3016
+
3017
+
3018
+
3019
+
3020
+
3021
+ <td class="description last">Callback function</td>
3022
+ </tr>
3023
+
3024
+
3025
+ </tbody>
3026
+ </table>
3027
+
3028
+
3029
+
3030
+
3031
+
3032
+
3033
+
3034
+
3035
+
3036
+
3037
+
3038
+
3039
+
3040
+
3041
+
3042
+
3043
+
3044
+
3045
+
3046
+
3047
+
3048
+
3049
+
3050
+
3051
+ <h4 class="name" id="onTrackStatusChanged"><span class="type-signature"></span>onTrackStatusChanged<span class="signature">(callback)</span><span class="type-signature"></span></h4>
3052
+
3053
+
3054
+
3055
+
3056
+
3057
+
3058
+ <dl class="details">
3059
+
3060
+ <dt class="tag-description">Description:</dt>
3061
+ <dd class="tag-description"><ul class="dummy"><li>Registers a callback for track status changed events.</li></ul></dd>
3062
+
3063
+
3064
+
3065
+ <dt class="tag-source">Source:</dt>
3066
+ <dd class="tag-source"><ul class="dummy"><li>
3067
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line248">line 248</a>
3068
+ </li></ul></dd>
3069
+
3070
+
3071
+
3072
+
3073
+
3074
+
3075
+
3076
+
3077
+
3078
+
3079
+
3080
+
3081
+
3082
+
3083
+
3084
+
3085
+
3086
+
3087
+
3088
+
3089
+
3090
+
3091
+
3092
+
3093
+
3094
+
3095
+
3096
+
3097
+
3098
+
3099
+
3100
+ </dl>
3101
+
3102
+
3103
+
3104
+
3105
+
3106
+
3107
+
3108
+
3109
+
3110
+
3111
+
3112
+
3113
+
3114
+ <h5 class="h5-parameters">Parameters:</h5>
3115
+
3116
+
3117
+ <table class="params">
3118
+ <thead>
3119
+ <tr>
3120
+
3121
+ <th>Name</th>
3122
+
3123
+
3124
+ <th>Type</th>
3125
+
3126
+
3127
+
3128
+
3129
+
3130
+ <th class="last">Description</th>
3131
+ </tr>
3132
+ </thead>
3133
+
3134
+ <tbody>
3135
+
3136
+
3137
+ <tr>
3138
+
3139
+ <td class="name"><code>callback</code></td>
3140
+
3141
+
3142
+ <td class="type">
3143
+
3144
+
3145
+ <span class="param-type">function</span>
3146
+
3147
+
3148
+
3149
+
3150
+ </td>
3151
+
3152
+
3153
+
3154
+
3155
+
3156
+ <td class="description last">The callback function to handle track status changes.</td>
3157
+ </tr>
3158
+
3159
+
3160
+ </tbody>
3161
+ </table>
3162
+
3163
+
3164
+
3165
+
3166
+
3167
+
3168
+
3169
+
3170
+
3171
+
3172
+
3173
+
3174
+
3175
+
3176
+
3177
+
3178
+
3179
+
3180
+
3181
+
3182
+
3183
+
3184
+
3185
+
3186
+ <h4 class="name" id="onWebSocketMessage"><span class="type-signature"></span>onWebSocketMessage<span class="signature">(callback)</span><span class="type-signature"> &rarr; {function}</span></h4>
3187
+
3188
+
3189
+
3190
+
3191
+
3192
+
3193
+ <dl class="details">
3194
+
3195
+ <dt class="tag-description">Description:</dt>
3196
+ <dd class="tag-description"><ul class="dummy"><li>Registers a callback for WebSocket messages</li></ul></dd>
3197
+
3198
+
3199
+
3200
+ <dt class="tag-source">Source:</dt>
3201
+ <dd class="tag-source"><ul class="dummy"><li>
3202
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line257">line 257</a>
3203
+ </li></ul></dd>
3204
+
3205
+
3206
+
3207
+
3208
+
3209
+
3210
+
3211
+
3212
+
3213
+
3214
+
3215
+
3216
+
3217
+
3218
+
3219
+
3220
+
3221
+
3222
+
3223
+
3224
+
3225
+
3226
+
3227
+
3228
+
3229
+
3230
+
3231
+
3232
+
3233
+
3234
+
3235
+ </dl>
3236
+
3237
+
3238
+
3239
+
3240
+
3241
+
3242
+
3243
+
3244
+
3245
+
3246
+
3247
+
3248
+
3249
+ <h5 class="h5-parameters">Parameters:</h5>
3250
+
3251
+
3252
+ <table class="params">
3253
+ <thead>
3254
+ <tr>
3255
+
3256
+ <th>Name</th>
3257
+
3258
+
3259
+ <th>Type</th>
3260
+
3261
+
3262
+
3263
+
3264
+
3265
+ <th class="last">Description</th>
3266
+ </tr>
3267
+ </thead>
3268
+
3269
+ <tbody>
3270
+
3271
+
3272
+ <tr>
3273
+
3274
+ <td class="name"><code>callback</code></td>
3275
+
3276
+
3277
+ <td class="type">
3278
+
3279
+
3280
+ <span class="param-type">function</span>
3281
+
3282
+
3283
+
3284
+
3285
+ </td>
3286
+
3287
+
3288
+
3289
+
3290
+
3291
+ <td class="description last">Function to call when WebSocket messages are received</td>
3292
+ </tr>
3293
+
3294
+
3295
+ </tbody>
3296
+ </table>
3297
+
3298
+
3299
+
3300
+
3301
+
3302
+
3303
+
3304
+
3305
+
3306
+
3307
+
3308
+
3309
+
3310
+
3311
+
3312
+
3313
+ <h5 class="h5-returns">Returns:</h5>
3314
+
3315
+
3316
+ <div class="param-desc">
3317
+ Function to unregister the callback
3318
+ </div>
3319
+
3320
+
3321
+
3322
+ <dl class="param-type">
3323
+ <dt>
3324
+ Type
3325
+ </dt>
3326
+ <dd>
3327
+
3328
+ <span class="param-type">function</span>
3329
+
3330
+
3331
+
3332
+ </dd>
3333
+ </dl>
3334
+
3335
+
3336
+
3337
+
3338
+
3339
+
3340
+
3341
+
3342
+
3343
+
3344
+ <h4 class="name" id="previewMedia"><span class="type-signature type-signature-async">(async) </span>previewMedia<span class="signature">(params, previewElement<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;MediaStream>}</span></h4>
3345
+
3346
+
3347
+
3348
+
3349
+
3350
+
3351
+ <dl class="details">
3352
+
3353
+ <dt class="tag-description">Description:</dt>
3354
+ <dd class="tag-description"><ul class="dummy"><li>Previews media streams with specified device IDs.</li></ul></dd>
3355
+
3356
+
3357
+
3358
+ <dt class="tag-source">Source:</dt>
3359
+ <dd class="tag-source"><ul class="dummy"><li>
3360
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1163">line 1163</a>
3361
+ </li></ul></dd>
3362
+
3363
+
3364
+
3365
+
3366
+
3367
+
3368
+
3369
+
3370
+
3371
+
3372
+
3373
+
3374
+
3375
+
3376
+
3377
+
3378
+
3379
+
3380
+
3381
+
3382
+
3383
+
3384
+
3385
+
3386
+
3387
+
3388
+
3389
+
3390
+
3391
+
3392
+
3393
+ </dl>
3394
+
3395
+
3396
+
3397
+
3398
+
3399
+
3400
+
3401
+
3402
+
3403
+
3404
+
3405
+
3406
+
3407
+ <h5 class="h5-parameters">Parameters:</h5>
3408
+
3409
+
3410
+ <table class="params">
3411
+ <thead>
3412
+ <tr>
3413
+
3414
+ <th>Name</th>
3415
+
3416
+
3417
+ <th>Type</th>
3418
+
3419
+
3420
+ <th>Attributes</th>
3421
+
3422
+
3423
+
3424
+ <th>Default</th>
3425
+
3426
+
3427
+ <th class="last">Description</th>
3428
+ </tr>
3429
+ </thead>
3430
+
3431
+ <tbody>
3432
+
3433
+
3434
+ <tr>
3435
+
3436
+ <td class="name"><code>params</code></td>
3437
+
3438
+
3439
+ <td class="type">
3440
+
3441
+
3442
+ <span class="param-type">Object</span>
3443
+
3444
+
3445
+
3446
+
3447
+ </td>
3448
+
3449
+
3450
+ <td class="attributes">
3451
+
3452
+
3453
+
3454
+
3455
+
3456
+ </td>
3457
+
3458
+
3459
+
3460
+ <td class="default">
3461
+
3462
+ </td>
3463
+
3464
+
3465
+ <td class="description last">Parameters for media preview.
3466
+ <h6>Properties</h6>
3467
+
3468
+
3469
+ <table class="params">
3470
+ <thead>
3471
+ <tr>
3472
+
3473
+ <th>Name</th>
3474
+
3475
+
3476
+ <th>Type</th>
3477
+
3478
+
3479
+ <th>Attributes</th>
3480
+
3481
+
3482
+
3483
+
3484
+ <th class="last">Description</th>
3485
+ </tr>
3486
+ </thead>
3487
+
3488
+ <tbody>
3489
+
3490
+
3491
+ <tr>
3492
+
3493
+ <td class="name"><code>audioDeviceId</code></td>
3494
+
3495
+
3496
+ <td class="type">
3497
+
3498
+
3499
+ <span class="param-type">string</span>
3500
+
3501
+
3502
+
3503
+
3504
+ </td>
3505
+
3506
+
3507
+ <td class="attributes">
3508
+
3509
+ &lt;optional><br>
3510
+
3511
+
3512
+
3513
+
3514
+
3515
+ </td>
3516
+
3517
+
3518
+
3519
+
3520
+ <td class="description last">The ID of the audio input device to use.</td>
3521
+ </tr>
3522
+
3523
+
3524
+
3525
+ <tr>
3526
+
3527
+ <td class="name"><code>videoDeviceId</code></td>
3528
+
3529
+
3530
+ <td class="type">
3531
+
3532
+
3533
+ <span class="param-type">string</span>
3534
+
3535
+
3536
+
3537
+
3538
+ </td>
3539
+
3540
+
3541
+ <td class="attributes">
3542
+
3543
+ &lt;optional><br>
3544
+
3545
+
3546
+
3547
+
3548
+
3549
+ </td>
3550
+
3551
+
3552
+
3553
+
3554
+ <td class="description last">The ID of the video input device to use.</td>
3555
+ </tr>
3556
+
3557
+
3558
+ </tbody>
3559
+ </table>
3560
+
3561
+ </td>
3562
+ </tr>
3563
+
3564
+
3565
+
3566
+ <tr>
3567
+
3568
+ <td class="name"><code>previewElement</code></td>
3569
+
3570
+
3571
+ <td class="type">
3572
+
3573
+
3574
+ <span class="param-type">HTMLMediaElement</span>
3575
+
3576
+
3577
+
3578
+
3579
+ </td>
3580
+
3581
+
3582
+ <td class="attributes">
3583
+
3584
+ &lt;optional><br>
3585
+
3586
+
3587
+
3588
+
3589
+
3590
+ </td>
3591
+
3592
+
3593
+
3594
+ <td class="default">
3595
+
3596
+ <code>null</code>
3597
+
3598
+ </td>
3599
+
3600
+
3601
+ <td class="description last">The media element to display the preview.</td>
3602
+ </tr>
3603
+
3604
+
3605
+ </tbody>
3606
+ </table>
3607
+
3608
+
3609
+
3610
+
3611
+
3612
+
3613
+
3614
+
3615
+
3616
+
3617
+
3618
+
3619
+
3620
+
3621
+ <h5 class="h5-throws">Throws:</h5>
3622
+
3623
+
3624
+
3625
+ <dl>
3626
+ <dt>
3627
+ <div class="param-desc usertext">
3628
+ If there is an issue accessing the media devices.
3629
+ </div>
3630
+ </dt>
3631
+ <dd></dd>
3632
+ <dt>
3633
+ <dl class="param-type">
3634
+ <dt>
3635
+ Type
3636
+ </dt>
3637
+ <dd>
3638
+
3639
+ <span class="param-type">Error</span>
3640
+
3641
+
3642
+
3643
+ </dd>
3644
+ </dl>
3645
+ </dt>
3646
+ <dd></dd>
3647
+ </dl>
3648
+
3649
+
3650
+
3651
+
3652
+
3653
+ <h5 class="h5-returns">Returns:</h5>
3654
+
3655
+
3656
+ <div class="param-desc">
3657
+ The media stream being previewed.
3658
+ </div>
3659
+
3660
+
3661
+
3662
+ <dl class="param-type">
3663
+ <dt>
3664
+ Type
3665
+ </dt>
3666
+ <dd>
3667
+
3668
+ <span class="param-type">Promise.&lt;MediaStream></span>
3669
+
3670
+
3671
+
3672
+ </dd>
3673
+ </dl>
3674
+
3675
+
3676
+
3677
+
3678
+
3679
+
3680
+
3681
+
3682
+
3683
+
3684
+ <h4 class="name" id="publishTracks"><span class="type-signature type-signature-async">(async) </span>publishTracks<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
3685
+
3686
+
3687
+
3688
+
3689
+
3690
+
3691
+ <dl class="details">
3692
+
3693
+ <dt class="tag-description">Description:</dt>
3694
+ <dd class="tag-description"><ul class="dummy"><li>Publishes the local media tracks to the room.</li></ul></dd>
3695
+
3696
+
3697
+
3698
+ <dt class="tag-source">Source:</dt>
3699
+ <dd class="tag-source"><ul class="dummy"><li>
3700
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line491">line 491</a>
3701
+ </li></ul></dd>
3702
+
3703
+
3704
+
3705
+
3706
+
3707
+
3708
+
3709
+
3710
+
3711
+
3712
+
3713
+
3714
+
3715
+
3716
+
3717
+
3718
+
3719
+
3720
+
3721
+
3722
+
3723
+
3724
+
3725
+
3726
+
3727
+
3728
+
3729
+
3730
+
3731
+
3732
+
3733
+ </dl>
3734
+
3735
+
3736
+
3737
+
3738
+
3739
+
3740
+
3741
+
3742
+
3743
+
3744
+
3745
+
3746
+
3747
+
3748
+
3749
+
3750
+
3751
+
3752
+
3753
+
3754
+
3755
+
3756
+
3757
+
3758
+
3759
+ <h5 class="h5-throws">Throws:</h5>
3760
+
3761
+
3762
+
3763
+ <dl>
3764
+ <dt>
3765
+ <div class="param-desc usertext">
3766
+ If there is no local media stream to publish.
3767
+ </div>
3768
+ </dt>
3769
+ <dd></dd>
3770
+ <dt>
3771
+ <dl class="param-type">
3772
+ <dt>
3773
+ Type
3774
+ </dt>
3775
+ <dd>
3776
+
3777
+ <span class="param-type">Error</span>
3778
+
3779
+
3780
+
3781
+ </dd>
3782
+ </dl>
3783
+ </dt>
3784
+ <dd></dd>
3785
+ </dl>
3786
+
3787
+
3788
+
3789
+
3790
+
3791
+ <h5 class="h5-returns">Returns:</h5>
3792
+
3793
+
3794
+
3795
+
3796
+ <dl class="param-type">
3797
+ <dt>
3798
+ Type
3799
+ </dt>
3800
+ <dd>
3801
+
3802
+ <span class="param-type">Promise.&lt;void></span>
3803
+
3804
+
3805
+
3806
+ </dd>
3807
+ </dl>
3808
+
3809
+
3810
+
3811
+
3812
+
3813
+
3814
+
3815
+
3816
+
3817
+
3818
+ <h4 class="name" id="selectAudioInputDevice"><span class="type-signature type-signature-async">(async) </span>selectAudioInputDevice<span class="signature">(deviceId)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
3819
+
3820
+
3821
+
3822
+
3823
+
3824
+
3825
+ <dl class="details">
3826
+
3827
+ <dt class="tag-description">Description:</dt>
3828
+ <dd class="tag-description"><ul class="dummy"><li>Selects a specific audio input device.</li></ul></dd>
3829
+
3830
+
3831
+
3832
+ <dt class="tag-source">Source:</dt>
3833
+ <dd class="tag-source"><ul class="dummy"><li>
3834
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1063">line 1063</a>
3835
+ </li></ul></dd>
3836
+
3837
+
3838
+
3839
+
3840
+
3841
+
3842
+
3843
+
3844
+
3845
+
3846
+
3847
+
3848
+
3849
+
3850
+
3851
+
3852
+
3853
+
3854
+
3855
+
3856
+
3857
+
3858
+
3859
+
3860
+
3861
+
3862
+
3863
+
3864
+
3865
+
3866
+
3867
+ </dl>
3868
+
3869
+
3870
+
3871
+
3872
+
3873
+
3874
+
3875
+
3876
+
3877
+
3878
+
3879
+
3880
+
3881
+ <h5 class="h5-parameters">Parameters:</h5>
3882
+
3883
+
3884
+ <table class="params">
3885
+ <thead>
3886
+ <tr>
3887
+
3888
+ <th>Name</th>
3889
+
3890
+
3891
+ <th>Type</th>
3892
+
3893
+
3894
+
3895
+
3896
+
3897
+ <th class="last">Description</th>
3898
+ </tr>
3899
+ </thead>
3900
+
3901
+ <tbody>
3902
+
3903
+
3904
+ <tr>
3905
+
3906
+ <td class="name"><code>deviceId</code></td>
3907
+
3908
+
3909
+ <td class="type">
3910
+
3911
+
3912
+ <span class="param-type">string</span>
3913
+
3914
+
3915
+
3916
+
3917
+ </td>
3918
+
3919
+
3920
+
3921
+
3922
+
3923
+ <td class="description last">The ID of the audio input device to select.</td>
3924
+ </tr>
3925
+
3926
+
3927
+ </tbody>
3928
+ </table>
3929
+
3930
+
3931
+
3932
+
3933
+
3934
+
3935
+
3936
+
3937
+
3938
+
3939
+
3940
+
3941
+
3942
+
3943
+
3944
+
3945
+ <h5 class="h5-returns">Returns:</h5>
3946
+
3947
+
3948
+
3949
+
3950
+ <dl class="param-type">
3951
+ <dt>
3952
+ Type
3953
+ </dt>
3954
+ <dd>
3955
+
3956
+ <span class="param-type">Promise.&lt;void></span>
3957
+
3958
+
3959
+
3960
+ </dd>
3961
+ </dl>
3962
+
3963
+
3964
+
3965
+
3966
+
3967
+
3968
+
3969
+
3970
+
3971
+
3972
+ <h4 class="name" id="selectAudioOutputDevice"><span class="type-signature type-signature-async">(async) </span>selectAudioOutputDevice<span class="signature">(deviceId)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
3973
+
3974
+
3975
+
3976
+
3977
+
3978
+
3979
+ <dl class="details">
3980
+
3981
+ <dt class="tag-description">Description:</dt>
3982
+ <dd class="tag-description"><ul class="dummy"><li>Selects a specific audio output device.</li></ul></dd>
3983
+
3984
+
3985
+
3986
+ <dt class="tag-source">Source:</dt>
3987
+ <dd class="tag-source"><ul class="dummy"><li>
3988
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1135">line 1135</a>
3989
+ </li></ul></dd>
3990
+
3991
+
3992
+
3993
+
3994
+
3995
+
3996
+
3997
+
3998
+
3999
+
4000
+
4001
+
4002
+
4003
+
4004
+
4005
+
4006
+
4007
+
4008
+
4009
+
4010
+
4011
+
4012
+
4013
+
4014
+
4015
+
4016
+
4017
+
4018
+
4019
+
4020
+
4021
+ </dl>
4022
+
4023
+
4024
+
4025
+
4026
+
4027
+
4028
+
4029
+
4030
+
4031
+
4032
+
4033
+
4034
+
4035
+ <h5 class="h5-parameters">Parameters:</h5>
4036
+
4037
+
4038
+ <table class="params">
4039
+ <thead>
4040
+ <tr>
4041
+
4042
+ <th>Name</th>
4043
+
4044
+
4045
+ <th>Type</th>
4046
+
4047
+
4048
+
4049
+
4050
+
4051
+ <th class="last">Description</th>
4052
+ </tr>
4053
+ </thead>
4054
+
4055
+ <tbody>
4056
+
4057
+
4058
+ <tr>
4059
+
4060
+ <td class="name"><code>deviceId</code></td>
4061
+
4062
+
4063
+ <td class="type">
4064
+
4065
+
4066
+ <span class="param-type">string</span>
4067
+
4068
+
4069
+
4070
+
4071
+ </td>
4072
+
4073
+
4074
+
4075
+
4076
+
4077
+ <td class="description last">The ID of the audio output device to select.</td>
4078
+ </tr>
4079
+
4080
+
4081
+ </tbody>
4082
+ </table>
4083
+
4084
+
4085
+
4086
+
4087
+
4088
+
4089
+
4090
+
4091
+
4092
+
4093
+
4094
+
4095
+
4096
+
4097
+
4098
+
4099
+ <h5 class="h5-returns">Returns:</h5>
4100
+
4101
+
4102
+
4103
+
4104
+ <dl class="param-type">
4105
+ <dt>
4106
+ Type
4107
+ </dt>
4108
+ <dd>
4109
+
4110
+ <span class="param-type">Promise.&lt;void></span>
4111
+
4112
+
4113
+
4114
+ </dd>
4115
+ </dl>
4116
+
4117
+
4118
+
4119
+
4120
+
4121
+
4122
+
4123
+
4124
+
4125
+
4126
+ <h4 class="name" id="selectVideoInputDevice"><span class="type-signature type-signature-async">(async) </span>selectVideoInputDevice<span class="signature">(deviceId)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
4127
+
4128
+
4129
+
4130
+
4131
+
4132
+
4133
+ <dl class="details">
4134
+
4135
+ <dt class="tag-description">Description:</dt>
4136
+ <dd class="tag-description"><ul class="dummy"><li>Selects a specific video input device.</li></ul></dd>
4137
+
4138
+
4139
+
4140
+ <dt class="tag-source">Source:</dt>
4141
+ <dd class="tag-source"><ul class="dummy"><li>
4142
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1099">line 1099</a>
4143
+ </li></ul></dd>
4144
+
4145
+
4146
+
4147
+
4148
+
4149
+
4150
+
4151
+
4152
+
4153
+
4154
+
4155
+
4156
+
4157
+
4158
+
4159
+
4160
+
4161
+
4162
+
4163
+
4164
+
4165
+
4166
+
4167
+
4168
+
4169
+
4170
+
4171
+
4172
+
4173
+
4174
+
4175
+ </dl>
4176
+
4177
+
4178
+
4179
+
4180
+
4181
+
4182
+
4183
+
4184
+
4185
+
4186
+
4187
+
4188
+
4189
+ <h5 class="h5-parameters">Parameters:</h5>
4190
+
4191
+
4192
+ <table class="params">
4193
+ <thead>
4194
+ <tr>
4195
+
4196
+ <th>Name</th>
4197
+
4198
+
4199
+ <th>Type</th>
4200
+
4201
+
4202
+
4203
+
4204
+
4205
+ <th class="last">Description</th>
4206
+ </tr>
4207
+ </thead>
4208
+
4209
+ <tbody>
4210
+
4211
+
4212
+ <tr>
4213
+
4214
+ <td class="name"><code>deviceId</code></td>
4215
+
4216
+
4217
+ <td class="type">
4218
+
4219
+
4220
+ <span class="param-type">string</span>
4221
+
4222
+
4223
+
4224
+
4225
+ </td>
4226
+
4227
+
4228
+
4229
+
4230
+
4231
+ <td class="description last">The ID of the video input device to select.</td>
4232
+ </tr>
4233
+
4234
+
4235
+ </tbody>
4236
+ </table>
4237
+
4238
+
4239
+
4240
+
4241
+
4242
+
4243
+
4244
+
4245
+
4246
+
4247
+
4248
+
4249
+
4250
+
4251
+
4252
+
4253
+ <h5 class="h5-returns">Returns:</h5>
4254
+
4255
+
4256
+
4257
+
4258
+ <dl class="param-type">
4259
+ <dt>
4260
+ Type
4261
+ </dt>
4262
+ <dd>
4263
+
4264
+ <span class="param-type">Promise.&lt;void></span>
4265
+
4266
+
4267
+
4268
+ </dd>
4269
+ </dl>
4270
+
4271
+
4272
+
4273
+
4274
+
4275
+
4276
+
4277
+
4278
+
4279
+
4280
+ <h4 class="name" id="sendDataToAll"><span class="type-signature type-signature-async">(async) </span>sendDataToAll<span class="signature">(data)</span><span class="type-signature"> &rarr; {void}</span></h4>
4281
+
4282
+
4283
+
4284
+
4285
+
4286
+
4287
+ <dl class="details">
4288
+
4289
+ <dt class="tag-description">Description:</dt>
4290
+ <dd class="tag-description"><ul class="dummy"><li>Send a data message to all participants in the room via WebSocket.</li></ul></dd>
4291
+
4292
+
4293
+
4294
+ <dt class="tag-source">Source:</dt>
4295
+ <dd class="tag-source"><ul class="dummy"><li>
4296
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1629">line 1629</a>
4297
+ </li></ul></dd>
4298
+
4299
+
4300
+
4301
+
4302
+
4303
+
4304
+
4305
+
4306
+
4307
+
4308
+
4309
+
4310
+
4311
+
4312
+
4313
+
4314
+
4315
+
4316
+
4317
+
4318
+
4319
+
4320
+
4321
+
4322
+
4323
+
4324
+
4325
+
4326
+
4327
+
4328
+
4329
+ </dl>
4330
+
4331
+
4332
+
4333
+
4334
+
4335
+
4336
+
4337
+
4338
+
4339
+
4340
+
4341
+
4342
+
4343
+ <h5 class="h5-parameters">Parameters:</h5>
4344
+
4345
+
4346
+ <table class="params">
4347
+ <thead>
4348
+ <tr>
4349
+
4350
+ <th>Name</th>
4351
+
4352
+
4353
+ <th>Type</th>
4354
+
4355
+
4356
+
4357
+
4358
+
4359
+ <th class="last">Description</th>
4360
+ </tr>
4361
+ </thead>
4362
+
4363
+ <tbody>
4364
+
4365
+
4366
+ <tr>
4367
+
4368
+ <td class="name"><code>data</code></td>
4369
+
4370
+
4371
+ <td class="type">
4372
+
4373
+
4374
+ <span class="param-type">Object</span>
4375
+
4376
+
4377
+
4378
+
4379
+ </td>
4380
+
4381
+
4382
+
4383
+
4384
+
4385
+ <td class="description last">The JSON object to send.</td>
4386
+ </tr>
4387
+
4388
+
4389
+ </tbody>
4390
+ </table>
4391
+
4392
+
4393
+
4394
+
4395
+
4396
+
4397
+
4398
+
4399
+
4400
+
4401
+
4402
+
4403
+
4404
+
4405
+
4406
+
4407
+ <h5 class="h5-returns">Returns:</h5>
4408
+
4409
+
4410
+
4411
+
4412
+ <dl class="param-type">
4413
+ <dt>
4414
+ Type
4415
+ </dt>
4416
+ <dd>
4417
+
4418
+ <span class="param-type">void</span>
4419
+
4420
+
4421
+
4422
+ </dd>
4423
+ </dl>
4424
+
4425
+
4426
+
4427
+
4428
+
4429
+
4430
+
4431
+
4432
+
4433
+
4434
+ <h4 class="name" id="setDebugMode"><span class="type-signature"></span>setDebugMode<span class="signature">(enabled)</span><span class="type-signature"></span></h4>
4435
+
4436
+
4437
+
4438
+
4439
+
4440
+
4441
+ <dl class="details">
4442
+
4443
+ <dt class="tag-description">Description:</dt>
4444
+ <dd class="tag-description"><ul class="dummy"><li>Enable or disable debug logging</li></ul></dd>
4445
+
4446
+
4447
+
4448
+ <dt class="tag-source">Source:</dt>
4449
+ <dd class="tag-source"><ul class="dummy"><li>
4450
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line163">line 163</a>
4451
+ </li></ul></dd>
4452
+
4453
+
4454
+
4455
+
4456
+
4457
+
4458
+
4459
+
4460
+
4461
+
4462
+
4463
+
4464
+
4465
+
4466
+
4467
+
4468
+
4469
+
4470
+
4471
+
4472
+
4473
+
4474
+
4475
+
4476
+
4477
+
4478
+
4479
+
4480
+
4481
+
4482
+
4483
+ </dl>
4484
+
4485
+
4486
+
4487
+
4488
+
4489
+
4490
+
4491
+
4492
+
4493
+
4494
+
4495
+
4496
+
4497
+ <h5 class="h5-parameters">Parameters:</h5>
4498
+
4499
+
4500
+ <table class="params">
4501
+ <thead>
4502
+ <tr>
4503
+
4504
+ <th>Name</th>
4505
+
4506
+
4507
+ <th>Type</th>
4508
+
4509
+
4510
+
4511
+
4512
+
4513
+ <th class="last">Description</th>
4514
+ </tr>
4515
+ </thead>
4516
+
4517
+ <tbody>
4518
+
4519
+
4520
+ <tr>
4521
+
4522
+ <td class="name"><code>enabled</code></td>
4523
+
4524
+
4525
+ <td class="type">
4526
+
4527
+
4528
+ <span class="param-type">boolean</span>
4529
+
4530
+
4531
+
4532
+
4533
+ </td>
4534
+
4535
+
4536
+
4537
+
4538
+
4539
+ <td class="description last">Whether to enable debug logging</td>
4540
+ </tr>
4541
+
4542
+
4543
+ </tbody>
4544
+ </table>
4545
+
4546
+
4547
+
4548
+
4549
+
4550
+
4551
+
4552
+
4553
+
4554
+
4555
+
4556
+
4557
+
4558
+
4559
+
4560
+
4561
+
4562
+
4563
+
4564
+
4565
+
4566
+
4567
+
4568
+
4569
+ <h4 class="name" id="setMediaQuality"><span class="type-signature"></span>setMediaQuality<span class="signature">(quality)</span><span class="type-signature"></span></h4>
4570
+
4571
+
4572
+
4573
+
4574
+
4575
+
4576
+ <dl class="details">
4577
+
4578
+ <dt class="tag-description">Description:</dt>
4579
+ <dd class="tag-description"><ul class="dummy"><li>Sets the media quality for audio and video tracks</li></ul></dd>
4580
+
4581
+
4582
+
4583
+ <dt class="tag-source">Source:</dt>
4584
+ <dd class="tag-source"><ul class="dummy"><li>
4585
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1655">line 1655</a>
4586
+ </li></ul></dd>
4587
+
4588
+
4589
+
4590
+
4591
+
4592
+
4593
+
4594
+
4595
+
4596
+
4597
+
4598
+
4599
+
4600
+
4601
+
4602
+
4603
+
4604
+
4605
+
4606
+
4607
+
4608
+
4609
+
4610
+
4611
+
4612
+
4613
+
4614
+
4615
+
4616
+
4617
+
4618
+ </dl>
4619
+
4620
+
4621
+
4622
+
4623
+
4624
+
4625
+
4626
+
4627
+
4628
+
4629
+
4630
+
4631
+
4632
+ <h5 class="h5-parameters">Parameters:</h5>
4633
+
4634
+
4635
+ <table class="params">
4636
+ <thead>
4637
+ <tr>
4638
+
4639
+ <th>Name</th>
4640
+
4641
+
4642
+ <th>Type</th>
4643
+
4644
+
4645
+
4646
+
4647
+
4648
+ <th class="last">Description</th>
4649
+ </tr>
4650
+ </thead>
4651
+
4652
+ <tbody>
4653
+
4654
+
4655
+ <tr>
4656
+
4657
+ <td class="name"><code>quality</code></td>
4658
+
4659
+
4660
+ <td class="type">
4661
+
4662
+
4663
+ <span class="param-type">string</span>
4664
+ |
4665
+
4666
+ <span class="param-type"><a href="global.html#QualityPreset">QualityPreset</a></span>
4667
+
4668
+
4669
+
4670
+
4671
+ </td>
4672
+
4673
+
4674
+
4675
+
4676
+
4677
+ <td class="description last">Either a preset name ('high', 'medium', 'low') or a custom quality object
4678
+ <h6>Properties</h6>
4679
+
4680
+
4681
+ <table class="params">
4682
+ <thead>
4683
+ <tr>
4684
+
4685
+ <th>Name</th>
4686
+
4687
+
4688
+ <th>Type</th>
4689
+
4690
+
4691
+ <th>Attributes</th>
4692
+
4693
+
4694
+
4695
+
4696
+ <th class="last">Description</th>
4697
+ </tr>
4698
+ </thead>
4699
+
4700
+ <tbody>
4701
+
4702
+
4703
+ <tr>
4704
+
4705
+ <td class="name"><code>video</code></td>
4706
+
4707
+
4708
+ <td class="type">
4709
+
4710
+
4711
+ <span class="param-type"><a href="global.html#VideoQualitySettings">VideoQualitySettings</a></span>
4712
+
4713
+
4714
+
4715
+
4716
+ </td>
4717
+
4718
+
4719
+ <td class="attributes">
4720
+
4721
+ &lt;optional><br>
4722
+
4723
+
4724
+
4725
+
4726
+
4727
+ </td>
4728
+
4729
+
4730
+
4731
+
4732
+ <td class="description last">Video quality settings</td>
4733
+ </tr>
4734
+
4735
+
4736
+
4737
+ <tr>
4738
+
4739
+ <td class="name"><code>audio</code></td>
4740
+
4741
+
4742
+ <td class="type">
4743
+
4744
+
4745
+ <span class="param-type"><a href="global.html#AudioQualitySettings">AudioQualitySettings</a></span>
4746
+
4747
+
4748
+
4749
+
4750
+ </td>
4751
+
4752
+
4753
+ <td class="attributes">
4754
+
4755
+ &lt;optional><br>
4756
+
4757
+
4758
+
4759
+
4760
+
4761
+ </td>
4762
+
4763
+
4764
+
4765
+
4766
+ <td class="description last">Audio quality settings</td>
4767
+ </tr>
4768
+
4769
+
4770
+ </tbody>
4771
+ </table>
4772
+
4773
+ </td>
4774
+ </tr>
4775
+
4776
+
4777
+ </tbody>
4778
+ </table>
4779
+
4780
+
4781
+
4782
+
4783
+
4784
+
4785
+
4786
+
4787
+
4788
+
4789
+
4790
+
4791
+
4792
+
4793
+ <h5 class="h5-throws">Throws:</h5>
4794
+
4795
+
4796
+
4797
+ <dl>
4798
+ <dt>
4799
+ <div class="param-desc usertext">
4800
+ If preset name is invalid
4801
+ </div>
4802
+ </dt>
4803
+ <dd></dd>
4804
+ <dt>
4805
+ <dl class="param-type">
4806
+ <dt>
4807
+ Type
4808
+ </dt>
4809
+ <dd>
4810
+
4811
+ <span class="param-type">Error</span>
4812
+
4813
+
4814
+
4815
+ </dd>
4816
+ </dl>
4817
+ </dt>
4818
+ <dd></dd>
4819
+ </dl>
4820
+
4821
+
4822
+
4823
+
4824
+
4825
+
4826
+
4827
+
4828
+
4829
+
4830
+
4831
+
4832
+
4833
+ <h4 class="name" id="setToken"><span class="type-signature"></span>setToken<span class="signature">(token)</span><span class="type-signature"></span></h4>
4834
+
4835
+
4836
+
4837
+
4838
+
4839
+
4840
+ <dl class="details">
4841
+
4842
+ <dt class="tag-description">Description:</dt>
4843
+ <dd class="tag-description"><ul class="dummy"><li>Sets the user token for server requests. This should be a JWT token, and will be delivered in Authorization headers (HTTP) and to authenticate websocket join requests.</li></ul></dd>
4844
+
4845
+
4846
+
4847
+ <dt class="tag-source">Source:</dt>
4848
+ <dd class="tag-source"><ul class="dummy"><li>
4849
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line270">line 270</a>
4850
+ </li></ul></dd>
4851
+
4852
+
4853
+
4854
+
4855
+
4856
+
4857
+
4858
+
4859
+
4860
+
4861
+
4862
+
4863
+
4864
+
4865
+
4866
+
4867
+
4868
+
4869
+
4870
+
4871
+
4872
+
4873
+
4874
+
4875
+
4876
+
4877
+
4878
+
4879
+
4880
+
4881
+
4882
+ </dl>
4883
+
4884
+
4885
+
4886
+
4887
+
4888
+
4889
+
4890
+
4891
+
4892
+
4893
+
4894
+
4895
+
4896
+ <h5 class="h5-parameters">Parameters:</h5>
4897
+
4898
+
4899
+ <table class="params">
4900
+ <thead>
4901
+ <tr>
4902
+
4903
+ <th>Name</th>
4904
+
4905
+
4906
+ <th>Type</th>
4907
+
4908
+
4909
+
4910
+
4911
+
4912
+ <th class="last">Description</th>
4913
+ </tr>
4914
+ </thead>
4915
+
4916
+ <tbody>
4917
+
4918
+
4919
+ <tr>
4920
+
4921
+ <td class="name"><code>token</code></td>
4922
+
4923
+
4924
+ <td class="type">
4925
+
4926
+
4927
+ <span class="param-type">String</span>
4928
+
4929
+
4930
+
4931
+
4932
+ </td>
4933
+
4934
+
4935
+
4936
+
4937
+
4938
+ <td class="description last">The metadata to associate with the user.</td>
4939
+ </tr>
4940
+
4941
+
4942
+ </tbody>
4943
+ </table>
4944
+
4945
+
4946
+
4947
+
4948
+
4949
+
4950
+
4951
+
4952
+
4953
+
4954
+
4955
+
4956
+
4957
+
4958
+
4959
+
4960
+
4961
+
4962
+
4963
+
4964
+
4965
+
4966
+
4967
+
4968
+ <h4 class="name" id="setUserMetadata"><span class="type-signature"></span>setUserMetadata<span class="signature">(metadata)</span><span class="type-signature"></span></h4>
4969
+
4970
+
4971
+
4972
+
4973
+
4974
+
4975
+ <dl class="details">
4976
+
4977
+ <dt class="tag-description">Description:</dt>
4978
+ <dd class="tag-description"><ul class="dummy"><li>Sets the user metadata and updates it on the server.</li></ul></dd>
4979
+
4980
+
4981
+
4982
+ <dt class="tag-source">Source:</dt>
4983
+ <dd class="tag-source"><ul class="dummy"><li>
4984
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line286">line 286</a>
4985
+ </li></ul></dd>
4986
+
4987
+
4988
+
4989
+
4990
+
4991
+
4992
+
4993
+
4994
+
4995
+
4996
+
4997
+
4998
+
4999
+
5000
+
5001
+
5002
+
5003
+
5004
+
5005
+
5006
+
5007
+
5008
+
5009
+
5010
+
5011
+
5012
+
5013
+
5014
+
5015
+
5016
+
5017
+ </dl>
5018
+
5019
+
5020
+
5021
+
5022
+
5023
+
5024
+
5025
+
5026
+
5027
+
5028
+
5029
+
5030
+
5031
+ <h5 class="h5-parameters">Parameters:</h5>
5032
+
5033
+
5034
+ <table class="params">
5035
+ <thead>
5036
+ <tr>
5037
+
5038
+ <th>Name</th>
5039
+
5040
+
5041
+ <th>Type</th>
5042
+
5043
+
5044
+
5045
+
5046
+
5047
+ <th class="last">Description</th>
5048
+ </tr>
5049
+ </thead>
5050
+
5051
+ <tbody>
5052
+
5053
+
5054
+ <tr>
5055
+
5056
+ <td class="name"><code>metadata</code></td>
5057
+
5058
+
5059
+ <td class="type">
5060
+
5061
+
5062
+ <span class="param-type">Object</span>
5063
+
5064
+
5065
+
5066
+
5067
+ </td>
5068
+
5069
+
5070
+
5071
+
5072
+
5073
+ <td class="description last">The metadata to associate with the user.</td>
5074
+ </tr>
5075
+
5076
+
5077
+ </tbody>
5078
+ </table>
5079
+
5080
+
5081
+
5082
+
5083
+
5084
+
5085
+
5086
+
5087
+
5088
+
5089
+
5090
+
5091
+
5092
+
5093
+
5094
+
5095
+
5096
+
5097
+
5098
+
5099
+
5100
+
5101
+
5102
+
5103
+ <h4 class="name" id="shareScreen"><span class="type-signature type-signature-async">(async) </span>shareScreen<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
5104
+
5105
+
5106
+
5107
+
5108
+
5109
+
5110
+ <dl class="details">
5111
+
5112
+ <dt class="tag-description">Description:</dt>
5113
+ <dd class="tag-description"><ul class="dummy"><li>Starts screen sharing.</li></ul></dd>
5114
+
5115
+
5116
+
5117
+ <dt class="tag-source">Source:</dt>
5118
+ <dd class="tag-source"><ul class="dummy"><li>
5119
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1227">line 1227</a>
5120
+ </li></ul></dd>
5121
+
5122
+
5123
+
5124
+
5125
+
5126
+
5127
+
5128
+
5129
+
5130
+
5131
+
5132
+
5133
+
5134
+
5135
+
5136
+
5137
+
5138
+
5139
+
5140
+
5141
+
5142
+
5143
+
5144
+
5145
+
5146
+
5147
+
5148
+
5149
+
5150
+
5151
+
5152
+ </dl>
5153
+
5154
+
5155
+
5156
+
5157
+
5158
+
5159
+
5160
+
5161
+
5162
+
5163
+
5164
+
5165
+
5166
+
5167
+
5168
+
5169
+
5170
+
5171
+
5172
+
5173
+
5174
+
5175
+
5176
+
5177
+
5178
+
5179
+
5180
+ <h5 class="h5-returns">Returns:</h5>
5181
+
5182
+
5183
+
5184
+
5185
+ <dl class="param-type">
5186
+ <dt>
5187
+ Type
5188
+ </dt>
5189
+ <dd>
5190
+
5191
+ <span class="param-type">Promise.&lt;void></span>
5192
+
5193
+
5194
+
5195
+ </dd>
5196
+ </dl>
5197
+
5198
+
5199
+
5200
+
5201
+
5202
+
5203
+
5204
+
5205
+
5206
+
5207
+ <h4 class="name" id="startStatsMonitoring"><span class="type-signature"></span>startStatsMonitoring<span class="signature">(interval<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
5208
+
5209
+
5210
+
5211
+
5212
+
5213
+
5214
+ <dl class="details">
5215
+
5216
+ <dt class="tag-description">Description:</dt>
5217
+ <dd class="tag-description"><ul class="dummy"><li>Start monitoring connection statistics</li></ul></dd>
5218
+
5219
+
5220
+
5221
+ <dt class="tag-source">Source:</dt>
5222
+ <dd class="tag-source"><ul class="dummy"><li>
5223
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1722">line 1722</a>
5224
+ </li></ul></dd>
5225
+
5226
+
5227
+
5228
+
5229
+
5230
+
5231
+
5232
+
5233
+
5234
+
5235
+
5236
+
5237
+
5238
+
5239
+
5240
+
5241
+
5242
+
5243
+
5244
+
5245
+
5246
+
5247
+
5248
+
5249
+
5250
+
5251
+
5252
+
5253
+
5254
+
5255
+
5256
+ </dl>
5257
+
5258
+
5259
+
5260
+
5261
+
5262
+
5263
+
5264
+
5265
+
5266
+
5267
+
5268
+
5269
+
5270
+ <h5 class="h5-parameters">Parameters:</h5>
5271
+
5272
+
5273
+ <table class="params">
5274
+ <thead>
5275
+ <tr>
5276
+
5277
+ <th>Name</th>
5278
+
5279
+
5280
+ <th>Type</th>
5281
+
5282
+
5283
+ <th>Attributes</th>
5284
+
5285
+
5286
+
5287
+ <th>Default</th>
5288
+
5289
+
5290
+ <th class="last">Description</th>
5291
+ </tr>
5292
+ </thead>
5293
+
5294
+ <tbody>
5295
+
5296
+
5297
+ <tr>
5298
+
5299
+ <td class="name"><code>interval</code></td>
5300
+
5301
+
5302
+ <td class="type">
5303
+
5304
+
5305
+ <span class="param-type">number</span>
5306
+
5307
+
5308
+
5309
+
5310
+ </td>
5311
+
5312
+
5313
+ <td class="attributes">
5314
+
5315
+ &lt;optional><br>
5316
+
5317
+
5318
+
5319
+
5320
+
5321
+ </td>
5322
+
5323
+
5324
+
5325
+ <td class="default">
5326
+
5327
+ <code>1000</code>
5328
+
5329
+ </td>
5330
+
5331
+
5332
+ <td class="description last">How often to gather stats in milliseconds</td>
5333
+ </tr>
5334
+
5335
+
5336
+ </tbody>
5337
+ </table>
5338
+
5339
+
5340
+
5341
+
5342
+
5343
+
5344
+
5345
+
5346
+
5347
+
5348
+
5349
+
5350
+
5351
+
5352
+
5353
+
5354
+
5355
+
5356
+
5357
+
5358
+
5359
+
5360
+
5361
+
5362
+ <h4 class="name" id="stopStatsMonitoring"><span class="type-signature"></span>stopStatsMonitoring<span class="signature">()</span><span class="type-signature"></span></h4>
5363
+
5364
+
5365
+
5366
+
5367
+
5368
+
5369
+ <dl class="details">
5370
+
5371
+ <dt class="tag-description">Description:</dt>
5372
+ <dd class="tag-description"><ul class="dummy"><li>Stop monitoring connection statistics</li></ul></dd>
5373
+
5374
+
5375
+
5376
+ <dt class="tag-source">Source:</dt>
5377
+ <dd class="tag-source"><ul class="dummy"><li>
5378
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1741">line 1741</a>
5379
+ </li></ul></dd>
5380
+
5381
+
5382
+
5383
+
5384
+
5385
+
5386
+
5387
+
5388
+
5389
+
5390
+
5391
+
5392
+
5393
+
5394
+
5395
+
5396
+
5397
+
5398
+
5399
+
5400
+
5401
+
5402
+
5403
+
5404
+
5405
+
5406
+
5407
+
5408
+
5409
+
5410
+
5411
+ </dl>
5412
+
5413
+
5414
+
5415
+
5416
+
5417
+
5418
+
5419
+
5420
+
5421
+
5422
+
5423
+
5424
+
5425
+
5426
+
5427
+
5428
+
5429
+
5430
+
5431
+
5432
+
5433
+
5434
+
5435
+
5436
+
5437
+
5438
+
5439
+
5440
+
5441
+
5442
+
5443
+
5444
+
5445
+
5446
+
5447
+ <h4 class="name" id="toggleMedia"><span class="type-signature"></span>toggleMedia<span class="signature">(options)</span><span class="type-signature"> &rarr; {void}</span></h4>
5448
+
5449
+
5450
+
5451
+
5452
+
5453
+
5454
+ <dl class="details">
5455
+
5456
+ <dt class="tag-description">Description:</dt>
5457
+ <dd class="tag-description"><ul class="dummy"><li>Toggles the enabled state of video and/or audio tracks.</li></ul></dd>
5458
+
5459
+
5460
+
5461
+ <dt class="tag-source">Source:</dt>
5462
+ <dd class="tag-source"><ul class="dummy"><li>
5463
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1192">line 1192</a>
5464
+ </li></ul></dd>
5465
+
5466
+
5467
+
5468
+
5469
+
5470
+
5471
+
5472
+
5473
+
5474
+
5475
+
5476
+
5477
+
5478
+
5479
+
5480
+
5481
+
5482
+
5483
+
5484
+
5485
+
5486
+
5487
+
5488
+
5489
+
5490
+
5491
+
5492
+
5493
+
5494
+
5495
+
5496
+ </dl>
5497
+
5498
+
5499
+
5500
+
5501
+
5502
+
5503
+
5504
+
5505
+
5506
+
5507
+
5508
+
5509
+
5510
+ <h5 class="h5-parameters">Parameters:</h5>
5511
+
5512
+
5513
+ <table class="params">
5514
+ <thead>
5515
+ <tr>
5516
+
5517
+ <th>Name</th>
5518
+
5519
+
5520
+ <th>Type</th>
5521
+
5522
+
5523
+
5524
+
5525
+
5526
+ <th class="last">Description</th>
5527
+ </tr>
5528
+ </thead>
5529
+
5530
+ <tbody>
5531
+
5532
+
5533
+ <tr>
5534
+
5535
+ <td class="name"><code>options</code></td>
5536
+
5537
+
5538
+ <td class="type">
5539
+
5540
+
5541
+ <span class="param-type">Object</span>
5542
+
5543
+
5544
+
5545
+
5546
+ </td>
5547
+
5548
+
5549
+
5550
+
5551
+
5552
+ <td class="description last">Options to toggle media tracks.
5553
+ <h6>Properties</h6>
5554
+
5555
+
5556
+ <table class="params">
5557
+ <thead>
5558
+ <tr>
5559
+
5560
+ <th>Name</th>
5561
+
5562
+
5563
+ <th>Type</th>
5564
+
5565
+
5566
+ <th>Attributes</th>
5567
+
5568
+
5569
+
5570
+ <th>Default</th>
5571
+
5572
+
5573
+ <th class="last">Description</th>
5574
+ </tr>
5575
+ </thead>
5576
+
5577
+ <tbody>
5578
+
5579
+
5580
+ <tr>
5581
+
5582
+ <td class="name"><code>video</code></td>
5583
+
5584
+
5585
+ <td class="type">
5586
+
5587
+
5588
+ <span class="param-type">boolean</span>
5589
+
5590
+
5591
+
5592
+
5593
+ </td>
5594
+
5595
+
5596
+ <td class="attributes">
5597
+
5598
+ &lt;optional><br>
5599
+
5600
+
5601
+
5602
+
5603
+
5604
+ </td>
5605
+
5606
+
5607
+
5608
+ <td class="default">
5609
+
5610
+ <code>null</code>
5611
+
5612
+ </td>
5613
+
5614
+
5615
+ <td class="description last">Whether to toggle video tracks.</td>
5616
+ </tr>
5617
+
5618
+
5619
+
5620
+ <tr>
5621
+
5622
+ <td class="name"><code>audio</code></td>
5623
+
5624
+
5625
+ <td class="type">
5626
+
5627
+
5628
+ <span class="param-type">boolean</span>
5629
+
5630
+
5631
+
5632
+
5633
+ </td>
5634
+
5635
+
5636
+ <td class="attributes">
5637
+
5638
+ &lt;optional><br>
5639
+
5640
+
5641
+
5642
+
5643
+
5644
+ </td>
5645
+
5646
+
5647
+
5648
+ <td class="default">
5649
+
5650
+ <code>null</code>
5651
+
5652
+ </td>
5653
+
5654
+
5655
+ <td class="description last">Whether to toggle audio tracks.</td>
5656
+ </tr>
5657
+
5658
+
5659
+ </tbody>
5660
+ </table>
5661
+
5662
+ </td>
5663
+ </tr>
5664
+
5665
+
5666
+ </tbody>
5667
+ </table>
5668
+
5669
+
5670
+
5671
+
5672
+
5673
+
5674
+
5675
+
5676
+
5677
+
5678
+
5679
+
5680
+
5681
+
5682
+
5683
+
5684
+ <h5 class="h5-returns">Returns:</h5>
5685
+
5686
+
5687
+
5688
+
5689
+ <dl class="param-type">
5690
+ <dt>
5691
+ Type
5692
+ </dt>
5693
+ <dd>
5694
+
5695
+ <span class="param-type">void</span>
5696
+
5697
+
5698
+
5699
+ </dd>
5700
+ </dl>
5701
+
5702
+
5703
+
5704
+
5705
+
5706
+
5707
+
5708
+
5709
+
5710
+
5711
+ <h4 class="name" id="unpublishAllTracks"><span class="type-signature type-signature-async">(async) </span>unpublishAllTracks<span class="signature">(trackKind, force<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
5712
+
5713
+
5714
+
5715
+
5716
+
5717
+
5718
+ <dl class="details">
5719
+
5720
+ <dt class="tag-description">Description:</dt>
5721
+ <dd class="tag-description"><ul class="dummy"><li>Unpublishes all currently published tracks (with filters for type)</li></ul></dd>
5722
+
5723
+
5724
+
5725
+ <dt class="tag-source">Source:</dt>
5726
+ <dd class="tag-source"><ul class="dummy"><li>
5727
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1323">line 1323</a>
5728
+ </li></ul></dd>
5729
+
5730
+
5731
+
5732
+
5733
+
5734
+
5735
+
5736
+
5737
+
5738
+
5739
+
5740
+
5741
+
5742
+
5743
+
5744
+
5745
+
5746
+
5747
+
5748
+
5749
+
5750
+
5751
+
5752
+
5753
+
5754
+
5755
+
5756
+
5757
+
5758
+
5759
+
5760
+ </dl>
5761
+
5762
+
5763
+
5764
+
5765
+
5766
+
5767
+
5768
+
5769
+
5770
+
5771
+
5772
+
5773
+
5774
+ <h5 class="h5-parameters">Parameters:</h5>
5775
+
5776
+
5777
+ <table class="params">
5778
+ <thead>
5779
+ <tr>
5780
+
5781
+ <th>Name</th>
5782
+
5783
+
5784
+ <th>Type</th>
5785
+
5786
+
5787
+ <th>Attributes</th>
5788
+
5789
+
5790
+
5791
+ <th>Default</th>
5792
+
5793
+
5794
+ <th class="last">Description</th>
5795
+ </tr>
5796
+ </thead>
5797
+
5798
+ <tbody>
5799
+
5800
+
5801
+ <tr>
5802
+
5803
+ <td class="name"><code>trackKind</code></td>
5804
+
5805
+
5806
+ <td class="type">
5807
+
5808
+
5809
+ <span class="param-type">string</span>
5810
+
5811
+
5812
+
5813
+
5814
+ </td>
5815
+
5816
+
5817
+ <td class="attributes">
5818
+
5819
+
5820
+
5821
+
5822
+
5823
+ </td>
5824
+
5825
+
5826
+
5827
+ <td class="default">
5828
+
5829
+ </td>
5830
+
5831
+
5832
+ <td class="description last">The kind of track to unpublish ('audio' or 'video').</td>
5833
+ </tr>
5834
+
5835
+
5836
+
5837
+ <tr>
5838
+
5839
+ <td class="name"><code>force</code></td>
5840
+
5841
+
5842
+ <td class="type">
5843
+
5844
+
5845
+ <span class="param-type">boolean</span>
5846
+
5847
+
5848
+
5849
+
5850
+ </td>
5851
+
5852
+
5853
+ <td class="attributes">
5854
+
5855
+ &lt;optional><br>
5856
+
5857
+
5858
+
5859
+
5860
+
5861
+ </td>
5862
+
5863
+
5864
+
5865
+ <td class="default">
5866
+
5867
+ <code>false</code>
5868
+
5869
+ </td>
5870
+
5871
+
5872
+ <td class="description last">If true, forces track closure without renegotiation.</td>
5873
+ </tr>
5874
+
5875
+
5876
+ </tbody>
5877
+ </table>
5878
+
5879
+
5880
+
5881
+
5882
+
5883
+
5884
+
5885
+
5886
+
5887
+
5888
+
5889
+
5890
+
5891
+
5892
+
5893
+
5894
+ <h5 class="h5-returns">Returns:</h5>
5895
+
5896
+
5897
+
5898
+
5899
+ <dl class="param-type">
5900
+ <dt>
5901
+ Type
5902
+ </dt>
5903
+ <dd>
5904
+
5905
+ <span class="param-type">Promise.&lt;void></span>
5906
+
5907
+
5908
+
5909
+ </dd>
5910
+ </dl>
5911
+
5912
+
5913
+
5914
+
5915
+
5916
+
5917
+
5918
+
5919
+
5920
+
5921
+ <h4 class="name" id="updatePublishedTracks"><span class="type-signature type-signature-async">(async) </span>updatePublishedTracks<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
5922
+
5923
+
5924
+
5925
+
5926
+
5927
+
5928
+ <dl class="details">
5929
+
5930
+ <dt class="tag-description">Description:</dt>
5931
+ <dd class="tag-description"><ul class="dummy"><li>Updates the published media tracks.</li></ul></dd>
5932
+
5933
+
5934
+
5935
+ <dt class="tag-source">Source:</dt>
5936
+ <dd class="tag-source"><ul class="dummy"><li>
5937
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line612">line 612</a>
5938
+ </li></ul></dd>
5939
+
5940
+
5941
+
5942
+
5943
+
5944
+
5945
+
5946
+
5947
+
5948
+
5949
+
5950
+
5951
+
5952
+
5953
+
5954
+
5955
+
5956
+
5957
+
5958
+
5959
+
5960
+
5961
+
5962
+
5963
+
5964
+
5965
+
5966
+
5967
+
5968
+
5969
+
5970
+ </dl>
5971
+
5972
+
5973
+
5974
+
5975
+
5976
+
5977
+
5978
+
5979
+
5980
+
5981
+
5982
+
5983
+
5984
+
5985
+
5986
+
5987
+
5988
+
5989
+
5990
+
5991
+
5992
+
5993
+
5994
+
5995
+
5996
+ <h5 class="h5-throws">Throws:</h5>
5997
+
5998
+
5999
+
6000
+ <dl>
6001
+ <dt>
6002
+ <div class="param-desc usertext">
6003
+ If the PeerConnection is not established.
6004
+ </div>
6005
+ </dt>
6006
+ <dd></dd>
6007
+ <dt>
6008
+ <dl class="param-type">
6009
+ <dt>
6010
+ Type
6011
+ </dt>
6012
+ <dd>
6013
+
6014
+ <span class="param-type">Error</span>
6015
+
6016
+
6017
+
6018
+ </dd>
6019
+ </dl>
6020
+ </dt>
6021
+ <dd></dd>
6022
+ </dl>
6023
+
6024
+
6025
+
6026
+
6027
+
6028
+ <h5 class="h5-returns">Returns:</h5>
6029
+
6030
+
6031
+
6032
+
6033
+ <dl class="param-type">
6034
+ <dt>
6035
+ Type
6036
+ </dt>
6037
+ <dd>
6038
+
6039
+ <span class="param-type">Promise.&lt;void></span>
6040
+
6041
+
6042
+
6043
+ </dd>
6044
+ </dl>
6045
+
6046
+
6047
+
6048
+
6049
+
6050
+
6051
+
6052
+
6053
+
6054
+
6055
+ <h4 class="name" id="updateRoomMetadata"><span class="type-signature type-signature-async">(async) </span>updateRoomMetadata<span class="signature">(updates)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
6056
+
6057
+
6058
+
6059
+
6060
+
6061
+
6062
+ <dl class="details">
6063
+
6064
+ <dt class="tag-description">Description:</dt>
6065
+ <dd class="tag-description"><ul class="dummy"><li>Updates room metadata.</li></ul></dd>
6066
+
6067
+
6068
+
6069
+ <dt class="tag-source">Source:</dt>
6070
+ <dd class="tag-source"><ul class="dummy"><li>
6071
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line1612">line 1612</a>
6072
+ </li></ul></dd>
6073
+
6074
+
6075
+
6076
+
6077
+
6078
+
6079
+
6080
+
6081
+
6082
+
6083
+
6084
+
6085
+
6086
+
6087
+
6088
+
6089
+
6090
+
6091
+
6092
+
6093
+
6094
+
6095
+
6096
+
6097
+
6098
+
6099
+
6100
+
6101
+
6102
+
6103
+
6104
+ </dl>
6105
+
6106
+
6107
+
6108
+
6109
+
6110
+
6111
+
6112
+
6113
+
6114
+
6115
+
6116
+
6117
+
6118
+ <h5 class="h5-parameters">Parameters:</h5>
6119
+
6120
+
6121
+ <table class="params">
6122
+ <thead>
6123
+ <tr>
6124
+
6125
+ <th>Name</th>
6126
+
6127
+
6128
+ <th>Type</th>
6129
+
6130
+
6131
+
6132
+
6133
+
6134
+ <th class="last">Description</th>
6135
+ </tr>
6136
+ </thead>
6137
+
6138
+ <tbody>
6139
+
6140
+
6141
+ <tr>
6142
+
6143
+ <td class="name"><code>updates</code></td>
6144
+
6145
+
6146
+ <td class="type">
6147
+
6148
+
6149
+ <span class="param-type">Object</span>
6150
+
6151
+
6152
+
6153
+
6154
+ </td>
6155
+
6156
+
6157
+
6158
+
6159
+
6160
+ <td class="description last">Metadata updates
6161
+ <h6>Properties</h6>
6162
+
6163
+
6164
+ <table class="params">
6165
+ <thead>
6166
+ <tr>
6167
+
6168
+ <th>Name</th>
6169
+
6170
+
6171
+ <th>Type</th>
6172
+
6173
+
6174
+ <th>Attributes</th>
6175
+
6176
+
6177
+
6178
+
6179
+ <th class="last">Description</th>
6180
+ </tr>
6181
+ </thead>
6182
+
6183
+ <tbody>
6184
+
6185
+
6186
+ <tr>
6187
+
6188
+ <td class="name"><code>name</code></td>
6189
+
6190
+
6191
+ <td class="type">
6192
+
6193
+
6194
+ <span class="param-type">string</span>
6195
+
6196
+
6197
+
6198
+
6199
+ </td>
6200
+
6201
+
6202
+ <td class="attributes">
6203
+
6204
+ &lt;optional><br>
6205
+
6206
+
6207
+
6208
+
6209
+
6210
+ </td>
6211
+
6212
+
6213
+
6214
+
6215
+ <td class="description last">New room name</td>
6216
+ </tr>
6217
+
6218
+
6219
+
6220
+ <tr>
6221
+
6222
+ <td class="name"><code>metadata</code></td>
6223
+
6224
+
6225
+ <td class="type">
6226
+
6227
+
6228
+ <span class="param-type">Object</span>
6229
+
6230
+
6231
+
6232
+
6233
+ </td>
6234
+
6235
+
6236
+ <td class="attributes">
6237
+
6238
+ &lt;optional><br>
6239
+
6240
+
6241
+
6242
+
6243
+
6244
+ </td>
6245
+
6246
+
6247
+
6248
+
6249
+ <td class="description last">New room metadata</td>
6250
+ </tr>
6251
+
6252
+
6253
+ </tbody>
6254
+ </table>
6255
+
6256
+ </td>
6257
+ </tr>
6258
+
6259
+
6260
+ </tbody>
6261
+ </table>
6262
+
6263
+
6264
+
6265
+
6266
+
6267
+
6268
+
6269
+
6270
+
6271
+
6272
+
6273
+
6274
+
6275
+
6276
+
6277
+
6278
+ <h5 class="h5-returns">Returns:</h5>
6279
+
6280
+
6281
+ <div class="param-desc">
6282
+ Updated room information
6283
+ </div>
6284
+
6285
+
6286
+
6287
+ <dl class="param-type">
6288
+ <dt>
6289
+ Type
6290
+ </dt>
6291
+ <dd>
6292
+
6293
+ <span class="param-type">Promise.&lt;Object></span>
6294
+
6295
+
6296
+
6297
+ </dd>
6298
+ </dl>
6299
+
6300
+
6301
+
6302
+
6303
+
6304
+
6305
+
6306
+
6307
+
6308
+
6309
+
6310
+ </article>
6311
+
6312
+ </section>
6313
+
6314
+
6315
+
6316
+
6317
+
6318
+
6319
+ </div>
6320
+
6321
+ <br class="clear">
6322
+
6323
+ <footer>
6324
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Tue Dec 31 2024 08:15:00 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
6325
+ </footer>
6326
+
6327
+ <script>prettyPrint();</script>
6328
+ <script src="scripts/polyfill.js"></script>
6329
+ <script src="scripts/linenumber.js"></script>
6330
+
6331
+
6332
+
6333
+ </body>
6334
+
6335
+ <!-- Mirrored from cloudflarecalls.jamesfuthey.com/docs/CloudflareCalls.html by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 19 Feb 2025 14:59:44 GMT -->
6336
+ </html>
api/assets/apple-touch-icondfdb.png ADDED
api/assets/bootstrap.mindfdb.css ADDED
The diff for this file is too large to render. See raw diff
 
api/assets/favicon-16x16dfdb.png ADDED
api/assets/favicon-32x32dfdb.png ADDED
api/assets/favicondfdb.ico ADDED
api/assets/glyphicons-halflings-regular.eot ADDED
Binary file (20.1 kB). View file
 
api/assets/glyphicons-halflings-regular.svg ADDED
api/assets/glyphicons-halflings-regular.ttf ADDED
Binary file (45.4 kB). View file
 
api/assets/glyphicons-halflings-regular.woff ADDED
Binary file (23.4 kB). View file
 
api/assets/glyphicons-halflings-regular.woff2 ADDED
Binary file (18 kB). View file
 
api/assets/glyphicons-halflings-regulard41d.eot ADDED
Binary file (20.1 kB). View file
 
api/assets/main.bundledfdb.js ADDED
The diff for this file is too large to render. See raw diff
 
api/assets/maindfdb.css ADDED
@@ -0,0 +1,623 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ /**
2
+ * apidoc main css file
3
+ */
4
+
5
+ /**
6
+ * Define colors
7
+ */
8
+ :root {
9
+ --primary: #0088cc;
10
+ --white: #fff;
11
+ --light-gray: #ccc;
12
+ --main-gray: #777;
13
+ --dark-gray: #2d2d2d;
14
+ --hover-gray: #666;
15
+ --meth-get: green;
16
+ --meth-put: #e5c500;
17
+ --meth-post: #4070ec;
18
+ --meth-delete: #ed0039;
19
+ --red: #dc3545;
20
+ }
21
+
22
+ .color-primary {
23
+ color: var(--primary);
24
+ }
25
+
26
+ .bg-primary {
27
+ background-color: var(--primary);
28
+ }
29
+
30
+ .bg-red {
31
+ color: var(--white);
32
+ background-color: var(--red);
33
+ }
34
+
35
+ .border-danger {
36
+ border: 1px solid var(--red);
37
+ }
38
+
39
+ /** for some reason the iOS safari style is applied on date inputs */
40
+ input[type="date"] {
41
+ line-height: 1.4 !important;
42
+ }
43
+
44
+ /* ------------------------------------------------------------------------------------------
45
+ * Content
46
+ * ------------------------------------------------------------------------------------------ */
47
+ @font-face {
48
+ font-family: 'Glyphicons Halflings';
49
+ src: url('glyphicons-halflings-regular.eot');
50
+ src: url('glyphicons-halflings-regulard41d.eot?#iefix') format('embedded-opentype'),
51
+ url('glyphicons-halflings-regular.woff') format('woff'),
52
+ url('glyphicons-halflings-regular.woff2') format('woff2'),
53
+ url('glyphicons-halflings-regular.ttf') format('truetype'),
54
+ url('glyphicons-halflings-regular.svg#glyphicons-halflingsregular') format('svg');
55
+ }
56
+
57
+ /* Hide vertical scrollbar on off canvas animation ("left" positioning) */
58
+ html {
59
+ overflow-x: hidden;
60
+ }
61
+
62
+ body {
63
+ font-family: "Source Sans Pro", sans-serif;
64
+ }
65
+
66
+ a:focus {
67
+ background-color: var(--primary);
68
+ }
69
+
70
+ #content {
71
+ margin-top: 10px;
72
+ padding-left: 10px;
73
+ }
74
+
75
+ p {
76
+ font-size: 130%;
77
+ color: var(--main-gray);
78
+ }
79
+
80
+ section {
81
+ padding: 30px 0;
82
+ }
83
+
84
+ article {
85
+ border-top: 1px solid var(--light-gray);
86
+ padding: 14px 0 30px 0;
87
+ }
88
+
89
+ table {
90
+ border-collapse: collapse;
91
+ width: 100%;
92
+ margin: 0 0 20px 0;
93
+ }
94
+
95
+ th {
96
+ background-color: var(--main-gray);
97
+ color: var(--white);
98
+ text-align: left;
99
+ padding: 5px 8px;
100
+ border: 1px solid var(--main-gray);
101
+ }
102
+
103
+ td {
104
+ padding: 5px;
105
+ border: 1px solid var(--main-gray);
106
+ }
107
+
108
+ td.code {
109
+ font-family: "Source Code Pro", monospace;
110
+ font-weight: 600;
111
+ }
112
+
113
+ .label {
114
+ float: right;
115
+ margin-top: 4px;
116
+ user-select: none;
117
+ }
118
+
119
+ .label.optional {
120
+ background-color: grey;
121
+ }
122
+
123
+ .label.required {
124
+ background-color: var(--red);
125
+ }
126
+
127
+ .default-value,
128
+ .type-size {
129
+ font-style: italic;
130
+ font-size: 95%;
131
+ }
132
+
133
+ .open-left {
134
+ right: 0;
135
+ left: auto;
136
+ }
137
+
138
+ .invisible {
139
+ visibility: hidden;
140
+ }
141
+
142
+ .input-group-addon.sample-request-select {
143
+ padding: 0 6px;
144
+ }
145
+
146
+ .input-group-addon.sample-request-select select {
147
+ width: auto;
148
+ height: 32px;
149
+ }
150
+
151
+ .sample-request-input-Boolean-container {
152
+ width: 40px;
153
+ height: 34px;
154
+ background: var(--white);
155
+ border: 1px solid var(--light-gray);
156
+ }
157
+
158
+ .sample-request-input-Boolean-container > div {
159
+ margin-top: 7px;
160
+ text-align: center;
161
+ }
162
+
163
+ .sample-request-input-Boolean-container > div input {
164
+ margin: 0;
165
+ }
166
+
167
+ /* ------------------------------------------------------------------------------------------
168
+ * Request method (HTTP verb)
169
+ * ------------------------------------------------------------------------------------------ */
170
+ .method {
171
+ font-weight: 600;
172
+ font-size: 15px;
173
+ display: inline-block;
174
+ margin: 0 0 5px 0;
175
+ padding: 4px 5px;
176
+ border-radius: 6px;
177
+ text-transform: uppercase;
178
+ background-color: var(--main-gray);
179
+ color: var(--white);
180
+ }
181
+
182
+ .meth-get {
183
+ background-color: var(--meth-get);
184
+ }
185
+
186
+ .meth-put {
187
+ background-color: var(--meth-put);
188
+ }
189
+
190
+ .meth-post {
191
+ background-color: var(--meth-post);
192
+ }
193
+
194
+ .meth-delete {
195
+ background-color: var(--meth-delete);
196
+ }
197
+
198
+ /* ------------------------------------------------------------------------------------------
199
+ * Sidenav
200
+ * ------------------------------------------------------------------------------------------ */
201
+ #scrollingNav {
202
+ position: fixed;
203
+ top: 0;
204
+ left: 0;
205
+ bottom: 0;
206
+ z-index: 10;
207
+ background-color: var(--dark-gray);
208
+ box-shadow: 0 2px 5px 0 rgb(0 0 0 / 16%), 0 2px 10px 0 rgb(0 0 0 / 12%);
209
+ }
210
+
211
+ .sidenav {
212
+ color: var(--white);
213
+ position: absolute;
214
+ top: 50px;
215
+ left: 0;
216
+ right: 0;
217
+ bottom: 0;
218
+ overflow-x: hidden;
219
+ overflow-y: hidden;
220
+ }
221
+
222
+ .sidenav:hover {
223
+ overflow-x: auto;
224
+ overflow-y: auto;
225
+ }
226
+
227
+ .sidenav > li > a {
228
+ color: var(--white);
229
+ display: block;
230
+ padding: 8px 13px;
231
+ }
232
+
233
+ /* non active sidenav link are highlighted on hover */
234
+ .sidenav > li:not(.active) > a:hover {
235
+ background-color: var(--hover-gray);
236
+ }
237
+
238
+ .sidenav > li.nav-header {
239
+ margin-top: 8px;
240
+ margin-bottom: 8px;
241
+ }
242
+
243
+ .sidenav > li.nav-header > a {
244
+ padding: 5px 15px;
245
+ font-weight: 700;
246
+ font-size: 16px;
247
+ background-color: var(--main-gray);
248
+ }
249
+
250
+
251
+ .sidenav > li.active > a {
252
+ position: relative;
253
+ background-color: var(--primary);
254
+ color: var(--white);
255
+ }
256
+
257
+ /**
258
+ * TODO: commented out for the moment
259
+ .sidenav > li.has-modifications a {
260
+ border-right: 4px solid var(--main-gray);
261
+ }
262
+
263
+ .nav-list-item :not(.is-new) {
264
+ border-left: 4px solid var(--main-gray);
265
+ }
266
+
267
+ .sidenav > li.is-new a {
268
+ border-left: 4px solid var(--primary);
269
+ }
270
+ */
271
+
272
+ /*
273
+ * Off Canvas
274
+ * --------------------------------------------------
275
+ */
276
+ @media screen and (max-width: 767px) {
277
+ #content {
278
+ margin-top: 58px;
279
+ }
280
+
281
+ .row-offcanvas {
282
+ position: relative;
283
+ -webkit-transition: all .25s ease-out;
284
+ -o-transition: all .25s ease-out;
285
+ transition: all .25s ease-out;
286
+ left: 0;
287
+ }
288
+
289
+ .row-offcanvas,
290
+ .row-offcanvas * {
291
+ transition: all 0.5s ease-out;
292
+ }
293
+
294
+ .row-offcanvas .sidebar-offcanvas {
295
+ position: absolute;
296
+ top: 0;
297
+ left: -200px !important; /* 6 columns */
298
+ width: 100%; /* 6 columns */
299
+ max-width: 200px;
300
+ }
301
+
302
+ .nav-toggle {
303
+ position: fixed;
304
+ left: 0;
305
+ background: var(--dark-gray);
306
+ width: 100%;
307
+ }
308
+
309
+ .nav-toggle .btn {
310
+ margin: 10px 14px;
311
+ }
312
+ .nav-toggle .icon-bar {
313
+ display: block;
314
+ width: 22px;
315
+ height: 2px;
316
+ border-radius: 1px;
317
+ background-color: var(--white);
318
+ }
319
+ .nav-toggle .icon-bar + .icon-bar {
320
+ margin-top: 4px;
321
+ }
322
+
323
+ .row-offcanvas.active .sidebar-offcanvas {
324
+ left: 0 !important; /* 6 columns */
325
+ }
326
+ .row-offcanvas.active, .row-offcanvas.active .nav-toggle {
327
+ left: 200px;
328
+ }
329
+ /* Styling the three lines to make it an X */
330
+ .row-offcanvas.active .nav-toggle .btn > .icon-bar {
331
+ transform: rotate(45deg) translate(-4px, -4px);
332
+ }
333
+ .row-offcanvas.active .nav-toggle .btn .icon-bar:nth-child(2) {
334
+ display: none;
335
+ }
336
+ .row-offcanvas.active .nav-toggle .btn .icon-bar:nth-child(3) {
337
+ transform: rotate(-45deg);
338
+ }
339
+ }
340
+
341
+ /* ------------------------------------------------------------------------------------------
342
+ * Side nav search
343
+ * ------------------------------------------------------------------------------------------ */
344
+ .sidenav-search {
345
+ padding: 16px 10px 10px;
346
+ background-color: var(--dark-gray);
347
+ }
348
+
349
+ .sidenav-search .search {
350
+ height: 26px;
351
+ }
352
+
353
+ .search-reset {
354
+ position: absolute;
355
+ display: block;
356
+ cursor: pointer;
357
+ width: 20px;
358
+ height: 20px;
359
+ text-align: center;
360
+ right: 28px;
361
+ top: 18px;
362
+ background-color: #fff;
363
+ }
364
+
365
+ /* ------------------------------------------------------------------------------------------
366
+ * Prism - Toolbar
367
+ * ------------------------------------------------------------------------------------------ */
368
+ div.code-toolbar.code-toolbar > .toolbar {
369
+ top: .4rem;
370
+ right: .4rem;
371
+ }
372
+ div.code-toolbar.code-toolbar > .toolbar > .toolbar-item > button:hover,
373
+ div.code-toolbar.code-toolbar > .toolbar > .toolbar-item > button:focus {
374
+ color: var(--white);
375
+ }
376
+ div.code-toolbar.code-toolbar > .toolbar > .toolbar-item > button {
377
+ color: var(--light-gray);
378
+ padding: .5em;
379
+ background: var(--hover-gray);
380
+ box-shadow: 0 2px 1px 1px rgba(0,0,0,.5);
381
+ }
382
+
383
+ /* ------------------------------------------------------------------------------------------
384
+ * Compare
385
+ * ------------------------------------------------------------------------------------------ */
386
+
387
+ ins {
388
+ background: #60d060;
389
+ text-decoration: none;
390
+ color: #000000;
391
+ }
392
+
393
+ del {
394
+ background: #f05050;
395
+ color: #000000;
396
+ }
397
+
398
+ .label-ins {
399
+ background-color: #60d060;
400
+ }
401
+
402
+ .label-del {
403
+ background-color: #f05050;
404
+ text-decoration: line-through;
405
+ }
406
+
407
+ pre.ins {
408
+ background-color: #60d060;
409
+ }
410
+
411
+ pre.del {
412
+ background-color: #f05050;
413
+ text-decoration: line-through;
414
+ }
415
+
416
+ table.ins th,
417
+ table.ins td {
418
+ background-color: #60d060;
419
+ }
420
+
421
+ table.del th,
422
+ table.del td {
423
+ background-color: #f05050;
424
+ text-decoration: line-through;
425
+ }
426
+
427
+ tr.ins td {
428
+ background-color: #60d060;
429
+ }
430
+
431
+ tr.del td {
432
+ background-color: #f05050;
433
+ text-decoration: line-through;
434
+ }
435
+
436
+ /* ------------------------------------------------------------------------------------------
437
+ * Spinner
438
+ * ------------------------------------------------------------------------------------------ */
439
+
440
+ #loader {
441
+ position: absolute;
442
+ width: 100%;
443
+ }
444
+
445
+ #loader p {
446
+ padding-top: 80px;
447
+ margin-left: -4px;
448
+ }
449
+
450
+ .spinner {
451
+ margin: 200px auto;
452
+ width: 60px;
453
+ height: 60px;
454
+ position: relative;
455
+ }
456
+
457
+ .container1 > div, .container2 > div, .container3 > div {
458
+ width: 14px;
459
+ height: 14px;
460
+ background-color: #0088cc;
461
+
462
+ border-radius: 100%;
463
+ position: absolute;
464
+ -webkit-animation: bouncedelay 1.2s infinite ease-in-out;
465
+ animation: bouncedelay 1.2s infinite ease-in-out;
466
+ /* Prevent first frame from flickering when animation starts */
467
+ -webkit-animation-fill-mode: both;
468
+ animation-fill-mode: both;
469
+ }
470
+
471
+ .spinner .spinner-container {
472
+ position: absolute;
473
+ width: 100%;
474
+ height: 100%;
475
+ }
476
+
477
+ .container2 {
478
+ -webkit-transform: rotateZ(45deg);
479
+ transform: rotateZ(45deg);
480
+ }
481
+
482
+ .container3 {
483
+ -webkit-transform: rotateZ(90deg);
484
+ transform: rotateZ(90deg);
485
+ }
486
+
487
+ .circle1 { top: 0; left: 0; }
488
+ .circle2 { top: 0; right: 0; }
489
+ .circle3 { right: 0; bottom: 0; }
490
+ .circle4 { left: 0; bottom: 0; }
491
+
492
+ .container2 .circle1 {
493
+ -webkit-animation-delay: -1.1s;
494
+ animation-delay: -1.1s;
495
+ }
496
+
497
+ .container3 .circle1 {
498
+ -webkit-animation-delay: -1.0s;
499
+ animation-delay: -1.0s;
500
+ }
501
+
502
+ .container1 .circle2 {
503
+ -webkit-animation-delay: -0.9s;
504
+ animation-delay: -0.9s;
505
+ }
506
+
507
+ .container2 .circle2 {
508
+ -webkit-animation-delay: -0.8s;
509
+ animation-delay: -0.8s;
510
+ }
511
+
512
+ .container3 .circle2 {
513
+ -webkit-animation-delay: -0.7s;
514
+ animation-delay: -0.7s;
515
+ }
516
+
517
+ .container1 .circle3 {
518
+ -webkit-animation-delay: -0.6s;
519
+ animation-delay: -0.6s;
520
+ }
521
+
522
+ .container2 .circle3 {
523
+ -webkit-animation-delay: -0.5s;
524
+ animation-delay: -0.5s;
525
+ }
526
+
527
+ .container3 .circle3 {
528
+ -webkit-animation-delay: -0.4s;
529
+ animation-delay: -0.4s;
530
+ }
531
+
532
+ .container1 .circle4 {
533
+ -webkit-animation-delay: -0.3s;
534
+ animation-delay: -0.3s;
535
+ }
536
+
537
+ .container2 .circle4 {
538
+ -webkit-animation-delay: -0.2s;
539
+ animation-delay: -0.2s;
540
+ }
541
+
542
+ .container3 .circle4 {
543
+ -webkit-animation-delay: -0.1s;
544
+ animation-delay: -0.1s;
545
+ }
546
+
547
+ @-webkit-keyframes bouncedelay {
548
+ 0%, 80%, 100% { -webkit-transform: scale(0.0) }
549
+ 40% { -webkit-transform: scale(1.0) }
550
+ }
551
+
552
+ @keyframes bouncedelay {
553
+ 0%, 80%, 100% {
554
+ transform: scale(0.0);
555
+ -webkit-transform: scale(0.0);
556
+ } 40% {
557
+ transform: scale(1.0);
558
+ -webkit-transform: scale(1.0);
559
+ }
560
+ }
561
+
562
+ /* ------------------------------------------------------------------------------------------
563
+ * Tabs
564
+ * ------------------------------------------------------------------------------------------ */
565
+ ul.nav-tabs {
566
+ margin: 0;
567
+ }
568
+
569
+ p.deprecated span{
570
+ color: var(--red);
571
+ font-weight: bold;
572
+ text-decoration: underline;
573
+ }
574
+
575
+ /**
576
+ * Footer
577
+ */
578
+ #generator {
579
+ padding: 10px 0;
580
+ }
581
+
582
+ /* ------------------------------------------------------------------------------------------
583
+ * Print
584
+ * ------------------------------------------------------------------------------------------ */
585
+
586
+ @media print {
587
+
588
+ #sidenav,
589
+ #version,
590
+ #versions,
591
+ section .version,
592
+ section .versions {
593
+ display: none;
594
+ }
595
+
596
+ #content {
597
+ margin-left: 0;
598
+ }
599
+
600
+ a {
601
+ text-decoration: none;
602
+ color: inherit;
603
+ }
604
+
605
+ a:after {
606
+ content: " [" attr(href) "] ";
607
+ }
608
+
609
+ p {
610
+ color: #000000
611
+ }
612
+
613
+ pre {
614
+ background-color: #ffffff;
615
+ color: #000000;
616
+ padding: 10px;
617
+ border: #808080 1px solid;
618
+ border-radius: 6px;
619
+ position: relative;
620
+ margin: 10px 0 20px 0;
621
+ }
622
+
623
+ } /* /@media print */
api/assets/prism-diff-highlightdfdb.css ADDED
@@ -0,0 +1,13 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ pre.diff-highlight > code .token.deleted:not(.prefix),
2
+ pre > code.diff-highlight .token.deleted:not(.prefix) {
3
+ background-color: rgba(255, 0, 0, .1);
4
+ color: inherit;
5
+ display: block;
6
+ }
7
+
8
+ pre.diff-highlight > code .token.inserted:not(.prefix),
9
+ pre > code.diff-highlight .token.inserted:not(.prefix) {
10
+ background-color: rgba(0, 255, 128, .1);
11
+ color: inherit;
12
+ display: block;
13
+ }
api/assets/prism-toolbardfdb.css ADDED
@@ -0,0 +1,65 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ div.code-toolbar {
2
+ position: relative;
3
+ }
4
+
5
+ div.code-toolbar > .toolbar {
6
+ position: absolute;
7
+ z-index: 10;
8
+ top: .3em;
9
+ right: .2em;
10
+ transition: opacity 0.3s ease-in-out;
11
+ opacity: 0;
12
+ }
13
+
14
+ div.code-toolbar:hover > .toolbar {
15
+ opacity: 1;
16
+ }
17
+
18
+ /* Separate line b/c rules are thrown out if selector is invalid.
19
+ IE11 and old Edge versions don't support :focus-within. */
20
+ div.code-toolbar:focus-within > .toolbar {
21
+ opacity: 1;
22
+ }
23
+
24
+ div.code-toolbar > .toolbar > .toolbar-item {
25
+ display: inline-block;
26
+ }
27
+
28
+ div.code-toolbar > .toolbar > .toolbar-item > a {
29
+ cursor: pointer;
30
+ }
31
+
32
+ div.code-toolbar > .toolbar > .toolbar-item > button {
33
+ background: none;
34
+ border: 0;
35
+ color: inherit;
36
+ font: inherit;
37
+ line-height: normal;
38
+ overflow: visible;
39
+ padding: 0;
40
+ -webkit-user-select: none; /* for button */
41
+ -moz-user-select: none;
42
+ -ms-user-select: none;
43
+ }
44
+
45
+ div.code-toolbar > .toolbar > .toolbar-item > a,
46
+ div.code-toolbar > .toolbar > .toolbar-item > button,
47
+ div.code-toolbar > .toolbar > .toolbar-item > span {
48
+ color: #bbb;
49
+ font-size: .8em;
50
+ padding: 0 .5em;
51
+ background: #f5f2f0;
52
+ background: rgba(224, 224, 224, 0.2);
53
+ box-shadow: 0 2px 0 0 rgba(0,0,0,0.2);
54
+ border-radius: .5em;
55
+ }
56
+
57
+ div.code-toolbar > .toolbar > .toolbar-item > a:hover,
58
+ div.code-toolbar > .toolbar > .toolbar-item > a:focus,
59
+ div.code-toolbar > .toolbar > .toolbar-item > button:hover,
60
+ div.code-toolbar > .toolbar > .toolbar-item > button:focus,
61
+ div.code-toolbar > .toolbar > .toolbar-item > span:hover,
62
+ div.code-toolbar > .toolbar > .toolbar-item > span:focus {
63
+ color: inherit;
64
+ text-decoration: none;
65
+ }
api/assets/prismdfdb.css ADDED
@@ -0,0 +1,122 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ /**
2
+ * prism.js tomorrow night eighties for JavaScript, CoffeeScript, CSS and HTML
3
+ * Based on https://github.com/chriskempson/tomorrow-theme
4
+ * @author Rose Pritchard
5
+ */
6
+
7
+ code[class*="language-"],
8
+ pre[class*="language-"] {
9
+ color: #ccc;
10
+ background: none;
11
+ font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
12
+ font-size: 1em;
13
+ text-align: left;
14
+ white-space: pre;
15
+ word-spacing: normal;
16
+ word-break: normal;
17
+ word-wrap: normal;
18
+ line-height: 1.5;
19
+
20
+ -moz-tab-size: 4;
21
+ -o-tab-size: 4;
22
+ tab-size: 4;
23
+
24
+ -webkit-hyphens: none;
25
+ -moz-hyphens: none;
26
+ -ms-hyphens: none;
27
+ hyphens: none;
28
+
29
+ }
30
+
31
+ /* Code blocks */
32
+ pre[class*="language-"] {
33
+ padding: 1em;
34
+ margin: .5em 0;
35
+ overflow: auto;
36
+ }
37
+
38
+ :not(pre) > code[class*="language-"],
39
+ pre[class*="language-"] {
40
+ background: #2d2d2d;
41
+ }
42
+
43
+ /* Inline code */
44
+ :not(pre) > code[class*="language-"] {
45
+ padding: .1em;
46
+ border-radius: .3em;
47
+ white-space: normal;
48
+ }
49
+
50
+ .token.comment,
51
+ .token.block-comment,
52
+ .token.prolog,
53
+ .token.doctype,
54
+ .token.cdata {
55
+ color: #999;
56
+ }
57
+
58
+ .token.punctuation {
59
+ color: #ccc;
60
+ }
61
+
62
+ .token.tag,
63
+ .token.attr-name,
64
+ .token.namespace,
65
+ .token.deleted {
66
+ color: #e2777a;
67
+ }
68
+
69
+ .token.function-name {
70
+ color: #6196cc;
71
+ }
72
+
73
+ .token.boolean,
74
+ .token.number,
75
+ .token.function {
76
+ color: #f08d49;
77
+ }
78
+
79
+ .token.property,
80
+ .token.class-name,
81
+ .token.constant,
82
+ .token.symbol {
83
+ color: #f8c555;
84
+ }
85
+
86
+ .token.selector,
87
+ .token.important,
88
+ .token.atrule,
89
+ .token.keyword,
90
+ .token.builtin {
91
+ color: #cc99cd;
92
+ }
93
+
94
+ .token.string,
95
+ .token.char,
96
+ .token.attr-value,
97
+ .token.regex,
98
+ .token.variable {
99
+ color: #7ec699;
100
+ }
101
+
102
+ .token.operator,
103
+ .token.entity,
104
+ .token.url {
105
+ color: #67cdcc;
106
+ }
107
+
108
+ .token.important,
109
+ .token.bold {
110
+ font-weight: bold;
111
+ }
112
+ .token.italic {
113
+ font-style: italic;
114
+ }
115
+
116
+ .token.entity {
117
+ cursor: help;
118
+ }
119
+
120
+ .token.inserted {
121
+ color: green;
122
+ }
api/fonts/glyphicons-halflings-regular-2.html ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Error</title>
6
+ </head>
7
+ <body>
8
+ <pre>Cannot GET /docs/api/fonts/glyphicons-halflings-regular.woff2</pre>
9
+ </body>
10
+ </html>
api/fonts/glyphicons-halflings-regular-3.html ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Error</title>
6
+ </head>
7
+ <body>
8
+ <pre>Cannot GET /docs/api/fonts/glyphicons-halflings-regular.woff</pre>
9
+ </body>
10
+ </html>
api/fonts/glyphicons-halflings-regular-4.html ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Error</title>
6
+ </head>
7
+ <body>
8
+ <pre>Cannot GET /docs/api/fonts/glyphicons-halflings-regular.ttf</pre>
9
+ </body>
10
+ </html>
api/fonts/glyphicons-halflings-regular-5.html ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Error</title>
6
+ </head>
7
+ <body>
8
+ <pre>Cannot GET /docs/api/fonts/glyphicons-halflings-regular.svg</pre>
9
+ </body>
10
+ </html>
api/fonts/glyphicons-halflings-regular.html ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Error</title>
6
+ </head>
7
+ <body>
8
+ <pre>Cannot GET /docs/api/fonts/glyphicons-halflings-regular.eot</pre>
9
+ </body>
10
+ </html>
api/fonts/glyphicons-halflings-regulard41d.html ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Error</title>
6
+ </head>
7
+ <body>
8
+ <pre>Cannot GET /docs/api/fonts/glyphicons-halflings-regular.eot</pre>
9
+ </body>
10
+ </html>
api/index.html ADDED
@@ -0,0 +1,1052 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html>
3
+
4
+ <!-- Mirrored from cloudflarecalls.jamesfuthey.com/docs/api/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 19 Feb 2025 14:59:45 GMT -->
5
+ <!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=UTF-8" /><!-- /Added by HTTrack -->
6
+ <head>
7
+ <title>Backend Documentation</title>
8
+ <meta name="description" content="A reference implementation of a backend (in Express) for CloudflareCalls.js">
9
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
10
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
11
+ <link href="assets/bootstrap.mindfdb.css?v=1735632901607" rel="stylesheet" media="screen">
12
+ <link href="assets/prismdfdb.css?v=1735632901607" rel="stylesheet" />
13
+ <link href="assets/prism-toolbardfdb.css?v=1735632901607" rel="stylesheet" />
14
+ <link href="assets/prism-diff-highlightdfdb.css?v=1735632901607" rel="stylesheet" />
15
+ <link href="assets/maindfdb.css?v=1735632901607" rel="stylesheet" media="screen, print">
16
+ <link href="assets/favicondfdb.ico?v=1735632901607" rel="icon" type="image/x-icon">
17
+ <link href="assets/apple-touch-icondfdb.png?v=1735632901607" rel="apple-touch-icon" sizes="180x180">
18
+ <link href="assets/favicon-32x32dfdb.png?v=1735632901607" rel="icon" type="image/png" sizes="32x32">
19
+ <link href="assets/favicon-16x16dfdb.png?v=1735632901607" rel="icon" type="image/png" sizes="16x16">
20
+ </head>
21
+
22
+ <body class="container-fluid">
23
+
24
+ <!-- SIDENAV -->
25
+ <script id="template-sidenav" type="text/x-handlebars-template">
26
+ <nav id="scrollingNav" class="col-sm-3 col-lg-2 sidebar-offcanvas">
27
+ <div class="nav-toggle visible-xs">
28
+ <button type="button" class="btn btn-link" data-toggle="offcanvas">
29
+ <span class="sr-only">{{__ "Toggle navigation"}}</span>
30
+ <span class="icon-bar"></span>
31
+ <span class="icon-bar"></span>
32
+ <span class="icon-bar"></span>
33
+ </button>
34
+ </div>
35
+ <div class="sidenav-search">
36
+ <input class="form-control search" data-action='filter-search' type="text" placeholder="{{__ "Filter..."}}">
37
+ <span class="search-reset">x</span>
38
+ </div>
39
+ <ul class="sidenav nav nav-list list">
40
+ {{#each nav}}
41
+ {{#if title}}
42
+ {{#if isHeader}}
43
+ {{#if isFixed}}
44
+ <li class="nav-fixed nav-header navbar-btn nav-list-item" data-group="{{group}}"><a href="#api-{{group}}" data-name="show-api-{{group}}" class="show-api api-{{group}}-init">{{underscoreToSpace title}}</a></li>
45
+ {{else}}
46
+ <li class="nav-header nav-list-item" data-group="{{group}}"><a href="#api-{{group}}" data-group="show-api-{{group}}" class="show-group api-{{group}}-init">{{underscoreToSpace title}}</a></li>
47
+ {{/if}}
48
+ {{else}}
49
+ <li class="{{#if hidden}}hide {{/if}}" data-group="{{group}}" data-name="{{name}}" data-version="{{version}}">
50
+ <a href="#api-{{group}}-{{name}}" title="{{url}}" data-group="show-api-{{group}}" data-name="show-api-{{group}}-{{name}}" class="nav-list-item show-api api-{{group}}-{{name}}-init">{{title}}<div class="nav-list-url-item hide">{{url}}</div></a>
51
+ </li>
52
+ {{/if}}
53
+ {{/if}}
54
+ {{/each}}
55
+ </ul>
56
+ </nav>
57
+ </script>
58
+
59
+ <!-- PROJECT -->
60
+ <script id="template-project" type="text/x-handlebars-template">
61
+ <div class="pull-left">
62
+ <h1>{{name}}</h1>
63
+ {{#if description}}<h2>{{{nl2br description}}}</h2>{{/if}}
64
+ </div>
65
+ <div class="pull-right">
66
+ {{#if template.withCompare}}
67
+ <div class="btn-group">
68
+ <button id="version" class="btn btn-lg btn-default dropdown-toggle" data-toggle="dropdown">
69
+ <strong>{{version}}</strong>&nbsp;<span class="caret"></span>
70
+ </button>
71
+ <ul id="versions" class="dropdown-menu open-left">
72
+ <li><a id="compareAllWithPredecessor" href="#">{{__ "Compare all with predecessor"}}</a></li>
73
+ <li class="divider"></li>
74
+ <li class="disabled"><a href="#">{{__ "show up to version:"}}</a></li>
75
+ {{#each versions}}
76
+ <li class="version"><a href="#">{{this}}</a></li>
77
+ {{/each}}
78
+ </ul>
79
+ </div>
80
+ {{else}}
81
+ <div id="version" class="well well-sm">
82
+ <strong>{{version}}</strong>
83
+ </div>
84
+ {{/if}}
85
+ </div>
86
+ <div class="clearfix"></div>
87
+ </script>
88
+
89
+ <script id="template-header" type="text/x-handlebars-template">
90
+ {{#if content}}
91
+ <div id="api-_header" class="show-api-article show-api-_-article">{{{content}}}</div>
92
+ {{/if}}
93
+ </script>
94
+
95
+ <script id="template-footer" type="text/x-handlebars-template">
96
+ {{#if content}}
97
+ <div id="api-_footer" class="show-api-article show-api-_-article">{{{content}}}</div>
98
+ {{/if}}
99
+ </script>
100
+
101
+ <script id="template-generator" type="text/x-handlebars-template">
102
+ {{#if template.withGenerator}}
103
+ {{#if generator}}
104
+ <div>
105
+ <p class="text-muted">
106
+ {{__ "Generated with"}} <a href="{{{generator.url}}}">{{{generator.name}}}</a> {{{generator.version}}} - {{{generator.time}}}
107
+ </p>
108
+ </div>
109
+ {{/if}}
110
+ {{/if}}
111
+ </script>
112
+
113
+ <script id="template-sections" type="text/x-handlebars-template">
114
+ <section id="api-{{group}}" class="show-api-group show-api-{{group}}-group {{#if aloneDisplay}} hide{{/if}}">
115
+ <h1 class="color-primary font-weight-bold">{{underscoreToSpace title}}</h1>
116
+ {{#if description}}
117
+ <p>{{{nl2br description}}}</p>
118
+ {{/if}}
119
+ {{#each articles}}
120
+ <div id="api-{{group}}-{{name}}" class="show-api-article show-api-{{group}}-article show-api-{{group}}-{{name}}-article {{#if aloneDisplay}} hide{{/if}}">
121
+ {{{article}}}
122
+ </div>
123
+ {{/each}}
124
+ </section>
125
+ </script>
126
+
127
+ <script id="template-article" type="text/x-handlebars-template">
128
+ <article id="api-{{article.group}}-{{article.name}}-{{article.version}}" {{#if hidden}}class="hide"{{/if}} data-group="{{article.group}}" data-name="{{article.name}}" data-version="{{article.version}}">
129
+ <div class="pull-left">
130
+ <h1><span class="color-primary">{{underscoreToSpace article.groupTitle}}</span>{{#if article.title}} <span class="text-muted">|</span> {{article.title}}{{/if}}</h1>
131
+ </div>
132
+ {{#if template.withCompare}}
133
+ <div class="pull-right">
134
+ <div class="btn-group">
135
+ <button class="version btn btn-default dropdown-toggle" data-toggle="dropdown">
136
+ <strong>{{article.version}}</strong>&nbsp;<span class="caret"></span>
137
+ </button>
138
+ <ul class="versions dropdown-menu open-left">
139
+ <li class="disabled"><a href="#">{{__ "compare changes to:"}}</a></li>
140
+ {{#each versions}}
141
+ <li class="version"><a href="#">{{this}}</a></li>
142
+ {{/each}}
143
+ </ul>
144
+ </div>
145
+ </div>
146
+ {{/if}}
147
+ <div class="clearfix"></div>
148
+
149
+ {{#if article.author}}<h4 class="muted">Authored by: {{article.author}}</h4>{{/if}}
150
+
151
+ {{#if article.deprecated}}
152
+ <p class="deprecated"><span>{{__ "DEPRECATED"}}</span>
153
+ {{{markdown article.deprecated.content}}}
154
+ </p>
155
+ {{/if}}
156
+
157
+ {{#if article.description}}
158
+ <p>{{{nl2br article.description}}}</p>
159
+ {{/if}}
160
+ <span class="method meth-{{toLowerCase article.type}}">{{article.type}}</span>
161
+ <pre
162
+ data-type="{{toLowerCase article.type}}"
163
+ data-prismjs-copy="{{__ "Copy"}}"
164
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
165
+ data-prismjs-copy-success="{{__ "copied!"}}"
166
+ ><code class="language-http">{{article.url}}</code></pre>
167
+
168
+ {{#if article.permission}}
169
+ <p>
170
+ {{__ "Permission:"}}
171
+ {{#each article.permission}}
172
+ {{name}}
173
+ {{#if title}}
174
+ <button type="button" class="btn btn-info btn-xs" data-title="{{title}}" data-content="{{nl2br description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
175
+ <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
176
+ </button>
177
+ {{/if}}
178
+ {{/each}}
179
+ </p>
180
+ {{/if}}
181
+
182
+ {{!-- CODE EXAMPLES IN TABS --}}
183
+ {{#ifCond article.examples.length '>' 0}}
184
+ <ul class="nav nav-tabs nav-tabs-examples" role="tablist">
185
+ {{#each article.examples}}
186
+ <li{{#ifCond @index '==' 0}} class="active"{{/ifCond}}>
187
+ <a href="#examples-{{../id}}-{{@index}}" role="tab" data-toggle="tab">{{title}}</a>
188
+ </li>
189
+ {{/each}}
190
+ </ul>
191
+
192
+ <div class="tab-content">
193
+ {{#each article.examples}}
194
+ <div class="tab-pane{{#ifCond @index '==' 0}} active{{/ifCond}}" id="examples-{{../id}}-{{@index}}">
195
+ <pre
196
+ data-type="{{type}}"
197
+ data-prismjs-copy="{{__ "Copy"}}"
198
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
199
+ data-prismjs-copy-success="{{__ "copied!"}}"
200
+ ><code class="language-{{type}}">{{content}}</code></pre>
201
+ </div>
202
+ {{/each}}
203
+ </div>
204
+ {{/ifCond}}
205
+
206
+ {{subTemplate "article-param-block" params=article.header _hasType=_hasTypeInHeaderFields section="header"}}
207
+ {{subTemplate "article-param-block" params=article.parameter _hasType=_hasTypeInParameterFields section="parameter"}}
208
+ {{subTemplate "article-query-block" params=article.query _hasType=_hasTypeInParameterFields section="query"}}
209
+ {{subTemplate "article-body-block" params=article.body _hasType=_hasTypeInParameterFields section="body"}}
210
+ {{subTemplate "article-param-block" params=article.success _hasType=_hasTypeInSuccessFields section="success"}}
211
+ {{subTemplate "article-param-block" params=article.error _col1="Name" _hasType=_hasTypeInErrorFields section="error"}}
212
+
213
+ {{subTemplate "article-sample-request" article=article id=id}}
214
+ </article>
215
+ </script>
216
+
217
+ <script id="template-article-query-block" type="text/x-handlebars-template">
218
+ {{#if article.query}}
219
+ <h2>{{__ "Query Parameter(s)"}}</h2>
220
+ <table>
221
+ <thead>
222
+ <tr>
223
+ <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
224
+ {{#unless this.Type compare=null}}
225
+ <th style="width: 10%">{{__ "Type"}}</th>
226
+ {{/unless}}
227
+ <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th>
228
+ </tr>
229
+ </thead>
230
+ <tbody>
231
+ {{#each params}}
232
+ <tr>
233
+ <td class="code">
234
+ {{{nestObject this}}}
235
+ {{#if this.optional}}
236
+ <span class="label optional">{{__ "optional"}}</span>
237
+ {{else}}
238
+ {{#if ../template.showRequiredLabels}}
239
+ <span class="label required">{{__ "required"}}</span>
240
+ {{/if}}
241
+ {{/if}}
242
+ </td>
243
+ {{#unless this.Type compare=null}}
244
+ <td class="code">{{this.type}}</td>
245
+ {{/unless}}
246
+ <td>{{{nl2br this.description}}}
247
+ {{#if defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{defaultValue}}}</code></p>{{/if}}
248
+ {{#if size}}<p class="type-size">{{__ "Size range:"}} <code>{{{size}}}</code></p>{{/if}}
249
+ {{#if allowedValues}}<p class="type-size">{{__ "Allowed values:"}}
250
+ {{#each allowedValues}}
251
+ <code>{{{this}}}</code>{{#unless @last}}, {{/unless}}
252
+ {{/each}}
253
+ </p>
254
+ {{/if}}
255
+ </td>
256
+ </tr>
257
+ {{/each}}
258
+ </tbody>
259
+ </table>
260
+ {{/if}}
261
+ </script>
262
+
263
+ <script id="template-article-body-block" type="text/x-handlebars-template">
264
+ {{#if article.body}}
265
+ <h2>{{__ "Request Body"}}</h2>
266
+ <table>
267
+ <thead>
268
+ <tr>
269
+ <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
270
+ {{#unless this.Type compare=null}}
271
+ <th style="width: 10%">{{__ "Type"}}</th>
272
+ {{/unless}}
273
+ <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th>
274
+ </tr>
275
+ </thead>
276
+ <tbody>
277
+ {{#each params}}
278
+ <tr>
279
+ <td class="code">
280
+ {{{nestObject this}}}
281
+ {{#if this.optional}}
282
+ <span class="label optional">{{__ "optional"}}</span>
283
+ {{else}}
284
+ {{#if ../template.showRequiredLabels}}
285
+ <span class="label required">{{__ "required"}}</span>
286
+ {{/if}}
287
+ {{/if}}
288
+ </td>
289
+ {{#unless this.Type compare=null}}
290
+ <td class="code">{{this.type}}</td>
291
+ {{/unless}}
292
+ <td>
293
+ {{{nl2br this.description}}}
294
+ {{#if defaultValue}}
295
+ <p class="default-value">{{__ "Default value:"}} <code>{{{defaultValue}}}</code></p>
296
+ {{/if}}
297
+ {{#if size}}
298
+ <p class="type-size">{{__ "Size range:"}} <code>{{{size}}}</code></p>
299
+ {{/if}}
300
+ {{#if allowedValues}}
301
+ <p class="type-size">{{__ "Allowed values:"}}
302
+ {{#each allowedValues}}
303
+ <code>{{{this}}}</code>{{#unless @last}}, {{/unless}}
304
+ {{/each}}
305
+ </p>
306
+ {{/if}}
307
+ </td>
308
+ </tr>
309
+ {{/each}}
310
+ </tbody>
311
+ </table>
312
+ {{/if}}
313
+ </script>
314
+
315
+ <script id="template-article-param-block" type="text/x-handlebars-template">
316
+ {{#if params}}
317
+ {{#each params.fields}}
318
+ <h2>{{__ @key}}</h2>
319
+ <table>
320
+ <thead>
321
+ <tr>
322
+ <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
323
+ {{#if ../_hasType}}<th style="width: 10%">{{__ "Type"}}</th>{{/if}}
324
+ <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th>
325
+ </tr>
326
+ </thead>
327
+ <tbody>
328
+ {{#each this}}
329
+ <tr>
330
+ <td class="code">
331
+ {{{nestObject this}}}
332
+ {{#if optional}}
333
+ <span class="label optional">{{__ "optional"}}</span>
334
+ {{else}}
335
+ {{#if ../../template.showRequiredLabels}}
336
+ <span class="label required">{{__ "required"}}</span>
337
+ {{/if}}
338
+ {{/if}}</td>
339
+ {{#if ../../_hasType}}
340
+ <td class="code">
341
+ {{{type}}}
342
+ </td>
343
+ {{/if}}
344
+ <td>
345
+ {{{nl2br description}}}
346
+ {{#if defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{defaultValue}}}</code></p>{{/if}}
347
+ {{#if size}}<p class="type-size">{{__ "Size range:"}} <code>{{{size}}}</code></p>{{/if}}
348
+ {{#if allowedValues}}<p class="type-size">{{__ "Allowed values:"}}
349
+ {{#each allowedValues}}
350
+ <code>{{{this}}}</code>{{#unless @last}}, {{/unless}}
351
+ {{/each}}
352
+ </p>
353
+ {{/if}}
354
+ </td>
355
+ </tr>
356
+ {{/each}}
357
+ </tbody>
358
+ </table>
359
+ {{/each}}
360
+ {{#ifCond params.examples.length '>' 0}}
361
+ <ul class="nav nav-tabs nav-tabs-examples" role="tablist">
362
+ {{#each params.examples}}
363
+ <li{{#ifCond @index '==' 0}} class="active"{{/ifCond}}>
364
+ <a href="#{{../section}}-examples-{{../id}}-{{@index}}" role="tab" data-toggle="tab">{{title}}</a>
365
+ </li>
366
+ {{/each}}
367
+ </ul>
368
+
369
+ <div class="tab-content">
370
+ {{#each params.examples}}
371
+ <div class="tab-pane{{#ifCond @index '==' 0}} active{{/ifCond}}" id="{{../section}}-examples-{{../id}}-{{@index}}">
372
+ <pre
373
+ data-type="{{type}}"
374
+ data-prismjs-copy="{{__ "Copy"}}"
375
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
376
+ data-prismjs-copy-success="{{__ "copied!"}}"
377
+ ><code class="language-{{type}}">{{reformat content type}}</code></pre>
378
+ </div>
379
+ {{/each}}
380
+ </div>
381
+ {{/ifCond}}
382
+ {{/if}}
383
+ </script>
384
+
385
+ <script id="template-article-sample-request" type="text/x-handlebars-template">
386
+ {{#if article.sampleRequest}}
387
+ <div class="well">
388
+ <h3>{{__ "Send a Sample Request"}}</h3>
389
+ <form class="form-horizontal">
390
+ <fieldset>
391
+ <div class="form-group">
392
+ <label class="col-md-3 control-label" for="{{../id}}-sample-request-url">URL</label>
393
+ <div class="input-group">
394
+ <span class="input-group-addon">{{__ "url"}}</span>
395
+ <input id="{{../id}}-sample-request-url" type="url" class="form-control sample-request-url" value="{{article.sampleRequest.0.url}}" />
396
+ </div>
397
+ </div>
398
+
399
+ {{#if article.header}}
400
+ {{#if article.header.fields}}
401
+ <h3>{{__ "Headers"}}</h3>
402
+ {{#each article.header.fields}}
403
+ <div class="{{../id}}-sample-request-header-fields">
404
+ {{#each this}}
405
+ <div class="form-group">
406
+ <label class="col-md-3 control-label" for="sample-request-header-field-{{field}}">{{field}}</label>
407
+ <div class="input-group">
408
+ <span class="input-group-addon">{{{type}}}</span>
409
+ <input type="text" id="sample-request-header-field-{{field}}"
410
+ class="form-control sample-request-input"
411
+ value="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
412
+ placeholder="{{#if defaultValue}}{{ defaultValue }}{{else}}{{field}}{{/if}}"
413
+ data-family="header"
414
+ data-name="{{field}}"
415
+ data-group="{{@../index}}">
416
+ </div>
417
+ </div>
418
+ {{/each}}
419
+ </div>
420
+ {{/each}}
421
+ {{/if}}
422
+ {{/if}}
423
+
424
+ {{#if article.parameter}}
425
+ {{#if article.parameter.fields}}
426
+ <h3>{{__ "Parameters"}}</h3>
427
+ {{#each article.parameter.fields}}
428
+ <div class="col-md-3">
429
+ <select name="{{../id}}-sample-header-content-type" class="{{../id}}-sample-request-param-select sample-header-content-type sample-header-content-type-switch">
430
+ <option value="auto" selected>ajax-auto</option>
431
+ <option value="json" >json</option>
432
+ <option value="form-data" >form-data</option>
433
+ </select>
434
+ </div>
435
+
436
+ <div class="{{../id}}-sample-request-param-body {{../id}}-sample-header-content-type-body hide">
437
+ <div class="form-group">
438
+ <div class="input-group">
439
+ <div class="input-group-addon">json</div>
440
+ <textarea id="sample-request-body-json" class="form-control sample-request-body" data-sample-request-body-group="sample-request-param-{{@./index}}" rows="6" style="OVERFLOW: visible" {{#if optional}}data-sample-request-param-optional="true"{{/if}}></textarea>
441
+ </div>
442
+ </div>
443
+ </div>
444
+ <div class="{{../id}}-sample-request-param-fields {{../id}}-sample-header-content-type-fields">
445
+ {{#each this}}
446
+ <div class="form-group">
447
+ {{#ifNotObject type}}
448
+ <label class="col-md-3 control-label" for="sample-request-param-field-{{field}}">{{field}}</label>
449
+ <div class="input-group">
450
+ <div class="input-group-addon">{{{type}}}</div>
451
+ {{#if allowedValues}}
452
+ <div class="input-group-addon sample-request-select">
453
+ <select class="form-control" data-name="{{dot2bracket this}}" data-family="query" data-group="{{@../index}}" {{#if optional}}data-optional="true"{{/if}}>
454
+ <option value="" class="empty">&lt;{{__ "No value"}}&gt;</option>
455
+ {{#each allowedValues}}
456
+ <option {{#ifCond ../defaultValue '===' this}} selected {{/ifCond}}value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
457
+ {{/each}}
458
+ </select>
459
+ </div>
460
+ <input class="invisible">
461
+ {{else}}
462
+ <div class="sample-request-input-{{type}}-container"><div>
463
+ <input id="sample-request-param-field-{{field}}"
464
+ class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-param"
465
+ type="{{setInputType type}}"
466
+ value="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
467
+ placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
468
+ data-name="{{dot2bracket this}}"
469
+ data-family="query"
470
+ data-group="{{@../index}}"
471
+ {{#if optional}}data-optional="true"{{/if}}>
472
+ </div></div>
473
+ {{/if}}
474
+ </div>
475
+ {{/ifNotObject}}
476
+ </div>
477
+ {{/each}}
478
+ </div>
479
+ {{/each}}
480
+ {{/if}}
481
+ {{/if}}
482
+
483
+ {{#if article.query}}
484
+ <h3>{{__ "Query Parameters"}}</h3>
485
+ <div class="{{../id}}-sample-request-param-fields {{../id}}-sample-header-content-type-fields">
486
+ {{#each article.query}}
487
+ <div class="form-group">
488
+ {{#ifNotObject type}}
489
+ <label class="col-md-3 control-label" for="sample-request-param-field-{{field}}">{{field}}{{#if optional}} ({{__ "optional"}}){{/if}}</label>
490
+ <div class="input-group col-md-6">
491
+ <div class="input-group-addon">{{{type}}}</div>
492
+ {{#if allowedValues}}
493
+ <div class="input-group-addon sample-request-select">
494
+ <select class="form-control" data-name="{{dot2bracket this}}" data-family="query" data-group="{{@../index}}" {{#if optional}}data-optional="true"{{/if}}>
495
+ <option value="" class="empty">&lt;{{__ "No value"}}&gt;</option>
496
+ {{#each allowedValues}}
497
+ <option {{#ifCond ../defaultValue '===' this}} selected {{/ifCond}}value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
498
+ {{/each}}
499
+ </select>
500
+ </div>
501
+ <input class="invisible">
502
+ {{else}}
503
+ <div class="sample-request-input-{{type}}-container"><div>
504
+ <input id="sample-request-param-field-{{field}}"
505
+ class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-input"
506
+ type="{{setInputType type}}"
507
+ value="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
508
+ placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
509
+ data-name="{{dot2bracket this}}"
510
+ data-family="query"
511
+ data-group="{{@../index}}"
512
+ {{#if optional}}data-optional="true"{{/if}}>
513
+ </div></div>
514
+ {{/if}}
515
+ </div>
516
+ {{/ifNotObject}}
517
+ </div>
518
+ {{/each}}
519
+ </div>
520
+ {{/if}}
521
+
522
+ {{#if article.body}}
523
+ <h3>{{__ "Body"}}</h3>
524
+
525
+ <div class="col-md-3">
526
+ <label for="body-content-type-{{this.id}}">{{__ "Content-Type"}}</label>
527
+ <select id="body-content-type-{{this.id}}" data-id="{{this.id}}" class="sample-request-content-type-switch form-control">
528
+ <option value="body-json" selected>json</option>
529
+ <option value="body-form-data">form-data</option>
530
+ </select>
531
+ </div>
532
+
533
+ <div class="col-md-9" id="sample-request-body-json-input-{{this.id}}">
534
+ <div class="form-group">
535
+ <div class="input-group">
536
+ <div class="input-group-addon">json</div>
537
+ <textarea class="form-control sample-request-input" rows="6"
538
+ data-family="body-json"
539
+ data-name={{"body"}}
540
+ data-content-type="json"
541
+ {{#if optional}}data-optional="true"{{/if}}>{{body2json article.body}}</textarea>
542
+ </div>
543
+ </div>
544
+ </div>
545
+
546
+ <div hidden class="col-md-9" id="sample-request-body-form-input-{{this.id}}">
547
+ {{#each article.body}}
548
+ <div class="form-group">
549
+ {{#ifNotObject type}}
550
+ <label class="col-md-3 control-label" for="sample-request-param-field-{{field}}">{{field}}</label>
551
+ <div class="input-group">
552
+ <div class="input-group-addon">{{{type}}}</div>
553
+ {{#if allowedValues}}
554
+ <div class="input-group-addon sample-request-select">
555
+ <select class="form-control" data-name="{{dot2bracket this}}" data-family="body" data-group="{{@../index}}" {{#if optional}}data-optional="true"{{/if}}>
556
+ <option value="" class="empty">&lt;{{__ "No value"}}&gt;</option>
557
+ {{#each allowedValues}}
558
+ <option {{#ifCond ../defaultValue '===' this}} selected {{/ifCond}}value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
559
+ {{/each}}
560
+ </select>
561
+ </div>
562
+ <input class="invisible">
563
+ {{else}}
564
+ <div class="sample-request-input-{{type}}-container"><div>
565
+ <input id="sample-request-param-field-{{field}}"
566
+ class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-input"
567
+ type="{{setInputType type}}"
568
+ value="{{#ifCond type '!==' 'Boolean'}}{{#if defaultValue}}{{ defaultValue }}{{/if}}{{/ifCond}}"
569
+ {{#if checked}}checked{{/if}}
570
+ placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
571
+ data-family="body"
572
+ data-name="{{dot2bracket this}}"
573
+ data-content-type="form"
574
+ {{#if optional}}data-optional="true"{{/if}}>
575
+ </div></div>
576
+ {{/if}}
577
+ </div>
578
+ {{/ifNotObject}}
579
+ </div>
580
+ {{/each}}
581
+ </div>
582
+ {{/if}}
583
+
584
+ <div class="form-group">
585
+ <div class="controls pull-right">
586
+ <button class="btn btn-primary bg-primary sample-request-send" data-type="{{article.type}}">{{__ "Send"}}</button>
587
+ <button class="btn btn-danger bg-red sample-request-clear" data-type="{{article.type}}">{{__ "Reset"}}</button>
588
+ </div>
589
+ </div>
590
+ <div class="form-group sample-request-response" hidden>
591
+ <h3>
592
+ {{__ "Response"}}
593
+ <button class="btn btn-default btn-xs pull-right sample-request-clear">X</button>
594
+ </h3>
595
+ <pre
596
+ data-type="json"
597
+ data-prismjs-copy="{{__ "Copy"}}"
598
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
599
+ data-prismjs-copy-success="{{__ "copied!"}}"
600
+ ><code class="language-json sample-request-response-json"></code></pre>
601
+ </div>
602
+ </fieldset>
603
+ </form>
604
+ </div>
605
+ {{/if}}
606
+ </script>
607
+
608
+ <script id="template-compare-article" type="text/x-handlebars-template">
609
+ <article id="api-{{article.group}}-{{article.name}}-{{article.version}}" {{#if hidden}}class="hide"{{/if}} data-group="{{article.group}}" data-name="{{article.name}}" data-version="{{article.version}}" data-compare-version="{{compare.version}}">
610
+ <div class="pull-left">
611
+ <h1>{{underscoreToSpace article.groupTitle}} | {{{showDiff article.title compare.title}}}</h1>
612
+ </div>
613
+
614
+ <div class="pull-right">
615
+ <div class="btn-group">
616
+ <button class="btn btn-success" disabled>
617
+ <strong>{{article.version}}</strong> {{__ "compared to"}}
618
+ </button>
619
+ <button class="version btn btn-danger dropdown-toggle" data-toggle="dropdown">
620
+ <strong>{{compare.version}}</strong>&nbsp;<span class="caret"></span>
621
+ </button>
622
+ <ul class="versions dropdown-menu open-left">
623
+ <li class="disabled"><a href="#">{{__ "compare changes to:"}}</a></li>
624
+ <li class="divider"></li>
625
+ {{#each versions}}
626
+ <li class="version"><a href="#">{{this}}</a></li>
627
+ {{/each}}
628
+ </ul>
629
+ </div>
630
+ </div>
631
+ <div class="clearfix"></div>
632
+
633
+ {{#if article.description}}
634
+ <p>{{{showDiff article.description compare.description "nl2br"}}}</p>
635
+ {{else}}
636
+ {{#if compare.description}}
637
+ <p>{{{showDiff "" compare.description "nl2br"}}}</p>
638
+ {{/if}}
639
+ {{/if}}
640
+
641
+ <span class="method meth-{{toLowerCase compare.type}}">{{compare.type}}</span>
642
+ <pre
643
+ data-type="{{toLowerCase article.type}}"
644
+ data-prismjs-copy="{{__ "Copy"}}"
645
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
646
+ data-prismjs-copy-success="{{__ "copied!"}}"
647
+ class="language-html"
648
+ >{{{showDiff article.url compare.url}}}</pre>
649
+
650
+ {{subTemplate "article-compare-permission" article=article compare=compare}}
651
+
652
+ <ul class="nav nav-tabs nav-tabs-examples" role="tablist">
653
+ {{#each_compare_title article.examples compare.examples}}
654
+ {{#if typeSame}}
655
+ <li{{#ifCond index '==' 0}} class="active"{{/ifCond}}>
656
+ <a href="#compare-examples-{{../article.id}}-{{index}}" role="tab" data-toggle="tab">{{{showDiff source.title compare.title}}}</a>
657
+ </li>
658
+ {{/if}}
659
+
660
+ {{#if typeIns}}
661
+ <li{{#ifCond index '==' 0}} class="active"{{/ifCond}}>
662
+ <a href="#compare-examples-{{../article.id}}-{{index}}"><ins>{{{source.title}}}</ins></a>
663
+ </li>
664
+ {{/if}}
665
+
666
+ {{#if typeDel}}
667
+ <li{{#ifCond index '==' 0}} class="active"{{/ifCond}}>
668
+ <a href="#compare-examples-{{../article.id}}-{{index}}"><del>{{{compare.title}}}</del></a>
669
+ </li>
670
+ {{/if}}
671
+ {{/each_compare_title}}
672
+ </ul>
673
+
674
+ <div class="tab-content">
675
+ {{#each_compare_title article.examples compare.examples}}
676
+
677
+ {{#if typeSame}}
678
+ <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="compare-examples-{{../article.id}}-{{index}}">
679
+ <pre
680
+ data-type="{{source.type}}"
681
+ data-prismjs-copy="{{__ "Copy"}}"
682
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
683
+ data-prismjs-copy-success="{{__ "copied!"}}"
684
+ ><code class="language-diff-{{source.type}} diff-highlight">{{{showDiff source.content compare.content "code"}}}</code></pre>
685
+ </div>
686
+ {{/if}}
687
+
688
+ {{#if typeIns}}
689
+ <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="compare-examples-{{../article.id}}-{{index}}">
690
+ <pre
691
+ data-type="{{source.type}}"
692
+ data-prismjs-copy="{{__ "Copy"}}"
693
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
694
+ data-prismjs-copy-success="{{__ "copied!"}}"
695
+ ><code class="language-{{source.type}}">{{{source.content}}}</code></pre>
696
+ </div>
697
+ {{/if}}
698
+
699
+ {{#if typeDel}}
700
+ <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="compare-examples-{{../article.id}}-{{index}}">
701
+ <pre
702
+ data-type="{{compare.type}}"
703
+ data-prismjs-copy="{{__ "Copy"}}"
704
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
705
+ data-prismjs-copy-success="{{__ "copied!"}}"
706
+ ><code class="language-{{source.type}}">{{{compare.content}}}</code></pre>
707
+ </div>
708
+ {{/if}}
709
+
710
+ {{/each_compare_title}}
711
+ </div>
712
+
713
+ {{subTemplate "article-compare-param-block" source=article.header compare=compare.header _hasType=_hasTypeInHeaderFields section="header"}}
714
+ {{subTemplate "article-compare-param-block" source=article.parameter compare=compare.parameter _hasType=_hasTypeInParameterFields section="parameter"}}
715
+ {{subTemplate "article-compare-query-block" source=article.query compare=compare.query _hasType=_hasTypeInParameterFields section="query"}}
716
+ {{subTemplate "article-compare-body-block" source=article.body compare=compare.body _hasType=_hasTypeInParameterFields section="body"}}
717
+ {{subTemplate "article-compare-param-block" source=article.success compare=compare.success _hasType=_hasTypeInSuccessFields section="success"}}
718
+ {{subTemplate "article-compare-param-block" source=article.error compare=compare.error _col1="Name" _hasType=_hasTypeInErrorFields section="error"}}
719
+
720
+ {{subTemplate "article-sample-request" article=article id=id}}
721
+
722
+ </article>
723
+ </script>
724
+
725
+ <script id="template-article-compare-permission" type="text/x-handlebars-template">
726
+ <p>
727
+ {{__ "Permission:"}}
728
+ {{#each_compare_list_field article.permission compare.permission field="name"}}
729
+ {{#if source}}
730
+ {{#if typeSame}}
731
+ {{source.name}}
732
+ {{#if source.title}}
733
+ <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
734
+ <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
735
+ </button>
736
+ {{#unless _last}}, {{/unless}}
737
+ {{/if}}
738
+ {{/if}}
739
+
740
+ {{#if typeIns}}
741
+ <ins>{{source.name}}</ins>
742
+ {{#if source.title}}
743
+ <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
744
+ <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
745
+ </button>
746
+ {{#unless _last}}, {{/unless}}
747
+ {{/if}}
748
+ {{/if}}
749
+
750
+ {{#if typeDel}}
751
+ <del>{{source.name}}</del>
752
+ {{#if source.title}}
753
+ <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
754
+ <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
755
+ </button>
756
+ {{#unless _last}}, {{/unless}}
757
+ {{/if}}
758
+ {{/if}}
759
+ {{else}}
760
+ {{#if typeSame}}
761
+ {{compare.name}}
762
+ {{#if compare.title}}
763
+ <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
764
+ <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
765
+ </button>
766
+ {{#unless _last}}, {{/unless}}
767
+ {{/if}}
768
+ {{/if}}
769
+
770
+ {{#if typeIns}}
771
+ <ins>{{compare.name}}</ins>
772
+ {{#if compare.title}}
773
+ <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
774
+ <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
775
+ </button>
776
+ {{#unless _last}}, {{/unless}}
777
+ {{/if}}
778
+ {{/if}}
779
+
780
+ {{#if typeDel}}
781
+ <del>{{compare.name}}</del>
782
+ {{#if compare.title}}
783
+ <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
784
+ <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
785
+ </button>
786
+ {{#unless _last}}, {{/unless}}
787
+ {{/if}}
788
+ {{/if}}
789
+ {{/if}}
790
+ {{/each_compare_list_field}}
791
+ </p>
792
+ </script>
793
+
794
+ <script id="template-article-compare-param-block" type="text/x-handlebars-template">
795
+ {{#if source}}
796
+ {{#each_compare_keys source.fields compare.fields}}
797
+ {{#if typeSame}}
798
+ <h2>{{__ source.key}}</h2>
799
+ <table>
800
+ <thead>
801
+ <tr>
802
+ <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
803
+ {{#if ../_hasType}}<th style="width: 10%">{{__ "Type"}}</th>{{/if}}
804
+ <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th>
805
+ </tr>
806
+ </thead>
807
+ {{subTemplate "article-compare-param-block-body" source=source.value compare=compare.value _hasType=../_hasType}}
808
+ </table>
809
+ {{/if}}
810
+
811
+ {{#if typeIns}}
812
+ <h2><ins>{{__ source.key}}</ins></h2>
813
+ <table class="ins">
814
+ <thead>
815
+ <tr>
816
+ <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
817
+ {{#if ../_hasType}}<th style="width: 10%">{{__ "Type"}}</th>{{/if}}
818
+ <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th>
819
+ </tr>
820
+ </thead>
821
+ {{subTemplate "article-compare-param-block-body" source=source.value compare=source.value _hasType=../_hasType}}
822
+ </table>
823
+ {{/if}}
824
+
825
+ {{#if typeDel}}
826
+ <h2><del>{{__ compare.key}}</del></h2>
827
+ <table class="del">
828
+ <thead>
829
+ <tr>
830
+ <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
831
+ {{#if ../_hasType}}<th style="width: 10%">{{__ "Type"}}</th>{{/if}}
832
+ <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th>
833
+ </tr>
834
+ </thead>
835
+ {{subTemplate "article-compare-param-block-body" source=compare.value compare=compare.value _hasType=../_hasType}}
836
+ </table>
837
+ {{/if}}
838
+ {{/each_compare_keys}}
839
+
840
+ {{#if source.examples}}
841
+ <ul class="nav nav-tabs nav-tabs-examples" role="tablist">
842
+ {{#each_compare_title source.examples compare.examples}}
843
+ {{#if typeSame}}
844
+ <li{{#ifCond index '==' 0}} class="active"{{/ifCond}}>
845
+ <a href="#{{../section}}-compare-examples-{{../article.id}}-{{index}}" role="tab" data-toggle="tab">{{{showDiff source.title compare.title}}}</a>
846
+ </li>
847
+ {{/if}}
848
+
849
+ {{#if typeIns}}
850
+ <li{{#ifCond index '==' 0}} class="active"{{/ifCond}}>
851
+ <a href="#{{../section}}-compare-examples-{{../article.id}}-{{index}}"><ins>{{{source.title}}}</ins></a>
852
+ </li>
853
+ {{/if}}
854
+
855
+ {{#if typeDel}}
856
+ <li{{#ifCond index '==' 0}} class="active"{{/ifCond}}>
857
+ <a href="#{{../section}}-compare-examples-{{../article.id}}-{{index}}"><del>{{{compare.title}}}</del></a>
858
+ </li>
859
+ {{/if}}
860
+ {{/each_compare_title}}
861
+ </ul>
862
+
863
+ <div class="tab-content">
864
+ {{#each_compare_title source.examples compare.examples}}
865
+
866
+ {{#if typeSame}}
867
+ <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="{{../section}}-compare-examples-{{../article.id}}-{{index}}">
868
+ <pre
869
+ data-type="{{source.type}}"
870
+ data-prismjs-copy="{{__ "Copy"}}"
871
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
872
+ data-prismjs-copy-success="{{__ "copied!"}}"
873
+ ><code class="language-diff-{{source.type}} diff-highlight">{{{showDiff source.content compare.content "code"}}}</code></pre>
874
+ </div>
875
+ {{/if}}
876
+
877
+ {{#if typeIns}}
878
+ <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="{{../section}}-compare-examples-{{../article.id}}-{{index}}">
879
+ <pre
880
+ data-type="{{source.type}}"
881
+ data-prismjs-copy="{{__ "Copy"}}"
882
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
883
+ data-prismjs-copy-success="{{__ "copied!"}}"
884
+ ><code class="language-{{source.type}}">{{{source.content}}}</code></pre>
885
+ </div>
886
+ {{/if}}
887
+
888
+ {{#if typeDel}}
889
+ <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="{{../section}}-compare-examples-{{../article.id}}-{{index}}">
890
+ <pre
891
+ data-type="{{compare.type}}"
892
+ data-prismjs-copy="{{__ "Copy"}}"
893
+ data-prismjs-copy-error="{{__ "Press Ctrl+C to copy"}}"
894
+ data-prismjs-copy-success="{{__ "copied!"}}"
895
+ ><code class="language-{{source.type}}">{{{compare.content}}}</code></pre>
896
+ </div>
897
+ {{/if}}
898
+ {{/each_compare_title}}
899
+ </div>
900
+ {{/if}}
901
+ {{/if}}
902
+ </script>
903
+
904
+ <script id="template-article-compare-query-block" type="text/x-handlebars-template">
905
+ {{#if article.query}}
906
+ <h2>{{__ "Query Parameter(s)"}}</h2>
907
+ <table class="table table-hover">
908
+ <thead>
909
+ <tr>
910
+ <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
911
+ {{#unless this.Type compare=null}}
912
+ <th style="width: 10%">{{__ "Type"}}</th>
913
+ {{/unless}}
914
+ <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th>
915
+ </tr>
916
+ </thead>
917
+ {{subTemplate "article-compare-param-block-body" source=source compare=compare _hasType=this.type}}
918
+ </table>
919
+ {{/if}}
920
+ </script>
921
+
922
+ <script id="template-article-compare-body-block" type="text/x-handlebars-template">
923
+ {{#if article.body}}
924
+ <h2>{{__ "Request Body"}}</h2>
925
+ <table class="table table-hover">
926
+ <thead>
927
+ <tr>
928
+ <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
929
+ {{#unless this.Type compare=null}}
930
+ <th style="width: 10%">{{__ "Type"}}</th>
931
+ {{/unless}}
932
+ <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th>
933
+ </tr>
934
+ </thead>
935
+ {{subTemplate "article-compare-param-block-body" source=source compare=compare _hasType=this.type}}
936
+ </table>
937
+ {{/if}}
938
+ </script>
939
+
940
+ <script id="template-article-compare-param-block-body" type="text/x-handlebars-template">
941
+ <tbody>
942
+ {{#each_compare_field source compare}}
943
+ {{#if typeSame}}
944
+ <tr>
945
+ <td class="code">
946
+ {{{nestObject source}}}
947
+ {{#if source.optional}}
948
+ {{#if compare.optional}} <span class="label label-optional">{{__ "optional"}}</span>
949
+ {{else}} <span class="label label-optional label-ins">{{__ "optional"}}</span>
950
+ {{/if}}
951
+ {{else}}
952
+ {{#if compare.optional}} <span class="label label-optional label-del">{{__ "optional"}}</span>{{/if}}
953
+ {{/if}}
954
+ </td>
955
+
956
+ {{#if source.type}}
957
+ {{#if compare.type}}
958
+ <td>{{{showDiff source.type compare.type}}}</td>
959
+ {{else}}
960
+ <td>{{{source.type}}}</td>
961
+ {{/if}}
962
+ {{else}}
963
+ {{#if compare.type}}
964
+ <td>{{{compare.type}}}</td>
965
+ {{else}}
966
+ {{#if ../../../../_hasType}}<td></td>{{/if}}
967
+ {{/if}}
968
+ {{/if}}
969
+ <td>
970
+ {{{showDiff source.description compare.description "nl2br"}}}
971
+ {{#if source.defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{showDiff source.defaultValue compare.defaultValue}}}</code><p>{{/if}}
972
+ </td>
973
+ </tr>
974
+ {{/if}}
975
+
976
+ {{#if typeIns}}
977
+ <tr class="ins">
978
+ <td class="code">
979
+ {{{nestObject source}}}
980
+ {{#if source.optional}} <span class="label label-optional label-ins">{{__ "optional"}}</span>{{/if}}
981
+ </td>
982
+
983
+ {{#if source.type}}
984
+ <td>{{{source.type}}}</td>
985
+ {{else}}
986
+ {{{typRowTd}}}
987
+ {{/if}}
988
+
989
+ <td>
990
+ {{{nl2br source.description}}}
991
+ {{#if source.defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{source.defaultValue}}}</code><p>{{/if}}
992
+ </td>
993
+ </tr>
994
+ {{/if}}
995
+
996
+ {{#if typeDel}}
997
+ <tr class="del">
998
+ <td class="code">
999
+ {{{nestObject compare}}}
1000
+ {{#if compare.optional}} <span class="label label-optional label-del">{{__ "optional"}}</span>{{/if}}
1001
+ </td>
1002
+
1003
+ {{#if compare.type}}
1004
+ <td>{{{compare.type}}}</td>
1005
+ {{else}}
1006
+ {{{typRowTd}}}
1007
+ {{/if}}
1008
+
1009
+ <td>
1010
+ {{{nl2br compare.description}}}
1011
+ {{#if compare.defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{compare.defaultValue}}}</code><p>{{/if}}
1012
+ </td>
1013
+ </tr>
1014
+ {{/if}}
1015
+
1016
+ {{/each_compare_field}}
1017
+ </tbody>
1018
+ </script>
1019
+
1020
+ <div class="container-fluid">
1021
+ <div class="row row-offcanvas row-offcanvas-left">
1022
+ <div id="sidenav" class="col-sm-3 col-lg-2"></div>
1023
+ <div id="content" class="col-sm-9 col-lg-10">
1024
+ <div id="project"></div>
1025
+ <div id="header"></div>
1026
+ <div id="sections"></div>
1027
+ <div id="footer"></div>
1028
+ <div id="generator"></div>
1029
+ </div>
1030
+ </div>
1031
+ </div>
1032
+
1033
+ <div id="loader">
1034
+ <div class="spinner">
1035
+ <div class="spinner-container container1">
1036
+ <div class="circle1"></div><div class="circle2"></div><div class="circle3"></div><div class="circle4"></div>
1037
+ </div>
1038
+ <div class="spinner-container container2">
1039
+ <div class="circle1"></div><div class="circle2"></div><div class="circle3"></div><div class="circle4"></div>
1040
+ </div>
1041
+ <div class="spinner-container container3">
1042
+ <div class="circle1"></div><div class="circle2"></div><div class="circle3"></div><div class="circle4"></div>
1043
+ </div>
1044
+ <p>Loading...</p>
1045
+ </div>
1046
+ </div>
1047
+
1048
+ <script src="assets/main.bundledfdb.js?v=1735632901607"></script>
1049
+ </body>
1050
+
1051
+ <!-- Mirrored from cloudflarecalls.jamesfuthey.com/docs/api/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 19 Feb 2025 14:59:50 GMT -->
1052
+ </html>
fonts/Montserrat/Montserrat-Bold.eot ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:26bb855eb406aa0218f8b6ae2e4bd3c1de02924928ae2b8801c83b485bbf9f1b
3
+ size 106135
fonts/Montserrat/Montserrat-Bold.ttf ADDED
Binary file (47.1 kB). View file
 
fonts/Montserrat/Montserrat-Bold.woff ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:f13f7a0b423c6b67de87773f6cdba56e5f9af10b6540c0f2a8c7ec8889c05e61
3
+ size 112872
fonts/Montserrat/Montserrat-Bold.woff2 ADDED
Binary file (85.4 kB). View file
 
fonts/Montserrat/Montserrat-Boldd41d.eot ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:26bb855eb406aa0218f8b6ae2e4bd3c1de02924928ae2b8801c83b485bbf9f1b
3
+ size 106135
fonts/Montserrat/Montserrat-Regular.eot ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:328c49480c23d2695aa1d37ae51e5c656ca06d718dc264bfb8bf6f50b06ffa71
3
+ size 106287
fonts/Montserrat/Montserrat-Regular.ttf ADDED
Binary file (46.4 kB). View file
 
fonts/Montserrat/Montserrat-Regular.woff ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:40ed65c309d779b33cc4f6789ee20b1fac1a832d69cace224d21d131f7aa8ecf
3
+ size 112020
fonts/Montserrat/Montserrat-Regular.woff2 ADDED
Binary file (85.2 kB). View file
 
fonts/Montserrat/Montserrat-Regulard41d.eot ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:328c49480c23d2695aa1d37ae51e5c656ca06d718dc264bfb8bf6f50b06ffa71
3
+ size 106287
fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot ADDED
Binary file (19.4 kB). View file
 
fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg ADDED
fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf ADDED
Binary file (67.8 kB). View file
 
fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff ADDED
Binary file (21.1 kB). View file
 
fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 ADDED
Binary file (16.1 kB). View file
 
fonts/Source-Sans-Pro/sourcesanspro-light-webfontd41d.eot ADDED
Binary file (19.4 kB). View file
 
fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot ADDED
Binary file (20 kB). View file
 
fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg ADDED
fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf ADDED
Binary file (68.7 kB). View file
 
fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff ADDED
Binary file (21.7 kB). View file
 
fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 ADDED
Binary file (16.6 kB). View file
 
fonts/Source-Sans-Pro/sourcesanspro-regular-webfontd41d.eot ADDED
Binary file (20 kB). View file
 
global.html ADDED
@@ -0,0 +1,2886 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <!-- Mirrored from cloudflarecalls.jamesfuthey.com/docs/global.html by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 19 Feb 2025 14:59:44 GMT -->
5
+ <!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=UTF-8" /><!-- /Added by HTTrack -->
6
+ <head>
7
+
8
+ <meta charset="utf-8">
9
+ <title>Global - Documentation</title>
10
+
11
+
12
+ <script src="scripts/prettify/prettify.js"></script>
13
+ <script src="scripts/prettify/lang-css.js"></script>
14
+ <!--[if lt IE 9]>
15
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
+ <![endif]-->
17
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
18
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
19
+ <script src="scripts/nav.js" defer></script>
20
+
21
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
22
+ </head>
23
+ <body>
24
+
25
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
26
+ <label for="nav-trigger" class="navicon-button x">
27
+ <div class="navicon"></div>
28
+ </label>
29
+
30
+ <label for="nav-trigger" class="overlay"></label>
31
+
32
+ <nav >
33
+
34
+
35
+ <h2><a href="index-2.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CloudflareCalls.html">CloudflareCalls</a><ul class='methods'><li data-type='method'><a href="CloudflareCalls.html#createRoom">createRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#getAvailableDevices">getAvailableDevices</a></li><li data-type='method'><a href="CloudflareCalls.html#getConnectionStats">getConnectionStats</a></li><li data-type='method'><a href="CloudflareCalls.html#getSessionState">getSessionState</a></li><li data-type='method'><a href="CloudflareCalls.html#getTrackStatus">getTrackStatus</a></li><li data-type='method'><a href="CloudflareCalls.html#getUserInfo">getUserInfo</a></li><li data-type='method'><a href="CloudflareCalls.html#getUserMetadata">getUserMetadata</a></li><li data-type='method'><a href="CloudflareCalls.html#joinRoom">joinRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#leaveRoom">leaveRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#listParticipants">listParticipants</a></li><li data-type='method'><a href="CloudflareCalls.html#listRooms">listRooms</a></li><li data-type='method'><a href="CloudflareCalls.html#onConnectionStats">onConnectionStats</a></li><li data-type='method'><a href="CloudflareCalls.html#onDataMessage">onDataMessage</a></li><li data-type='method'><a href="CloudflareCalls.html#onParticipantJoined">onParticipantJoined</a></li><li data-type='method'><a href="CloudflareCalls.html#onParticipantLeft">onParticipantLeft</a></li><li data-type='method'><a href="CloudflareCalls.html#onRemoteTrack">onRemoteTrack</a></li><li data-type='method'><a href="CloudflareCalls.html#onRemoteTrackUnpublished">onRemoteTrackUnpublished</a></li><li data-type='method'><a href="CloudflareCalls.html#onRoomMetadataUpdated">onRoomMetadataUpdated</a></li><li data-type='method'><a href="CloudflareCalls.html#onTrackStatusChanged">onTrackStatusChanged</a></li><li data-type='method'><a href="CloudflareCalls.html#onWebSocketMessage">onWebSocketMessage</a></li><li data-type='method'><a href="CloudflareCalls.html#previewMedia">previewMedia</a></li><li data-type='method'><a href="CloudflareCalls.html#publishTracks">publishTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#selectAudioInputDevice">selectAudioInputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#selectAudioOutputDevice">selectAudioOutputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#selectVideoInputDevice">selectVideoInputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#sendDataToAll">sendDataToAll</a></li><li data-type='method'><a href="CloudflareCalls.html#setDebugMode">setDebugMode</a></li><li data-type='method'><a href="CloudflareCalls.html#setMediaQuality">setMediaQuality</a></li><li data-type='method'><a href="CloudflareCalls.html#setToken">setToken</a></li><li data-type='method'><a href="CloudflareCalls.html#setUserMetadata">setUserMetadata</a></li><li data-type='method'><a href="CloudflareCalls.html#shareScreen">shareScreen</a></li><li data-type='method'><a href="CloudflareCalls.html#startStatsMonitoring">startStatsMonitoring</a></li><li data-type='method'><a href="CloudflareCalls.html#stopStatsMonitoring">stopStatsMonitoring</a></li><li data-type='method'><a href="CloudflareCalls.html#toggleMedia">toggleMedia</a></li><li data-type='method'><a href="CloudflareCalls.html#unpublishAllTracks">unpublishAllTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#updatePublishedTracks">updatePublishedTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#updateRoomMetadata">updateRoomMetadata</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#broadcastToRoom">broadcastToRoom</a></li><li><a href="global.html#getRoomIdByUserId">getRoomIdByUserId</a></li><li><a href="global.html#getWebSocketByUserId">getWebSocketByUserId</a></li><li><a href="global.html#handleDataMessage">handleDataMessage</a></li><li><a href="global.html#handleWSDisconnect">handleWSDisconnect</a></li><li><a href="global.html#handleWSJoin">handleWSJoin</a></li><li><a href="global.html#rooms">rooms</a></li><li><a href="global.html#server">server</a></li></ul>
36
+
37
+ </nav>
38
+
39
+ <div id="main">
40
+
41
+ <h1 class="page-title">Global</h1>
42
+
43
+
44
+
45
+
46
+
47
+
48
+
49
+ <section>
50
+
51
+ <header>
52
+
53
+ <h2>
54
+
55
+
56
+
57
+ </h2>
58
+
59
+
60
+ </header>
61
+
62
+ <article>
63
+
64
+ <div class="container-overview">
65
+
66
+
67
+
68
+ <dl class="details">
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+ </dl>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+ </div>
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+ <h3 class="subsection-title">Members</h3>
128
+
129
+
130
+
131
+ <h4 class="name" id="rooms"><span class="type-signature type-signature-constant">(constant) </span>rooms<span class="type-signature"> :Object.&lt;string, Array.&lt;<a href="global.html#Room">Room</a>>></span></h4>
132
+
133
+
134
+
135
+
136
+
137
+ <dl class="details">
138
+
139
+
140
+
141
+ <dt class="tag-source">Source:</dt>
142
+ <dd class="tag-source"><ul class="dummy"><li>
143
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line90">line 90</a>
144
+ </li></ul></dd>
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+ </dl>
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+ <h5 class="h5-types">Type:</h5>
185
+ <ul>
186
+ <li>
187
+
188
+ <span class="param-type">Object.&lt;string, Array.&lt;<a href="global.html#Room">Room</a>>></span>
189
+
190
+
191
+
192
+ </li>
193
+ </ul>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+ <h4 class="name" id="server"><span class="type-signature type-signature-constant">(constant) </span>server<span class="type-signature"></span></h4>
203
+
204
+
205
+
206
+
207
+
208
+ <dl class="details">
209
+
210
+ <dt class="tag-description">Description:</dt>
211
+ <dd class="tag-description"><ul class="dummy"><li>Sets up the WebSocket server and handles incoming connections and messages.</li></ul></dd>
212
+
213
+
214
+
215
+ <dt class="tag-source">Source:</dt>
216
+ <dd class="tag-source"><ul class="dummy"><li>
217
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line640">line 640</a>
218
+ </li></ul></dd>
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+ </dl>
251
+
252
+
253
+
254
+
255
+
256
+ <div class="description usertext">
257
+ Sets up the WebSocket server and handles incoming connections and messages.
258
+ </div>
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+ <h3 class="subsection-title">Methods</h3>
272
+
273
+
274
+
275
+
276
+
277
+
278
+ <h4 class="name" id="broadcastToRoom"><span class="type-signature"></span>broadcastToRoom<span class="signature">(roomId, message, excludeUserId)</span><span class="type-signature"></span></h4>
279
+
280
+
281
+
282
+
283
+
284
+
285
+ <dl class="details">
286
+
287
+ <dt class="tag-description">Description:</dt>
288
+ <dd class="tag-description"><ul class="dummy"><li>Broadcasts a message to all participants in a room, optionally excluding a specific user.</li></ul></dd>
289
+
290
+
291
+
292
+ <dt class="tag-source">Source:</dt>
293
+ <dd class="tag-source"><ul class="dummy"><li>
294
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line793">line 793</a>
295
+ </li></ul></dd>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+ </dl>
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+ <h5 class="h5-parameters">Parameters:</h5>
342
+
343
+
344
+ <table class="params">
345
+ <thead>
346
+ <tr>
347
+
348
+ <th>Name</th>
349
+
350
+
351
+ <th>Type</th>
352
+
353
+
354
+
355
+
356
+ <th>Default</th>
357
+
358
+
359
+ <th class="last">Description</th>
360
+ </tr>
361
+ </thead>
362
+
363
+ <tbody>
364
+
365
+
366
+ <tr>
367
+
368
+ <td class="name"><code>roomId</code></td>
369
+
370
+
371
+ <td class="type">
372
+
373
+
374
+ <span class="param-type">string</span>
375
+
376
+
377
+
378
+
379
+ </td>
380
+
381
+
382
+
383
+
384
+ <td class="default">
385
+
386
+ </td>
387
+
388
+
389
+ <td class="description last">The ID of the room.</td>
390
+ </tr>
391
+
392
+
393
+
394
+ <tr>
395
+
396
+ <td class="name"><code>message</code></td>
397
+
398
+
399
+ <td class="type">
400
+
401
+
402
+ <span class="param-type">Object</span>
403
+
404
+
405
+
406
+
407
+ </td>
408
+
409
+
410
+
411
+
412
+ <td class="default">
413
+
414
+ </td>
415
+
416
+
417
+ <td class="description last">The message object to broadcast.</td>
418
+ </tr>
419
+
420
+
421
+
422
+ <tr>
423
+
424
+ <td class="name"><code>excludeUserId</code></td>
425
+
426
+
427
+ <td class="type">
428
+
429
+
430
+ <span class="param-type">string</span>
431
+ |
432
+
433
+ <span class="param-type">null</span>
434
+
435
+
436
+
437
+
438
+ </td>
439
+
440
+
441
+
442
+
443
+ <td class="default">
444
+
445
+ <code>null</code>
446
+
447
+ </td>
448
+
449
+
450
+ <td class="description last">The user ID to exclude from broadcasting.</td>
451
+ </tr>
452
+
453
+
454
+ </tbody>
455
+ </table>
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+ <h4 class="name" id="getRoomIdByUserId"><span class="type-signature"></span>getRoomIdByUserId<span class="signature">(userId)</span><span class="type-signature"> &rarr; {string|null}</span></h4>
481
+
482
+
483
+
484
+
485
+
486
+
487
+ <dl class="details">
488
+
489
+ <dt class="tag-description">Description:</dt>
490
+ <dd class="tag-description"><ul class="dummy"><li>Utility function to get roomId by userId.
491
+ Assumes each user is in only one room.</li></ul></dd>
492
+
493
+
494
+
495
+ <dt class="tag-source">Source:</dt>
496
+ <dd class="tag-source"><ul class="dummy"><li>
497
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line712">line 712</a>
498
+ </li></ul></dd>
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+ </dl>
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+ <h5 class="h5-parameters">Parameters:</h5>
545
+
546
+
547
+ <table class="params">
548
+ <thead>
549
+ <tr>
550
+
551
+ <th>Name</th>
552
+
553
+
554
+ <th>Type</th>
555
+
556
+
557
+
558
+
559
+
560
+ <th class="last">Description</th>
561
+ </tr>
562
+ </thead>
563
+
564
+ <tbody>
565
+
566
+
567
+ <tr>
568
+
569
+ <td class="name"><code>userId</code></td>
570
+
571
+
572
+ <td class="type">
573
+
574
+
575
+ <span class="param-type">string</span>
576
+
577
+
578
+
579
+
580
+ </td>
581
+
582
+
583
+
584
+
585
+
586
+ <td class="description last">The user's unique identifier.</td>
587
+ </tr>
588
+
589
+
590
+ </tbody>
591
+ </table>
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+ <h5 class="h5-returns">Returns:</h5>
609
+
610
+
611
+ <div class="param-desc">
612
+ - The room ID if found, otherwise null.
613
+ </div>
614
+
615
+
616
+
617
+ <dl class="param-type">
618
+ <dt>
619
+ Type
620
+ </dt>
621
+ <dd>
622
+
623
+ <span class="param-type">string</span>
624
+ |
625
+
626
+ <span class="param-type">null</span>
627
+
628
+
629
+
630
+ </dd>
631
+ </dl>
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+
642
+ <h4 class="name" id="getWebSocketByUserId"><span class="type-signature"></span>getWebSocketByUserId<span class="signature">(userId)</span><span class="type-signature"> &rarr; {WebSocket|null}</span></h4>
643
+
644
+
645
+
646
+
647
+
648
+
649
+ <dl class="details">
650
+
651
+ <dt class="tag-description">Description:</dt>
652
+ <dd class="tag-description"><ul class="dummy"><li>Utility function to get WebSocket connection by userId.</li></ul></dd>
653
+
654
+
655
+
656
+ <dt class="tag-source">Source:</dt>
657
+ <dd class="tag-source"><ul class="dummy"><li>
658
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line726">line 726</a>
659
+ </li></ul></dd>
660
+
661
+
662
+
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+ </dl>
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+ <h5 class="h5-parameters">Parameters:</h5>
706
+
707
+
708
+ <table class="params">
709
+ <thead>
710
+ <tr>
711
+
712
+ <th>Name</th>
713
+
714
+
715
+ <th>Type</th>
716
+
717
+
718
+
719
+
720
+
721
+ <th class="last">Description</th>
722
+ </tr>
723
+ </thead>
724
+
725
+ <tbody>
726
+
727
+
728
+ <tr>
729
+
730
+ <td class="name"><code>userId</code></td>
731
+
732
+
733
+ <td class="type">
734
+
735
+
736
+ <span class="param-type">string</span>
737
+
738
+
739
+
740
+
741
+ </td>
742
+
743
+
744
+
745
+
746
+
747
+ <td class="description last">The user's unique identifier.</td>
748
+ </tr>
749
+
750
+
751
+ </tbody>
752
+ </table>
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+ <h5 class="h5-returns">Returns:</h5>
770
+
771
+
772
+ <div class="param-desc">
773
+ - The WebSocket connection if found, otherwise null.
774
+ </div>
775
+
776
+
777
+
778
+ <dl class="param-type">
779
+ <dt>
780
+ Type
781
+ </dt>
782
+ <dd>
783
+
784
+ <span class="param-type">WebSocket</span>
785
+ |
786
+
787
+ <span class="param-type">null</span>
788
+
789
+
790
+
791
+ </dd>
792
+ </dl>
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+ <h4 class="name" id="handleDataMessage"><span class="type-signature"></span>handleDataMessage<span class="signature">(ws, payload)</span><span class="type-signature"></span></h4>
804
+
805
+
806
+
807
+
808
+
809
+
810
+ <dl class="details">
811
+
812
+ <dt class="tag-description">Description:</dt>
813
+ <dd class="tag-description"><ul class="dummy"><li>Handles incoming data messages from clients and broadcasts them.</li></ul></dd>
814
+
815
+
816
+
817
+ <dt class="tag-source">Source:</dt>
818
+ <dd class="tag-source"><ul class="dummy"><li>
819
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line682">line 682</a>
820
+ </li></ul></dd>
821
+
822
+
823
+
824
+
825
+
826
+
827
+
828
+
829
+
830
+
831
+
832
+
833
+
834
+
835
+
836
+
837
+
838
+
839
+
840
+
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+
850
+
851
+
852
+ </dl>
853
+
854
+
855
+
856
+
857
+
858
+
859
+
860
+
861
+
862
+
863
+
864
+
865
+
866
+ <h5 class="h5-parameters">Parameters:</h5>
867
+
868
+
869
+ <table class="params">
870
+ <thead>
871
+ <tr>
872
+
873
+ <th>Name</th>
874
+
875
+
876
+ <th>Type</th>
877
+
878
+
879
+
880
+
881
+
882
+ <th class="last">Description</th>
883
+ </tr>
884
+ </thead>
885
+
886
+ <tbody>
887
+
888
+
889
+ <tr>
890
+
891
+ <td class="name"><code>ws</code></td>
892
+
893
+
894
+ <td class="type">
895
+
896
+
897
+ <span class="param-type">WebSocket</span>
898
+
899
+
900
+
901
+
902
+ </td>
903
+
904
+
905
+
906
+
907
+
908
+ <td class="description last">The WebSocket connection from the sender.</td>
909
+ </tr>
910
+
911
+
912
+
913
+ <tr>
914
+
915
+ <td class="name"><code>payload</code></td>
916
+
917
+
918
+ <td class="type">
919
+
920
+
921
+ <span class="param-type">Object</span>
922
+
923
+
924
+
925
+
926
+ </td>
927
+
928
+
929
+
930
+
931
+
932
+ <td class="description last">The payload containing from, to, and message.</td>
933
+ </tr>
934
+
935
+
936
+ </tbody>
937
+ </table>
938
+
939
+
940
+
941
+
942
+
943
+
944
+
945
+
946
+
947
+
948
+
949
+
950
+
951
+
952
+
953
+
954
+
955
+
956
+
957
+
958
+
959
+
960
+
961
+
962
+ <h4 class="name" id="handleWSDisconnect"><span class="type-signature"></span>handleWSDisconnect<span class="signature">(ws)</span><span class="type-signature"></span></h4>
963
+
964
+
965
+
966
+
967
+
968
+
969
+ <dl class="details">
970
+
971
+ <dt class="tag-description">Description:</dt>
972
+ <dd class="tag-description"><ul class="dummy"><li>Handles WebSocket disconnections by removing the user from wsConnections.</li></ul></dd>
973
+
974
+
975
+
976
+ <dt class="tag-source">Source:</dt>
977
+ <dd class="tag-source"><ul class="dummy"><li>
978
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line776">line 776</a>
979
+ </li></ul></dd>
980
+
981
+
982
+
983
+
984
+
985
+
986
+
987
+
988
+
989
+
990
+
991
+
992
+
993
+
994
+
995
+
996
+
997
+
998
+
999
+
1000
+
1001
+
1002
+
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+ </dl>
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+
1024
+
1025
+ <h5 class="h5-parameters">Parameters:</h5>
1026
+
1027
+
1028
+ <table class="params">
1029
+ <thead>
1030
+ <tr>
1031
+
1032
+ <th>Name</th>
1033
+
1034
+
1035
+ <th>Type</th>
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+ <th class="last">Description</th>
1042
+ </tr>
1043
+ </thead>
1044
+
1045
+ <tbody>
1046
+
1047
+
1048
+ <tr>
1049
+
1050
+ <td class="name"><code>ws</code></td>
1051
+
1052
+
1053
+ <td class="type">
1054
+
1055
+
1056
+ <span class="param-type">WebSocket</span>
1057
+
1058
+
1059
+
1060
+
1061
+ </td>
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+ <td class="description last">The WebSocket connection that was closed.</td>
1068
+ </tr>
1069
+
1070
+
1071
+ </tbody>
1072
+ </table>
1073
+
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+
1080
+
1081
+
1082
+
1083
+
1084
+
1085
+
1086
+
1087
+
1088
+
1089
+
1090
+
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+ <h4 class="name" id="handleWSJoin"><span class="type-signature"></span>handleWSJoin<span class="signature">(ws, payload)</span><span class="type-signature"></span></h4>
1098
+
1099
+
1100
+
1101
+
1102
+
1103
+
1104
+ <dl class="details">
1105
+
1106
+ <dt class="tag-description">Description:</dt>
1107
+ <dd class="tag-description"><ul class="dummy"><li>Handles a WebSocket join request by authenticating and adding the user to wsConnections.</li></ul></dd>
1108
+
1109
+
1110
+
1111
+ <dt class="tag-source">Source:</dt>
1112
+ <dd class="tag-source"><ul class="dummy"><li>
1113
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line743">line 743</a>
1114
+ </li></ul></dd>
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+
1137
+
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+ </dl>
1147
+
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+ <h5 class="h5-parameters">Parameters:</h5>
1161
+
1162
+
1163
+ <table class="params">
1164
+ <thead>
1165
+ <tr>
1166
+
1167
+ <th>Name</th>
1168
+
1169
+
1170
+ <th>Type</th>
1171
+
1172
+
1173
+
1174
+
1175
+
1176
+ <th class="last">Description</th>
1177
+ </tr>
1178
+ </thead>
1179
+
1180
+ <tbody>
1181
+
1182
+
1183
+ <tr>
1184
+
1185
+ <td class="name"><code>ws</code></td>
1186
+
1187
+
1188
+ <td class="type">
1189
+
1190
+
1191
+ <span class="param-type">WebSocket</span>
1192
+
1193
+
1194
+
1195
+
1196
+ </td>
1197
+
1198
+
1199
+
1200
+
1201
+
1202
+ <td class="description last">The WebSocket connection.</td>
1203
+ </tr>
1204
+
1205
+
1206
+
1207
+ <tr>
1208
+
1209
+ <td class="name"><code>payload</code></td>
1210
+
1211
+
1212
+ <td class="type">
1213
+
1214
+
1215
+ <span class="param-type">Object</span>
1216
+
1217
+
1218
+
1219
+
1220
+ </td>
1221
+
1222
+
1223
+
1224
+
1225
+
1226
+ <td class="description last">The payload containing roomId, userId, and token.
1227
+ <h6>Properties</h6>
1228
+
1229
+
1230
+ <table class="params">
1231
+ <thead>
1232
+ <tr>
1233
+
1234
+ <th>Name</th>
1235
+
1236
+
1237
+ <th>Type</th>
1238
+
1239
+
1240
+
1241
+
1242
+
1243
+ <th class="last">Description</th>
1244
+ </tr>
1245
+ </thead>
1246
+
1247
+ <tbody>
1248
+
1249
+
1250
+ <tr>
1251
+
1252
+ <td class="name"><code>roomId</code></td>
1253
+
1254
+
1255
+ <td class="type">
1256
+
1257
+
1258
+ <span class="param-type">string</span>
1259
+
1260
+
1261
+
1262
+
1263
+ </td>
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+ <td class="description last">The ID of the room to join.</td>
1270
+ </tr>
1271
+
1272
+
1273
+
1274
+ <tr>
1275
+
1276
+ <td class="name"><code>userId</code></td>
1277
+
1278
+
1279
+ <td class="type">
1280
+
1281
+
1282
+ <span class="param-type">string</span>
1283
+
1284
+
1285
+
1286
+
1287
+ </td>
1288
+
1289
+
1290
+
1291
+
1292
+
1293
+ <td class="description last">The user's unique identifier.</td>
1294
+ </tr>
1295
+
1296
+
1297
+
1298
+ <tr>
1299
+
1300
+ <td class="name"><code>token</code></td>
1301
+
1302
+
1303
+ <td class="type">
1304
+
1305
+
1306
+ <span class="param-type">string</span>
1307
+
1308
+
1309
+
1310
+
1311
+ </td>
1312
+
1313
+
1314
+
1315
+
1316
+
1317
+ <td class="description last">The JWT token for authentication.</td>
1318
+ </tr>
1319
+
1320
+
1321
+ </tbody>
1322
+ </table>
1323
+
1324
+ </td>
1325
+ </tr>
1326
+
1327
+
1328
+ </tbody>
1329
+ </table>
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+
1342
+
1343
+
1344
+
1345
+
1346
+
1347
+
1348
+
1349
+
1350
+
1351
+
1352
+
1353
+ <h3 class="subsection-title">Type Definitions</h3>
1354
+
1355
+
1356
+
1357
+ <h4 class="name" id="AudioQualitySettings">AudioQualitySettings</h4>
1358
+
1359
+
1360
+
1361
+
1362
+
1363
+ <dl class="details">
1364
+
1365
+
1366
+
1367
+ <dt class="tag-source">Source:</dt>
1368
+ <dd class="tag-source"><ul class="dummy"><li>
1369
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line23">line 23</a>
1370
+ </li></ul></dd>
1371
+
1372
+
1373
+
1374
+
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+
1382
+
1383
+
1384
+
1385
+
1386
+
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+
1398
+
1399
+
1400
+
1401
+
1402
+ </dl>
1403
+
1404
+
1405
+
1406
+ <h5 class="subsection-title">Properties:</h5>
1407
+
1408
+
1409
+
1410
+ <table class="props">
1411
+ <thead>
1412
+ <tr>
1413
+
1414
+ <th>Name</th>
1415
+
1416
+
1417
+ <th>Type</th>
1418
+
1419
+
1420
+
1421
+
1422
+
1423
+ <th class="last">Description</th>
1424
+ </tr>
1425
+ </thead>
1426
+
1427
+ <tbody>
1428
+
1429
+
1430
+ <tr>
1431
+
1432
+ <td class="name"><code>maxBitrate</code></td>
1433
+
1434
+
1435
+ <td class="type">
1436
+
1437
+
1438
+ <span class="param-type">number</span>
1439
+
1440
+
1441
+
1442
+
1443
+ </td>
1444
+
1445
+
1446
+
1447
+
1448
+
1449
+ <td class="description last">Maximum audio bitrate in bps</td>
1450
+ </tr>
1451
+
1452
+
1453
+
1454
+ <tr>
1455
+
1456
+ <td class="name"><code>sampleRate</code></td>
1457
+
1458
+
1459
+ <td class="type">
1460
+
1461
+
1462
+ <span class="param-type">number</span>
1463
+
1464
+
1465
+
1466
+
1467
+ </td>
1468
+
1469
+
1470
+
1471
+
1472
+
1473
+ <td class="description last">Audio sample rate in Hz</td>
1474
+ </tr>
1475
+
1476
+
1477
+
1478
+ <tr>
1479
+
1480
+ <td class="name"><code>channelCount</code></td>
1481
+
1482
+
1483
+ <td class="type">
1484
+
1485
+
1486
+ <span class="param-type">number</span>
1487
+
1488
+
1489
+
1490
+
1491
+ </td>
1492
+
1493
+
1494
+
1495
+
1496
+
1497
+ <td class="description last">Number of audio channels (1=mono, 2=stereo)</td>
1498
+ </tr>
1499
+
1500
+
1501
+ </tbody>
1502
+ </table>
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+ <h5 class="h5-types">Type:</h5>
1512
+ <ul>
1513
+ <li>
1514
+
1515
+ <span class="param-type">Object</span>
1516
+
1517
+
1518
+
1519
+ </li>
1520
+ </ul>
1521
+
1522
+
1523
+
1524
+
1525
+
1526
+
1527
+
1528
+
1529
+ <h4 class="name" id="ConnectionStats">ConnectionStats</h4>
1530
+
1531
+
1532
+
1533
+
1534
+
1535
+ <dl class="details">
1536
+
1537
+
1538
+
1539
+ <dt class="tag-source">Source:</dt>
1540
+ <dd class="tag-source"><ul class="dummy"><li>
1541
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line36">line 36</a>
1542
+ </li></ul></dd>
1543
+
1544
+
1545
+
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+
1558
+
1559
+
1560
+
1561
+
1562
+
1563
+
1564
+
1565
+
1566
+
1567
+
1568
+
1569
+
1570
+
1571
+
1572
+
1573
+
1574
+ </dl>
1575
+
1576
+
1577
+
1578
+ <h5 class="subsection-title">Properties:</h5>
1579
+
1580
+
1581
+
1582
+ <table class="props">
1583
+ <thead>
1584
+ <tr>
1585
+
1586
+ <th>Name</th>
1587
+
1588
+
1589
+ <th>Type</th>
1590
+
1591
+
1592
+
1593
+
1594
+
1595
+ <th class="last">Description</th>
1596
+ </tr>
1597
+ </thead>
1598
+
1599
+ <tbody>
1600
+
1601
+
1602
+ <tr>
1603
+
1604
+ <td class="name"><code>outbound</code></td>
1605
+
1606
+
1607
+ <td class="type">
1608
+
1609
+
1610
+ <span class="param-type">Object</span>
1611
+
1612
+
1613
+
1614
+
1615
+ </td>
1616
+
1617
+
1618
+
1619
+
1620
+
1621
+ <td class="description last">Outbound (sending) statistics
1622
+ <h6>Properties</h6>
1623
+
1624
+ <table class="props">
1625
+ <thead>
1626
+ <tr>
1627
+
1628
+ <th>Name</th>
1629
+
1630
+
1631
+ <th>Type</th>
1632
+
1633
+
1634
+
1635
+
1636
+
1637
+ <th class="last">Description</th>
1638
+ </tr>
1639
+ </thead>
1640
+
1641
+ <tbody>
1642
+
1643
+
1644
+ <tr>
1645
+
1646
+ <td class="name"><code>bitrate</code></td>
1647
+
1648
+
1649
+ <td class="type">
1650
+
1651
+
1652
+ <span class="param-type">number</span>
1653
+
1654
+
1655
+
1656
+
1657
+ </td>
1658
+
1659
+
1660
+
1661
+
1662
+
1663
+ <td class="description last">Current outbound bitrate in bits/s</td>
1664
+ </tr>
1665
+
1666
+
1667
+
1668
+ <tr>
1669
+
1670
+ <td class="name"><code>packetLoss</code></td>
1671
+
1672
+
1673
+ <td class="type">
1674
+
1675
+
1676
+ <span class="param-type">number</span>
1677
+
1678
+
1679
+
1680
+
1681
+ </td>
1682
+
1683
+
1684
+
1685
+
1686
+
1687
+ <td class="description last">Percentage of packets lost</td>
1688
+ </tr>
1689
+
1690
+
1691
+
1692
+ <tr>
1693
+
1694
+ <td class="name"><code>qualityLimitation</code></td>
1695
+
1696
+
1697
+ <td class="type">
1698
+
1699
+
1700
+ <span class="param-type">string</span>
1701
+
1702
+
1703
+
1704
+
1705
+ </td>
1706
+
1707
+
1708
+
1709
+
1710
+
1711
+ <td class="description last">Reason for quality limitations (if any)</td>
1712
+ </tr>
1713
+
1714
+
1715
+ </tbody>
1716
+ </table>
1717
+
1718
+ </td>
1719
+ </tr>
1720
+
1721
+
1722
+
1723
+ <tr>
1724
+
1725
+ <td class="name"><code>inbound</code></td>
1726
+
1727
+
1728
+ <td class="type">
1729
+
1730
+
1731
+ <span class="param-type">Object</span>
1732
+
1733
+
1734
+
1735
+
1736
+ </td>
1737
+
1738
+
1739
+
1740
+
1741
+
1742
+ <td class="description last">Inbound (receiving) statistics per track
1743
+ <h6>Properties</h6>
1744
+
1745
+ <table class="props">
1746
+ <thead>
1747
+ <tr>
1748
+
1749
+ <th>Name</th>
1750
+
1751
+
1752
+ <th>Type</th>
1753
+
1754
+
1755
+
1756
+
1757
+
1758
+ <th class="last">Description</th>
1759
+ </tr>
1760
+ </thead>
1761
+
1762
+ <tbody>
1763
+
1764
+
1765
+ <tr>
1766
+
1767
+ <td class="name"><code>bitrate</code></td>
1768
+
1769
+
1770
+ <td class="type">
1771
+
1772
+
1773
+ <span class="param-type">number</span>
1774
+
1775
+
1776
+
1777
+
1778
+ </td>
1779
+
1780
+
1781
+
1782
+
1783
+
1784
+ <td class="description last">Current inbound bitrate in bits/s</td>
1785
+ </tr>
1786
+
1787
+
1788
+
1789
+ <tr>
1790
+
1791
+ <td class="name"><code>packetLoss</code></td>
1792
+
1793
+
1794
+ <td class="type">
1795
+
1796
+
1797
+ <span class="param-type">number</span>
1798
+
1799
+
1800
+
1801
+
1802
+ </td>
1803
+
1804
+
1805
+
1806
+
1807
+
1808
+ <td class="description last">Percentage of packets lost</td>
1809
+ </tr>
1810
+
1811
+
1812
+
1813
+ <tr>
1814
+
1815
+ <td class="name"><code>jitter</code></td>
1816
+
1817
+
1818
+ <td class="type">
1819
+
1820
+
1821
+ <span class="param-type">number</span>
1822
+
1823
+
1824
+
1825
+
1826
+ </td>
1827
+
1828
+
1829
+
1830
+
1831
+
1832
+ <td class="description last">Current jitter in seconds</td>
1833
+ </tr>
1834
+
1835
+
1836
+ </tbody>
1837
+ </table>
1838
+
1839
+ </td>
1840
+ </tr>
1841
+
1842
+
1843
+
1844
+ <tr>
1845
+
1846
+ <td class="name"><code>connection</code></td>
1847
+
1848
+
1849
+ <td class="type">
1850
+
1851
+
1852
+ <span class="param-type">Object</span>
1853
+
1854
+
1855
+
1856
+
1857
+ </td>
1858
+
1859
+
1860
+
1861
+
1862
+
1863
+ <td class="description last">Overall connection statistics
1864
+ <h6>Properties</h6>
1865
+
1866
+ <table class="props">
1867
+ <thead>
1868
+ <tr>
1869
+
1870
+ <th>Name</th>
1871
+
1872
+
1873
+ <th>Type</th>
1874
+
1875
+
1876
+
1877
+
1878
+
1879
+ <th class="last">Description</th>
1880
+ </tr>
1881
+ </thead>
1882
+
1883
+ <tbody>
1884
+
1885
+
1886
+ <tr>
1887
+
1888
+ <td class="name"><code>roundTripTime</code></td>
1889
+
1890
+
1891
+ <td class="type">
1892
+
1893
+
1894
+ <span class="param-type">number</span>
1895
+
1896
+
1897
+
1898
+
1899
+ </td>
1900
+
1901
+
1902
+
1903
+
1904
+
1905
+ <td class="description last">Current round trip time in seconds</td>
1906
+ </tr>
1907
+
1908
+
1909
+
1910
+ <tr>
1911
+
1912
+ <td class="name"><code>state</code></td>
1913
+
1914
+
1915
+ <td class="type">
1916
+
1917
+
1918
+ <span class="param-type">string</span>
1919
+
1920
+
1921
+
1922
+
1923
+ </td>
1924
+
1925
+
1926
+
1927
+
1928
+
1929
+ <td class="description last">Current connection state</td>
1930
+ </tr>
1931
+
1932
+
1933
+ </tbody>
1934
+ </table>
1935
+
1936
+ </td>
1937
+ </tr>
1938
+
1939
+
1940
+ </tbody>
1941
+ </table>
1942
+
1943
+
1944
+
1945
+
1946
+
1947
+
1948
+
1949
+
1950
+ <h5 class="h5-types">Type:</h5>
1951
+ <ul>
1952
+ <li>
1953
+
1954
+ <span class="param-type">Object</span>
1955
+
1956
+
1957
+
1958
+ </li>
1959
+ </ul>
1960
+
1961
+
1962
+
1963
+
1964
+
1965
+
1966
+
1967
+
1968
+ <h4 class="name" id="QualityPreset">QualityPreset</h4>
1969
+
1970
+
1971
+
1972
+
1973
+
1974
+ <dl class="details">
1975
+
1976
+
1977
+
1978
+ <dt class="tag-source">Source:</dt>
1979
+ <dd class="tag-source"><ul class="dummy"><li>
1980
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line30">line 30</a>
1981
+ </li></ul></dd>
1982
+
1983
+
1984
+
1985
+
1986
+
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+
1993
+
1994
+
1995
+
1996
+
1997
+
1998
+
1999
+
2000
+
2001
+
2002
+
2003
+
2004
+
2005
+
2006
+
2007
+
2008
+
2009
+
2010
+
2011
+
2012
+
2013
+ </dl>
2014
+
2015
+
2016
+
2017
+ <h5 class="subsection-title">Properties:</h5>
2018
+
2019
+
2020
+
2021
+ <table class="props">
2022
+ <thead>
2023
+ <tr>
2024
+
2025
+ <th>Name</th>
2026
+
2027
+
2028
+ <th>Type</th>
2029
+
2030
+
2031
+
2032
+
2033
+
2034
+ <th class="last">Description</th>
2035
+ </tr>
2036
+ </thead>
2037
+
2038
+ <tbody>
2039
+
2040
+
2041
+ <tr>
2042
+
2043
+ <td class="name"><code>video</code></td>
2044
+
2045
+
2046
+ <td class="type">
2047
+
2048
+
2049
+ <span class="param-type"><a href="global.html#VideoQualitySettings">VideoQualitySettings</a></span>
2050
+
2051
+
2052
+
2053
+
2054
+ </td>
2055
+
2056
+
2057
+
2058
+
2059
+
2060
+ <td class="description last">Video quality settings</td>
2061
+ </tr>
2062
+
2063
+
2064
+
2065
+ <tr>
2066
+
2067
+ <td class="name"><code>audio</code></td>
2068
+
2069
+
2070
+ <td class="type">
2071
+
2072
+
2073
+ <span class="param-type"><a href="global.html#AudioQualitySettings">AudioQualitySettings</a></span>
2074
+
2075
+
2076
+
2077
+
2078
+ </td>
2079
+
2080
+
2081
+
2082
+
2083
+
2084
+ <td class="description last">Audio quality settings</td>
2085
+ </tr>
2086
+
2087
+
2088
+ </tbody>
2089
+ </table>
2090
+
2091
+
2092
+
2093
+
2094
+
2095
+
2096
+
2097
+
2098
+ <h5 class="h5-types">Type:</h5>
2099
+ <ul>
2100
+ <li>
2101
+
2102
+ <span class="param-type">Object</span>
2103
+
2104
+
2105
+
2106
+ </li>
2107
+ </ul>
2108
+
2109
+
2110
+
2111
+
2112
+
2113
+
2114
+
2115
+
2116
+ <h4 class="name" id="Room">Room</h4>
2117
+
2118
+
2119
+
2120
+
2121
+
2122
+ <dl class="details">
2123
+
2124
+ <dt class="tag-description">Description:</dt>
2125
+ <dd class="tag-description"><ul class="dummy"><li>In-memory storage for rooms and participants.</li></ul></dd>
2126
+
2127
+
2128
+
2129
+ <dt class="tag-source">Source:</dt>
2130
+ <dd class="tag-source"><ul class="dummy"><li>
2131
+ <a href="index.js.html">index.js</a>, <a href="index.js.html#line78">line 78</a>
2132
+ </li></ul></dd>
2133
+
2134
+
2135
+
2136
+
2137
+
2138
+
2139
+
2140
+
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+
2147
+
2148
+
2149
+
2150
+
2151
+
2152
+
2153
+
2154
+
2155
+
2156
+
2157
+
2158
+
2159
+
2160
+
2161
+
2162
+
2163
+
2164
+ </dl>
2165
+
2166
+
2167
+
2168
+ <h5 class="subsection-title">Properties:</h5>
2169
+
2170
+
2171
+
2172
+ <table class="props">
2173
+ <thead>
2174
+ <tr>
2175
+
2176
+ <th>Name</th>
2177
+
2178
+
2179
+ <th>Type</th>
2180
+
2181
+
2182
+
2183
+
2184
+
2185
+ <th class="last">Description</th>
2186
+ </tr>
2187
+ </thead>
2188
+
2189
+ <tbody>
2190
+
2191
+
2192
+ <tr>
2193
+
2194
+ <td class="name"><code>userId</code></td>
2195
+
2196
+
2197
+ <td class="type">
2198
+
2199
+
2200
+ <span class="param-type">string</span>
2201
+
2202
+
2203
+
2204
+
2205
+ </td>
2206
+
2207
+
2208
+
2209
+
2210
+
2211
+ <td class="description last">Unique identifier for the user.</td>
2212
+ </tr>
2213
+
2214
+
2215
+
2216
+ <tr>
2217
+
2218
+ <td class="name"><code>sessionId</code></td>
2219
+
2220
+
2221
+ <td class="type">
2222
+
2223
+
2224
+ <span class="param-type">string</span>
2225
+
2226
+
2227
+
2228
+
2229
+ </td>
2230
+
2231
+
2232
+
2233
+
2234
+
2235
+ <td class="description last">Unique identifier for the session.</td>
2236
+ </tr>
2237
+
2238
+
2239
+
2240
+ <tr>
2241
+
2242
+ <td class="name"><code>createdAt</code></td>
2243
+
2244
+
2245
+ <td class="type">
2246
+
2247
+
2248
+ <span class="param-type">number</span>
2249
+
2250
+
2251
+
2252
+
2253
+ </td>
2254
+
2255
+
2256
+
2257
+
2258
+
2259
+ <td class="description last">Timestamp when the participant was added.</td>
2260
+ </tr>
2261
+
2262
+
2263
+
2264
+ <tr>
2265
+
2266
+ <td class="name"><code>offers</code></td>
2267
+
2268
+
2269
+ <td class="type">
2270
+
2271
+
2272
+ <span class="param-type">Array</span>
2273
+
2274
+
2275
+
2276
+
2277
+ </td>
2278
+
2279
+
2280
+
2281
+
2282
+
2283
+ <td class="description last">Array of offer objects.</td>
2284
+ </tr>
2285
+
2286
+
2287
+ </tbody>
2288
+ </table>
2289
+
2290
+
2291
+
2292
+
2293
+
2294
+
2295
+ <div class="description usertext">
2296
+ In-memory storage for rooms and participants.
2297
+ </div>
2298
+
2299
+
2300
+
2301
+ <h5 class="h5-types">Type:</h5>
2302
+ <ul>
2303
+ <li>
2304
+
2305
+ <span class="param-type">Object</span>
2306
+
2307
+
2308
+
2309
+ </li>
2310
+ </ul>
2311
+
2312
+
2313
+
2314
+
2315
+
2316
+
2317
+
2318
+
2319
+ <h4 class="name" id="StreamStats">StreamStats</h4>
2320
+
2321
+
2322
+
2323
+
2324
+
2325
+ <dl class="details">
2326
+
2327
+
2328
+
2329
+ <dt class="tag-source">Source:</dt>
2330
+ <dd class="tag-source"><ul class="dummy"><li>
2331
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line51">line 51</a>
2332
+ </li></ul></dd>
2333
+
2334
+
2335
+
2336
+
2337
+
2338
+
2339
+
2340
+
2341
+
2342
+
2343
+
2344
+
2345
+
2346
+
2347
+
2348
+
2349
+
2350
+
2351
+
2352
+
2353
+
2354
+
2355
+
2356
+
2357
+
2358
+
2359
+
2360
+
2361
+
2362
+
2363
+
2364
+ </dl>
2365
+
2366
+
2367
+
2368
+ <h5 class="subsection-title">Properties:</h5>
2369
+
2370
+
2371
+
2372
+ <table class="props">
2373
+ <thead>
2374
+ <tr>
2375
+
2376
+ <th>Name</th>
2377
+
2378
+
2379
+ <th>Type</th>
2380
+
2381
+
2382
+
2383
+
2384
+
2385
+ <th class="last">Description</th>
2386
+ </tr>
2387
+ </thead>
2388
+
2389
+ <tbody>
2390
+
2391
+
2392
+ <tr>
2393
+
2394
+ <td class="name"><code>sessionId</code></td>
2395
+
2396
+
2397
+ <td class="type">
2398
+
2399
+
2400
+ <span class="param-type">string</span>
2401
+
2402
+
2403
+
2404
+
2405
+ </td>
2406
+
2407
+
2408
+
2409
+
2410
+
2411
+ <td class="description last">Session ID of the stream</td>
2412
+ </tr>
2413
+
2414
+
2415
+
2416
+ <tr>
2417
+
2418
+ <td class="name"><code>packetLoss</code></td>
2419
+
2420
+
2421
+ <td class="type">
2422
+
2423
+
2424
+ <span class="param-type">number</span>
2425
+
2426
+
2427
+
2428
+
2429
+ </td>
2430
+
2431
+
2432
+
2433
+
2434
+
2435
+ <td class="description last">Packet loss percentage</td>
2436
+ </tr>
2437
+
2438
+
2439
+
2440
+ <tr>
2441
+
2442
+ <td class="name"><code>qualityLimitation</code></td>
2443
+
2444
+
2445
+ <td class="type">
2446
+
2447
+
2448
+ <span class="param-type">string</span>
2449
+
2450
+
2451
+
2452
+
2453
+ </td>
2454
+
2455
+
2456
+
2457
+
2458
+
2459
+ <td class="description last">Quality limitation reason</td>
2460
+ </tr>
2461
+
2462
+
2463
+
2464
+ <tr>
2465
+
2466
+ <td class="name"><code>bitrate</code></td>
2467
+
2468
+
2469
+ <td class="type">
2470
+
2471
+
2472
+ <span class="param-type">number</span>
2473
+
2474
+
2475
+
2476
+
2477
+ </td>
2478
+
2479
+
2480
+
2481
+
2482
+
2483
+ <td class="description last">Current bitrate</td>
2484
+ </tr>
2485
+
2486
+
2487
+ </tbody>
2488
+ </table>
2489
+
2490
+
2491
+
2492
+
2493
+
2494
+
2495
+
2496
+
2497
+ <h5 class="h5-types">Type:</h5>
2498
+ <ul>
2499
+ <li>
2500
+
2501
+ <span class="param-type">Object</span>
2502
+
2503
+
2504
+
2505
+ </li>
2506
+ </ul>
2507
+
2508
+
2509
+
2510
+
2511
+
2512
+
2513
+
2514
+
2515
+ <h4 class="name" id="VideoQualitySettings">VideoQualitySettings</h4>
2516
+
2517
+
2518
+
2519
+
2520
+
2521
+ <dl class="details">
2522
+
2523
+
2524
+
2525
+ <dt class="tag-source">Source:</dt>
2526
+ <dd class="tag-source"><ul class="dummy"><li>
2527
+ <a href="public_CloudflareCalls.js.html">public/CloudflareCalls.js</a>, <a href="public_CloudflareCalls.js.html#line12">line 12</a>
2528
+ </li></ul></dd>
2529
+
2530
+
2531
+
2532
+
2533
+
2534
+
2535
+
2536
+
2537
+
2538
+
2539
+
2540
+
2541
+
2542
+
2543
+
2544
+
2545
+
2546
+
2547
+
2548
+
2549
+
2550
+
2551
+
2552
+
2553
+
2554
+
2555
+
2556
+
2557
+
2558
+
2559
+
2560
+ </dl>
2561
+
2562
+
2563
+
2564
+ <h5 class="subsection-title">Properties:</h5>
2565
+
2566
+
2567
+
2568
+ <table class="props">
2569
+ <thead>
2570
+ <tr>
2571
+
2572
+ <th>Name</th>
2573
+
2574
+
2575
+ <th>Type</th>
2576
+
2577
+
2578
+
2579
+
2580
+
2581
+ <th class="last">Description</th>
2582
+ </tr>
2583
+ </thead>
2584
+
2585
+ <tbody>
2586
+
2587
+
2588
+ <tr>
2589
+
2590
+ <td class="name"><code>width</code></td>
2591
+
2592
+
2593
+ <td class="type">
2594
+
2595
+
2596
+ <span class="param-type">Object</span>
2597
+
2598
+
2599
+
2600
+
2601
+ </td>
2602
+
2603
+
2604
+
2605
+
2606
+
2607
+ <td class="description last">Video width settings
2608
+ <h6>Properties</h6>
2609
+
2610
+ <table class="props">
2611
+ <thead>
2612
+ <tr>
2613
+
2614
+ <th>Name</th>
2615
+
2616
+
2617
+ <th>Type</th>
2618
+
2619
+
2620
+
2621
+
2622
+
2623
+ <th class="last">Description</th>
2624
+ </tr>
2625
+ </thead>
2626
+
2627
+ <tbody>
2628
+
2629
+
2630
+ <tr>
2631
+
2632
+ <td class="name"><code>ideal</code></td>
2633
+
2634
+
2635
+ <td class="type">
2636
+
2637
+
2638
+ <span class="param-type">number</span>
2639
+
2640
+
2641
+
2642
+
2643
+ </td>
2644
+
2645
+
2646
+
2647
+
2648
+
2649
+ <td class="description last">Ideal video width in pixels</td>
2650
+ </tr>
2651
+
2652
+
2653
+ </tbody>
2654
+ </table>
2655
+
2656
+ </td>
2657
+ </tr>
2658
+
2659
+
2660
+
2661
+ <tr>
2662
+
2663
+ <td class="name"><code>height</code></td>
2664
+
2665
+
2666
+ <td class="type">
2667
+
2668
+
2669
+ <span class="param-type">Object</span>
2670
+
2671
+
2672
+
2673
+
2674
+ </td>
2675
+
2676
+
2677
+
2678
+
2679
+
2680
+ <td class="description last">Video height settings
2681
+ <h6>Properties</h6>
2682
+
2683
+ <table class="props">
2684
+ <thead>
2685
+ <tr>
2686
+
2687
+ <th>Name</th>
2688
+
2689
+
2690
+ <th>Type</th>
2691
+
2692
+
2693
+
2694
+
2695
+
2696
+ <th class="last">Description</th>
2697
+ </tr>
2698
+ </thead>
2699
+
2700
+ <tbody>
2701
+
2702
+
2703
+ <tr>
2704
+
2705
+ <td class="name"><code>ideal</code></td>
2706
+
2707
+
2708
+ <td class="type">
2709
+
2710
+
2711
+ <span class="param-type">number</span>
2712
+
2713
+
2714
+
2715
+
2716
+ </td>
2717
+
2718
+
2719
+
2720
+
2721
+
2722
+ <td class="description last">Ideal video height in pixels</td>
2723
+ </tr>
2724
+
2725
+
2726
+ </tbody>
2727
+ </table>
2728
+
2729
+ </td>
2730
+ </tr>
2731
+
2732
+
2733
+
2734
+ <tr>
2735
+
2736
+ <td class="name"><code>frameRate</code></td>
2737
+
2738
+
2739
+ <td class="type">
2740
+
2741
+
2742
+ <span class="param-type">Object</span>
2743
+
2744
+
2745
+
2746
+
2747
+ </td>
2748
+
2749
+
2750
+
2751
+
2752
+
2753
+ <td class="description last">Frame rate settings
2754
+ <h6>Properties</h6>
2755
+
2756
+ <table class="props">
2757
+ <thead>
2758
+ <tr>
2759
+
2760
+ <th>Name</th>
2761
+
2762
+
2763
+ <th>Type</th>
2764
+
2765
+
2766
+
2767
+
2768
+
2769
+ <th class="last">Description</th>
2770
+ </tr>
2771
+ </thead>
2772
+
2773
+ <tbody>
2774
+
2775
+
2776
+ <tr>
2777
+
2778
+ <td class="name"><code>ideal</code></td>
2779
+
2780
+
2781
+ <td class="type">
2782
+
2783
+
2784
+ <span class="param-type">number</span>
2785
+
2786
+
2787
+
2788
+
2789
+ </td>
2790
+
2791
+
2792
+
2793
+
2794
+
2795
+ <td class="description last">Ideal frame rate in fps</td>
2796
+ </tr>
2797
+
2798
+
2799
+ </tbody>
2800
+ </table>
2801
+
2802
+ </td>
2803
+ </tr>
2804
+
2805
+
2806
+
2807
+ <tr>
2808
+
2809
+ <td class="name"><code>maxBitrate</code></td>
2810
+
2811
+
2812
+ <td class="type">
2813
+
2814
+
2815
+ <span class="param-type">number</span>
2816
+
2817
+
2818
+
2819
+
2820
+ </td>
2821
+
2822
+
2823
+
2824
+
2825
+
2826
+ <td class="description last">Maximum video bitrate in bps</td>
2827
+ </tr>
2828
+
2829
+
2830
+ </tbody>
2831
+ </table>
2832
+
2833
+
2834
+
2835
+
2836
+
2837
+
2838
+
2839
+
2840
+ <h5 class="h5-types">Type:</h5>
2841
+ <ul>
2842
+ <li>
2843
+
2844
+ <span class="param-type">Object</span>
2845
+
2846
+
2847
+
2848
+ </li>
2849
+ </ul>
2850
+
2851
+
2852
+
2853
+
2854
+
2855
+
2856
+
2857
+
2858
+
2859
+
2860
+ </article>
2861
+
2862
+ </section>
2863
+
2864
+
2865
+
2866
+
2867
+
2868
+
2869
+ </div>
2870
+
2871
+ <br class="clear">
2872
+
2873
+ <footer>
2874
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Tue Dec 31 2024 08:15:00 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2875
+ </footer>
2876
+
2877
+ <script>prettyPrint();</script>
2878
+ <script src="scripts/polyfill.js"></script>
2879
+ <script src="scripts/linenumber.js"></script>
2880
+
2881
+
2882
+
2883
+ </body>
2884
+
2885
+ <!-- Mirrored from cloudflarecalls.jamesfuthey.com/docs/global.html by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 19 Feb 2025 14:59:45 GMT -->
2886
+ </html>
index-2.html ADDED
@@ -0,0 +1,127 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <!-- Mirrored from cloudflarecalls.jamesfuthey.com/docs/index.html by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 19 Feb 2025 14:59:44 GMT -->
5
+ <!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=UTF-8" /><!-- /Added by HTTrack -->
6
+ <head>
7
+
8
+ <meta charset="utf-8">
9
+ <title>Home - Documentation</title>
10
+
11
+
12
+ <script src="scripts/prettify/prettify.js"></script>
13
+ <script src="scripts/prettify/lang-css.js"></script>
14
+ <!--[if lt IE 9]>
15
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
+ <![endif]-->
17
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
18
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
19
+ <script src="scripts/nav.js" defer></script>
20
+
21
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
22
+ </head>
23
+ <body>
24
+
25
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
26
+ <label for="nav-trigger" class="navicon-button x">
27
+ <div class="navicon"></div>
28
+ </label>
29
+
30
+ <label for="nav-trigger" class="overlay"></label>
31
+
32
+ <nav >
33
+
34
+
35
+ <h2><a href="index-2.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CloudflareCalls.html">CloudflareCalls</a><ul class='methods'><li data-type='method'><a href="CloudflareCalls.html#createRoom">createRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#getAvailableDevices">getAvailableDevices</a></li><li data-type='method'><a href="CloudflareCalls.html#getConnectionStats">getConnectionStats</a></li><li data-type='method'><a href="CloudflareCalls.html#getSessionState">getSessionState</a></li><li data-type='method'><a href="CloudflareCalls.html#getTrackStatus">getTrackStatus</a></li><li data-type='method'><a href="CloudflareCalls.html#getUserInfo">getUserInfo</a></li><li data-type='method'><a href="CloudflareCalls.html#getUserMetadata">getUserMetadata</a></li><li data-type='method'><a href="CloudflareCalls.html#joinRoom">joinRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#leaveRoom">leaveRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#listParticipants">listParticipants</a></li><li data-type='method'><a href="CloudflareCalls.html#listRooms">listRooms</a></li><li data-type='method'><a href="CloudflareCalls.html#onConnectionStats">onConnectionStats</a></li><li data-type='method'><a href="CloudflareCalls.html#onDataMessage">onDataMessage</a></li><li data-type='method'><a href="CloudflareCalls.html#onParticipantJoined">onParticipantJoined</a></li><li data-type='method'><a href="CloudflareCalls.html#onParticipantLeft">onParticipantLeft</a></li><li data-type='method'><a href="CloudflareCalls.html#onRemoteTrack">onRemoteTrack</a></li><li data-type='method'><a href="CloudflareCalls.html#onRemoteTrackUnpublished">onRemoteTrackUnpublished</a></li><li data-type='method'><a href="CloudflareCalls.html#onRoomMetadataUpdated">onRoomMetadataUpdated</a></li><li data-type='method'><a href="CloudflareCalls.html#onTrackStatusChanged">onTrackStatusChanged</a></li><li data-type='method'><a href="CloudflareCalls.html#onWebSocketMessage">onWebSocketMessage</a></li><li data-type='method'><a href="CloudflareCalls.html#previewMedia">previewMedia</a></li><li data-type='method'><a href="CloudflareCalls.html#publishTracks">publishTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#selectAudioInputDevice">selectAudioInputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#selectAudioOutputDevice">selectAudioOutputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#selectVideoInputDevice">selectVideoInputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#sendDataToAll">sendDataToAll</a></li><li data-type='method'><a href="CloudflareCalls.html#setDebugMode">setDebugMode</a></li><li data-type='method'><a href="CloudflareCalls.html#setMediaQuality">setMediaQuality</a></li><li data-type='method'><a href="CloudflareCalls.html#setToken">setToken</a></li><li data-type='method'><a href="CloudflareCalls.html#setUserMetadata">setUserMetadata</a></li><li data-type='method'><a href="CloudflareCalls.html#shareScreen">shareScreen</a></li><li data-type='method'><a href="CloudflareCalls.html#startStatsMonitoring">startStatsMonitoring</a></li><li data-type='method'><a href="CloudflareCalls.html#stopStatsMonitoring">stopStatsMonitoring</a></li><li data-type='method'><a href="CloudflareCalls.html#toggleMedia">toggleMedia</a></li><li data-type='method'><a href="CloudflareCalls.html#unpublishAllTracks">unpublishAllTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#updatePublishedTracks">updatePublishedTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#updateRoomMetadata">updateRoomMetadata</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#broadcastToRoom">broadcastToRoom</a></li><li><a href="global.html#getRoomIdByUserId">getRoomIdByUserId</a></li><li><a href="global.html#getWebSocketByUserId">getWebSocketByUserId</a></li><li><a href="global.html#handleDataMessage">handleDataMessage</a></li><li><a href="global.html#handleWSDisconnect">handleWSDisconnect</a></li><li><a href="global.html#handleWSJoin">handleWSJoin</a></li><li><a href="global.html#rooms">rooms</a></li><li><a href="global.html#server">server</a></li></ul>
36
+
37
+ </nav>
38
+
39
+ <div id="main">
40
+
41
+
42
+
43
+
44
+
45
+
46
+
47
+
48
+
49
+ <section class="package">
50
+ <h3> </h3>
51
+ </section>
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+ <section class="readme usertext">
66
+ <article><h1>CloudflareCalls.js</h1>
67
+ <p>A reference implementation of Cloudflare Calls, including a client-side library <a href="CloudflareCalls.html">(CloudflareCalls class)</a>, and a minimal Express <a href="api/index.html">signaling server</a>.</p>
68
+ <p><a href="index.html">Library Docs</a> | <a href="api/index.html">API (server) Docs</a> | <a href="https://github.com/kidGodzilla/CloudflareCalls">GitHub</a> | <a href="../index.html">Demo</a></p>
69
+ <h1>Getting Started</h1>
70
+ <p>Cloudflare Calls requires a backend server to protect its <code>CLOUDFLARE_APP_ID</code> and <code>CLOUDFLARE_APP_SECRET</code>. These are stored as environment variables in this example.</p>
71
+ <p>Optionally, <code>CLOUDFLARE_TURN_ID</code> and <code>CLOUDFLARE_TURN_TOKEN</code> are used to authenticate users to Cloudflare's ICE servers.</p>
72
+ <p>You will receive all of these tokens and identifiers after creating a <a href="https://dash.cloudflare.com/?to=/:account/calls">Cloudflare Calls Serverless SFU app</a> on your dashboard. The TURN section is optional, but recommended.</p>
73
+ <p>Your backend server (and our Express server in this example) is responsible for peer discovery and track discovery. Cloudflare does not provide this as part of the Calls service.</p>
74
+ <p>Authentication and moderation functions should be implemented on the provided routes as you see fit for your application.</p>
75
+ <p>The included <code>/auth/token</code> route on the server is for demonstration only, and issues a JWT token without authentication, to demonstrate the implementation requirements in the client library and server to secure requests to SFU resources.</p>
76
+ <p>Everything you need to run the demo app is included in the example server, with no special dependencies. There is no database so it cannot scale past a single server instance.</p>
77
+ <h2>Demo</h2>
78
+ <p>Try the <a href="../index.html">demo</a> to see how the implemented methods function in a real application.</p>
79
+ <h1>Usage</h1>
80
+ <h2>Setting up</h2>
81
+ <ol>
82
+ <li>Instantiate an instance of <code>CloudflareCalls</code> class:</li>
83
+ </ol>
84
+ <pre class="prettyprint source lang-js"><code>import CloudflareCalls from './CloudflareCalls.js';
85
+
86
+ const calls = new CloudflareCalls({
87
+ backendUrl: 'http://localhost:5001',
88
+ websocketUrl: 'ws://localhost:5001'
89
+ });
90
+ </code></pre>
91
+ <p>Additionally, Cloudflare recommends the inclusion of the <a href="https://cdnjs.com/libraries/webrtc-adapter/8.1.2">webrtc-adapter</a>. This is a shim to insulate apps from WebRTC spec changes and browser prefix differences.</p>
92
+ <h2>Establishing a call between participants</h2>
93
+ <ol start="2">
94
+ <li><a href="CloudflareCalls.html#getAvailableDevices">Get media devices</a></li>
95
+ <li><a href="CloudflareCalls.html#previewMedia">Preview Media (optional)</a></li>
96
+ <li>Handle <a href="CloudflareCalls.html#onParticipantJoined">onParticipantJoined</a>, <a href="CloudflareCalls.html#onRemoteTrack">onRemoteTrack</a>, <a href="CloudflareCalls.html#onDataMessage">onDataMessage</a></li>
97
+ <li><a href="CloudflareCalls.html#createRoom">Create a room</a> (only one participant needs to do this, returns a GUID)</li>
98
+ <li><a href="CloudflareCalls.html#joinRoom">Join a room</a> (by GUID)</li>
99
+ </ol>
100
+ <p>You can see an example of this flow in the example included at <code>public/index.html</code>.</p></article>
101
+ </section>
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ </div>
111
+
112
+ <br class="clear">
113
+
114
+ <footer>
115
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Tue Dec 31 2024 08:15:00 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
116
+ </footer>
117
+
118
+ <script>prettyPrint();</script>
119
+ <script src="scripts/polyfill.js"></script>
120
+ <script src="scripts/linenumber.js"></script>
121
+
122
+
123
+
124
+ </body>
125
+
126
+ <!-- Mirrored from cloudflarecalls.jamesfuthey.com/docs/index.html by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 19 Feb 2025 14:59:44 GMT -->
127
+ </html>
index.html ADDED
@@ -0,0 +1,127 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <!-- Mirrored from cloudflarecalls.jamesfuthey.com/docs/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 19 Feb 2025 14:59:24 GMT -->
5
+ <!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=UTF-8" /><!-- /Added by HTTrack -->
6
+ <head>
7
+
8
+ <meta charset="utf-8">
9
+ <title>Home - Documentation</title>
10
+
11
+
12
+ <script src="scripts/prettify/prettify.js"></script>
13
+ <script src="scripts/prettify/lang-css.js"></script>
14
+ <!--[if lt IE 9]>
15
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
+ <![endif]-->
17
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
18
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
19
+ <script src="scripts/nav.js" defer></script>
20
+
21
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
22
+ </head>
23
+ <body>
24
+
25
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
26
+ <label for="nav-trigger" class="navicon-button x">
27
+ <div class="navicon"></div>
28
+ </label>
29
+
30
+ <label for="nav-trigger" class="overlay"></label>
31
+
32
+ <nav >
33
+
34
+
35
+ <h2><a href="index-2.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CloudflareCalls.html">CloudflareCalls</a><ul class='methods'><li data-type='method'><a href="CloudflareCalls.html#createRoom">createRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#getAvailableDevices">getAvailableDevices</a></li><li data-type='method'><a href="CloudflareCalls.html#getConnectionStats">getConnectionStats</a></li><li data-type='method'><a href="CloudflareCalls.html#getSessionState">getSessionState</a></li><li data-type='method'><a href="CloudflareCalls.html#getTrackStatus">getTrackStatus</a></li><li data-type='method'><a href="CloudflareCalls.html#getUserInfo">getUserInfo</a></li><li data-type='method'><a href="CloudflareCalls.html#getUserMetadata">getUserMetadata</a></li><li data-type='method'><a href="CloudflareCalls.html#joinRoom">joinRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#leaveRoom">leaveRoom</a></li><li data-type='method'><a href="CloudflareCalls.html#listParticipants">listParticipants</a></li><li data-type='method'><a href="CloudflareCalls.html#listRooms">listRooms</a></li><li data-type='method'><a href="CloudflareCalls.html#onConnectionStats">onConnectionStats</a></li><li data-type='method'><a href="CloudflareCalls.html#onDataMessage">onDataMessage</a></li><li data-type='method'><a href="CloudflareCalls.html#onParticipantJoined">onParticipantJoined</a></li><li data-type='method'><a href="CloudflareCalls.html#onParticipantLeft">onParticipantLeft</a></li><li data-type='method'><a href="CloudflareCalls.html#onRemoteTrack">onRemoteTrack</a></li><li data-type='method'><a href="CloudflareCalls.html#onRemoteTrackUnpublished">onRemoteTrackUnpublished</a></li><li data-type='method'><a href="CloudflareCalls.html#onRoomMetadataUpdated">onRoomMetadataUpdated</a></li><li data-type='method'><a href="CloudflareCalls.html#onTrackStatusChanged">onTrackStatusChanged</a></li><li data-type='method'><a href="CloudflareCalls.html#onWebSocketMessage">onWebSocketMessage</a></li><li data-type='method'><a href="CloudflareCalls.html#previewMedia">previewMedia</a></li><li data-type='method'><a href="CloudflareCalls.html#publishTracks">publishTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#selectAudioInputDevice">selectAudioInputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#selectAudioOutputDevice">selectAudioOutputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#selectVideoInputDevice">selectVideoInputDevice</a></li><li data-type='method'><a href="CloudflareCalls.html#sendDataToAll">sendDataToAll</a></li><li data-type='method'><a href="CloudflareCalls.html#setDebugMode">setDebugMode</a></li><li data-type='method'><a href="CloudflareCalls.html#setMediaQuality">setMediaQuality</a></li><li data-type='method'><a href="CloudflareCalls.html#setToken">setToken</a></li><li data-type='method'><a href="CloudflareCalls.html#setUserMetadata">setUserMetadata</a></li><li data-type='method'><a href="CloudflareCalls.html#shareScreen">shareScreen</a></li><li data-type='method'><a href="CloudflareCalls.html#startStatsMonitoring">startStatsMonitoring</a></li><li data-type='method'><a href="CloudflareCalls.html#stopStatsMonitoring">stopStatsMonitoring</a></li><li data-type='method'><a href="CloudflareCalls.html#toggleMedia">toggleMedia</a></li><li data-type='method'><a href="CloudflareCalls.html#unpublishAllTracks">unpublishAllTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#updatePublishedTracks">updatePublishedTracks</a></li><li data-type='method'><a href="CloudflareCalls.html#updateRoomMetadata">updateRoomMetadata</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#broadcastToRoom">broadcastToRoom</a></li><li><a href="global.html#getRoomIdByUserId">getRoomIdByUserId</a></li><li><a href="global.html#getWebSocketByUserId">getWebSocketByUserId</a></li><li><a href="global.html#handleDataMessage">handleDataMessage</a></li><li><a href="global.html#handleWSDisconnect">handleWSDisconnect</a></li><li><a href="global.html#handleWSJoin">handleWSJoin</a></li><li><a href="global.html#rooms">rooms</a></li><li><a href="global.html#server">server</a></li></ul>
36
+
37
+ </nav>
38
+
39
+ <div id="main">
40
+
41
+
42
+
43
+
44
+
45
+
46
+
47
+
48
+
49
+ <section class="package">
50
+ <h3> </h3>
51
+ </section>
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+ <section class="readme usertext">
66
+ <article><h1>CloudflareCalls.js</h1>
67
+ <p>A reference implementation of Cloudflare Calls, including a client-side library <a href="CloudflareCalls.html">(CloudflareCalls class)</a>, and a minimal Express <a href="api/index.html">signaling server</a>.</p>
68
+ <p><a href="index.html">Library Docs</a> | <a href="api/index.html">API (server) Docs</a> | <a href="https://github.com/kidGodzilla/CloudflareCalls">GitHub</a> | <a href="../index.html">Demo</a></p>
69
+ <h1>Getting Started</h1>
70
+ <p>Cloudflare Calls requires a backend server to protect its <code>CLOUDFLARE_APP_ID</code> and <code>CLOUDFLARE_APP_SECRET</code>. These are stored as environment variables in this example.</p>
71
+ <p>Optionally, <code>CLOUDFLARE_TURN_ID</code> and <code>CLOUDFLARE_TURN_TOKEN</code> are used to authenticate users to Cloudflare's ICE servers.</p>
72
+ <p>You will receive all of these tokens and identifiers after creating a <a href="https://dash.cloudflare.com/?to=/:account/calls">Cloudflare Calls Serverless SFU app</a> on your dashboard. The TURN section is optional, but recommended.</p>
73
+ <p>Your backend server (and our Express server in this example) is responsible for peer discovery and track discovery. Cloudflare does not provide this as part of the Calls service.</p>
74
+ <p>Authentication and moderation functions should be implemented on the provided routes as you see fit for your application.</p>
75
+ <p>The included <code>/auth/token</code> route on the server is for demonstration only, and issues a JWT token without authentication, to demonstrate the implementation requirements in the client library and server to secure requests to SFU resources.</p>
76
+ <p>Everything you need to run the demo app is included in the example server, with no special dependencies. There is no database so it cannot scale past a single server instance.</p>
77
+ <h2>Demo</h2>
78
+ <p>Try the <a href="../index.html">demo</a> to see how the implemented methods function in a real application.</p>
79
+ <h1>Usage</h1>
80
+ <h2>Setting up</h2>
81
+ <ol>
82
+ <li>Instantiate an instance of <code>CloudflareCalls</code> class:</li>
83
+ </ol>
84
+ <pre class="prettyprint source lang-js"><code>import CloudflareCalls from './CloudflareCalls.js';
85
+
86
+ const calls = new CloudflareCalls({
87
+ backendUrl: 'http://localhost:5001',
88
+ websocketUrl: 'ws://localhost:5001'
89
+ });
90
+ </code></pre>
91
+ <p>Additionally, Cloudflare recommends the inclusion of the <a href="https://cdnjs.com/libraries/webrtc-adapter/8.1.2">webrtc-adapter</a>. This is a shim to insulate apps from WebRTC spec changes and browser prefix differences.</p>
92
+ <h2>Establishing a call between participants</h2>
93
+ <ol start="2">
94
+ <li><a href="CloudflareCalls.html#getAvailableDevices">Get media devices</a></li>
95
+ <li><a href="CloudflareCalls.html#previewMedia">Preview Media (optional)</a></li>
96
+ <li>Handle <a href="CloudflareCalls.html#onParticipantJoined">onParticipantJoined</a>, <a href="CloudflareCalls.html#onRemoteTrack">onRemoteTrack</a>, <a href="CloudflareCalls.html#onDataMessage">onDataMessage</a></li>
97
+ <li><a href="CloudflareCalls.html#createRoom">Create a room</a> (only one participant needs to do this, returns a GUID)</li>
98
+ <li><a href="CloudflareCalls.html#joinRoom">Join a room</a> (by GUID)</li>
99
+ </ol>
100
+ <p>You can see an example of this flow in the example included at <code>public/index.html</code>.</p></article>
101
+ </section>
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ </div>
111
+
112
+ <br class="clear">
113
+
114
+ <footer>
115
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Tue Dec 31 2024 08:15:00 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
116
+ </footer>
117
+
118
+ <script>prettyPrint();</script>
119
+ <script src="scripts/polyfill.js"></script>
120
+ <script src="scripts/linenumber.js"></script>
121
+
122
+
123
+
124
+ </body>
125
+
126
+ <!-- Mirrored from cloudflarecalls.jamesfuthey.com/docs/ by HTTrack Website Copier/3.x [XR&CO'2014], Wed, 19 Feb 2025 14:59:28 GMT -->
127
+ </html>