Lumen help
Introduction
Mesh Delivery instances are always exposed on the global namespace.
You can obtain the number of instances with the following:
window.Streamroot.instances.length
But in general, when you have only one instance on your page, you can access the data using
window.Streamroot.instances[0]
Example
When calling :
it returns :
API Table
Name |
Description |
dnaDownloadAllowed |
Getter/Setter to switch peer download ON or OFF, regardless of the network type |
dnaDownloadOnCellularAllowed | Getter/Setter to allow disallow peer download. This will be applied if the network type is Cellular (i.e., 5G, 4G ... ) |
dnaDownloadOnWifiEthernetAllowed | Getter/Setter to allow disallow peer download. This will be applied if the network type is Wi-Fi or ethernet. |
dnaUploadAllowed | Getter/Setter to switch peer upload ON or OFF, regardless of the network type |
dnaUploadOnCellularAllowed | Getter/Setter to allow disallow peer upload. This will be applied if the network type is Cellular (i.e., 5G, 4G ... ) |
dnaUploadOnWifiEthernetAllowed | Getter/Setter to allow disallow peer upload. This will be applied if the network type is Wi-Fi or ethernet. |
id | Returns the ID of the Web SDK running in the page. It is automatically generated. |
stats.allContents (in Bytes) | Stats that describe the whole session (Stats are aggregated over successive contents that have been plaed in case of a playlist.) |
stats.allContents.cdnDownload (in Bytes) |
For all content in a playlist, total Bytes downloaded from the CDN over the session |
stats.allContents.dnaDownload (in Bytes) |
For all content in a playlist, total Bytes downloaded from the mesh network over the session |
stats.allContents.dnaUpload (in Bytes) | For all content in a playlist, total Bytes uploaded from the mesh network over the session |
stats.currentContent (in Bytes) | Stats that describe the current content being played |
stats.currentContent.cdnDownload (in Bytes) | For the current content being played, total Bytes downloaded from the CDN over the session |
stats.currentContent.dnaDownload (in Bytes) | For the current content being played, total Bytes downloaded from the mesh network over the session |
stats.currentContent.dnaUpload (in Bytes) | For the current content being played, total Bytes uploaded from the mesh network over the session |
realtime.dnaSources | Returns the current number of peers connected to the client |
transferStatus.effectiveDownloadAllowed | Return the effective state of download (allowed or disallowed). Depending on the Network type, it will be calculated as: dnaDownloadAllowed AND dnaDownloadOnWifiEthernetAllowed (if you are on Wi-Fi for instance). |
transferStatus.effectiveUploadAllowed | Return the effective state of upload (allowed or disallowed). Depending on your Network type**, it will be calculated as: dnaUploadOnAllowed AND dnaUploadOnCellularAllowed (if you are on 4G for instance). |
Explore CDN Mesh Delivery