Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@ndxlabs/ndx-js

ndxlabs15AGPL-3.0-or-later2.3.0TypeScript support: included

NDX connects audiences with information in movies and television.

video, advertising, ott, firetv

readme



NPM Version GitHub top language Bundlephobia
Dependencies GitHub License


NDX is the industry's new standard for connecting information to movies and television. NDX improves the TV viewing experience by connecting audiences with more information about the actors and locations they see on screen.

Installation

npm install @ndxlabs/ndx-js

Usage

Javascript


<div class="ndx-embed"></div>

<script src="https://unpkg.com/@ndxlabs/ndx-js"></script>
<script>

  ndx.configure({
    apiKey: 'ab3rGRg4iwC5Qy...'
  });

  const tech = ndx.Tech('.ndx-embed', '1234567...', {
    list: {
      orientation: ndx.HORIZONTAL,
      style: {
        position: 'absolute',
        bottom: '2em',
        left: '0'
      }
    }
  });

  tech.list.show().updateTime(5);

</script>

React


import React from 'react';
import { withRouter } from 'react-router';
import { NDX, Tech } from '@ndxlabs/ndx-js';

import Controls from '../../components/Controls';
import Player from '../../components/Player';

function Watch({ match, store }) {
  const { videoId } = match.params;
  const { playing, currentTime } = store.getState().player;

  return (
    <div className="watch-page">
      <NDX apiKey={process.env.REACT_APP_NDX_API_KEY} />
      <Player>
        <Tech
          videoId={videoId}
          show={!playing}
          currentTime={currentTime}
        />
        <Controls />
      </Player>
    </div>
  );
});

export default withRouter(Watch);