@theoplayer/react-native-analytics-adobe
TypeScript icon, indicating that this package has built-in type declarations

1.5.0 • Public • Published

THEOplayer React-Native Adobe Connector

An Adobe analytics connector for @theoplayer/react-native.

Installation

The @theoplayer/react-native package has a peer dependency on react-native-device-info, which has to be installed as well:

npm install \
  react-native-device-info \
  @theoplayer/react-native-analytics-adobe

Usage

Configuring the connector

Create the connector by providing the THEOplayer instance, the Media Collection API's end point, Visitor Experience Cloud Org ID, Analytics Report Suite ID and the Analytics Tracking Server URL.

import { useAdobe } from '@theoplayer/react-native-analytics-adobe';

const uri = "<Media Collection API's end point>";
const ecid = "<Visitor Experience Cloud Org ID>";
const sid = "<Report Suite ID>";
const trackingUrl = "<Tracking Server URL>";
const metadata = {}; // Optionally provide initial metadata
const userAgent = "<Custom User-Agent>"; // Optionally provide a custom user-agent header value.
const debug = true; // Optionally provide a debug flag for extra logging.

const App = () => {
  const [adobe, initAdobe] = useAdobe(uri, ecid, sid, trackingUrl, metadata, userAgent, debug);

  const onPlayerReady = (player: THEOplayer) => {
    // Initialize Adobe connector
    initAdobe(player);
  }

  return (<THEOplayerView config={playerConfig} onPlayerReady={onPlayerReady}/>);
}

The Adobe connector will dispatch player events to Adobe with standard metadata the player has access to, such as duration or whether it is a live or vod.

Passing metadata dynamically

The connector allows passing or updating the current asset's metadata at any time:

import { AdobeMetaData } from "./Types";

const onUpdateMetadata = () => {
  const metadata: AdobeMetaData = {
    "params": {
      "media.channelName": "channelName",
      "media.id": "mediaId"
    },
    "customMetadata": {
      "customTag1": "customValue1",
      "customTag2": "customValue2"
    }
  };
  adobe.current?.updateMetadata(metadata);
};

Package Sidebar

Install

npm i @theoplayer/react-native-analytics-adobe

Weekly Downloads

30

Version

1.5.0

License

SEE LICENSE AT https://www.theoplayer.com/terms

Unpacked Size

143 kB

Total Files

71

Last publish

Collaborators

  • theotechnologies-admin