Skip to content

shared-powerup-oovvuu-video-block 1.0.0

Install from the command line:
Learn more about npm packages
$ npm install @arcxp/shared-powerup-oovvuu-video-block@1.0.0
Install via package.json:
"@arcxp/shared-powerup-oovvuu-video-block": "1.0.0"

About this version

Power Up Oovvuu Video

This package provides the full Power Up to:

  • authenticate with Oovvuu
  • find and select video(s) in Oovvuu Video
  • inject Oovvuu data into story ANS

Full integration steps are available in Arc XPs Oovvuu Power Up

Required environment variables

For this Power Up to work, you must provide the following:

 OOVVUU_CLIENTID: 'unique client ID, provided by Oovvuu',
 OOVVUU_SCRIPT_PATH: 'script to initiate login, provided by Oovvuu',

Oovvuu requires additional steps. Read the document linked above for further information.

Saved data

The data returned from the Power Up are in the following format:

{
  _id: String // unique ID in context of this story, set by Composer
  embed: {
    config: {
      displayTitle: String // title of the Video or Playlist, received from Oovvuu
      embedId: String // unique ID for Video or Playlist, received from Oovvuu
      playerScriptUrl: String // public script path to load Oovvuu embed, received from Oovvuu
      thumbnailImageUrl: String // path to thumbnail image at Oovvuu, to be used with Resizer, received from Oovvuu
    },
    id: String
    url: String // fixed value '/', set by Power Up
  },
  subtype: 'oovvuu-video', // unique ID as set in Composer Settings, set by Composer
  type: 'custom_embed' // fixed value, set by Composer
}

Only the embedId and playerScriptUrl are used in the matching oovvvuu-video-component, but all returned information (excluding the raw embed html) is included to allow for a custom integration, while still being able to use this package.

How to use

Add this Component as a dependency in package.json with the newest version. Then create a folder in /components/components/powerups called oovvuu-video. Inside create a new file called powerup.jsx to create a powerup outputType version for this Block. Then import and use the Component as displayed in the following example:

import React from 'react';
import OovvuuPower UpComponent from '@arcxp/shared-powerup-oovvuu-video-block';

export default (props) => <OovvuuPower UpComponent {...props} />;

License

License: MIT

Details


Assets

  • shared-powerup-oovvuu-video-block-1.0.0.tgz

Download activity

  • Total downloads 8
  • Last 30 days 0
  • Last week 0
  • Today 0