4.0.1 • Published 2 months ago

@snowplow/browser-plugin-media-tracking v4.0.1

Weekly downloads
-
License
BSD-3-Clause
Repository
github
Last release
2 months ago

Snowplow Media Tracking

npm version License

Browser Plugin to be used with @snowplow/browser-tracker.

Adds HTML5 Video and Audio tracking events to your Snowplow tracking.

Maintainer quick start

Part of the Snowplow JavaScript Tracker monorepo.
Build with Node.js (18 - 20) and Rush.

Setup repository

npm install -g @microsoft/rush 
git clone https://github.com/snowplow/snowplow-javascript-tracker.git
rush update

Package Installation

With npm:

npm install @snowplow/browser-plugin-media-tracking

Usage

Initialize your tracker with the MediaTrackingPlugin:

import { newTracker } from '@snowplow/browser-tracker';
import { MediaTrackingPlugin } from 'snowplow-browser-media-tracker';

newTracker('sp2', '{{collector}}', { plugins: [ MediaTrackingPlugin() ] }); // Also stores reference at module level

Then, use the enableMediaTracking function described below to produce events from your HTML5 Video/Audio element(s).

enableMediaTracking({ id, options?: { label?, captureEvents?, boundaries?, volumeChangeTrackingInterval? } })
ParameterTypeDefaultDescriptionRequired
idstring-The HTML id attribute of the media elementYes
options.labelstring-An identifiable custom label sent with the eventNo
options.captureEventsstring[]['DefaultEvents']The name(s) of the events to captureNo
options.boundariesnumber[][10, 25, 50, 75]The progress percentages to fire an event at (if enabled)No
options.volumeChangeTrackingIntervalnumber250The rate at which volume events can be sentNo

Example Usage

  ...
  <video id="my-video" src="my-video.mp4">
  ...
import { enableMediaTracking } from '@snowplow/browser-plugin-media-tracking'

enableMediaTracking({
  id: 'my-video',
  options: {
    label: "My Custom Video Label",
    captureEvents: ["DefaultEvents"],
    boundaries: [10, 25, 50, 75],
    volumeChangeTrackingInterval: 250,
  }
})

For a full list of trackable events, head over to the docs page

Copyright and license

Licensed and distributed under the BSD 3-Clause License (An OSI Approved License).

Copyright (c) 2022 Snowplow Analytics Ltd.

All rights reserved.

4.0.1

2 months ago

4.0.0

2 months ago

3.24.6

2 months ago

3.24.5

2 months ago

4.0.0-beta.4

2 months ago

4.0.0-beta.3

2 months ago

4.0.0-beta.2

2 months ago

3.24.3-dev.0

3 months ago

4.0.0-beta.1

3 months ago

3.24.4

3 months ago

3.24.0

6 months ago

3.23.1

7 months ago

3.24.2

5 months ago

3.24.1

6 months ago

3.24.3

4 months ago

3.23.0

9 months ago

3.22.1

9 months ago

3.22.0

10 months ago

3.21.0

11 months ago

3.20.0

11 months ago

3.19.0

1 year ago

3.15.0

1 year ago

3.14.0

1 year ago

3.13.1

1 year ago

3.17.0

1 year ago

3.16.0

1 year ago

3.18.0

1 year ago

3.13.2-dev.0

1 year ago

3.11.0

2 years ago

3.10.1

2 years ago

3.10.0

2 years ago

3.13.0

2 years ago

3.12.1

2 years ago

3.12.0

2 years ago

3.13.1-dev.0

2 years ago

3.9.0

2 years ago

3.8.0

2 years ago

3.9.0-beta.1

2 years ago

3.7.0

2 years ago

3.6.0

2 years ago

3.5.0

3 years ago

3.4.0

3 years ago

3.3.1

3 years ago

3.3.0

3 years ago

3.2.3

3 years ago

3.2.2

3 years ago

3.2.1

3 years ago

3.2.0

3 years ago