@mux/mux-active-viewer-count

<mux-active-viewer-count/>

Introduction

<mux-active-viewer-count></mux-active-viewer-count> is a Mux-flavored HTML5 viewer count element.

This element shows the current number of viewers for the specified video.

Installation

If you're using npm or yarn, install that way:

Package manager

yarn add @mux/mux-active-viewer-count

or

npm i @mux/mux-active-viewer-count

Then, import the library into your application with either import or require:

import '@mux/mux-active-viewer-count';

or

require('@mux/mux-active-viewer-count');

CDN option

Alternatively, use the CDN hosted version of this package:

<script src="https://cdn.jsdelivr.net/npm/@mux/mux-active-viewer-count@0"></script>

If you are using ecmascript modules, you can also load the mux-active-viewer-count.mjs file with type=module:

<script type="module" src="https://cdn.jsdelivr.net/npm/@mux/mux-active-viewer-count@0/dist/mux-active-viewer-count.mjs"></script>

Usage

<mux-active-viewer-count> has two attributes. The first is called token, and it should be a signed JavaScript Web Token (JWT) for which you want the viewer count. (For more information on creating a JWT for a particular video, see https://docs.mux.com/guides/data/see-how-many-people-are-watching.

The second attribute is called poll-interval. It specifies the number of seconds that the component should wait between requests to get the viewer count. It defaults to 20 seconds, and should be no lower than 15 seconds.