Lumen help
Introduction
On top of the stats API exposed by the SDK, we created a view helper called LumenStatsView
to help you integrate and understand Mesh Delivery faster. The LumenStatsView
will inform you about the different states of the SDK lifecycle and Lumen metrics.
The view looks like the following:
Note: LumenStatsView
is NOT intended for production
Adding a LumenStatsView
is really simple, but varies slightly if you chose to integrate with our Kotlin SDK, Java SDK, or our ExoPlayer Plugin. Choose the correct code below corresponding to your integration of choice.
First, you will need to add the following dependency to the build.gradle.
Add the utils dependency to your module’s build.gradle
by changing the name of the artifact. Append -utils
to the artifact name to pull the utils package as well.
Add the LumenStatsView
to your layout, ideally over the biggest surface. You can do this freely as it won’t intercept user interaction.
Finally, you will need to retrieve your view by your preferred method and link it with a LumenDeliveryClient
or LumenDeliveryClientPlugin
instance
What do the stats tell you?
The LumenStatsView
shows information regarding the traffic, the peer connections, cache size, buffer size, and video content related information. The details of all parameters shown are listed in the table below.
Parameter | Description | Unit |
CDN | Total amount of bytes downloaded from the CDN. |
MB |
Mesh |
Total amount of bytes downloaded from the Mesh network. |
MB |
Upload |
Total amount of Bytes uploaded to the Mesh network. |
MB |
Offload |
Global efficiency of Mesh delivery, the ratio of CDN vs Mesh. |
|
Peers |
Number of peers with whom the Mesh Delivery is connected.
|
|
PeerID |
Unique ID of the viewer used to identify each peer in the Mesh network. |
|
Content ID |
ID of the content currently being played back. Either the custom one defined with the Content Id string or the default one based on the content URL. |
|
P2P cache size |
Current amount of the video data stored in the cache by the Mesh SDK / Total amount of data the Mesh SDK will ever take. |
MB |
Buffer health / Buffer target |
Current amount of video data in the player buffer / Buffer amount the player will try to reach (dynamically changed by the Mesh SDK). |
Seconds |
Latency | Delay between current position and the most recent video segment available in the playlist. | seconds |
Track |
Video track bitrate (corresponding video track ID for the Mesh SDK) |
Kbps |
Bandwidth | The estimated bandwidth of the CDN |
Mbps |
Explore CDN Mesh Delivery