Skip to content

Commit 1046955

Browse files
authored
Merge pull request #114 from arcataroger/docs/video-player-analytics
Added readme section on video analytics with Mux Data (React)
2 parents e8a5477 + 26fbead commit 1046955

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/video-player.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [Props](#props)
1010
- [Advanced usage: the `useVideoPlayer` hook](#advanced-usage-the-usevideoplayer-hook)
1111
- [Example](#example-1)
12+
- [Opt-in Viewer Analytics](#opt-in-viewer-analytics)
1213

1314
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1415

@@ -146,3 +147,11 @@ const props = useVideoPlayer({ data });
146147
147148
<MuxPlayer {...props} />
148149
```
150+
151+
## Opt-in Viewer Analytics
152+
153+
This `<VideoPlayer/>` component can OPTIONALLY collect clientside [playback and engagement metrics](https://www.mux.com/data#TechSpecs) such as playback percentages, user agents, and geography.
154+
155+
These analytics are **disabled** by default. To enable them, you must opt in to [Mux Data](https://www.mux.com/data) integration by creating a Mux Data account (free) and providing its `envKey` to the component.
156+
157+
For details and setup instructions, please see our documentation on **[Streaming Video Analytics with Mux Data](https://www.datocms.com/docs/streaming-videos/streaming-video-analytics-with-mux-data)**.

0 commit comments

Comments
 (0)