Skip to main content

Overview

The SourceSync SDK is a powerful toolkit for creating interactive and engaging video experiences. It allows developers to easily integrate dynamic content, overlays, and user interactions into their video applications.

Key Features​

  • Interactive Overlays: Add clickable elements, forms, and other interactive components on top of your videos.
  • Time-Synchronized Content: Trigger content or actions at specific points in your video timeline.
  • Custom Event Handling: Respond to user interactions and video events with custom logic.
  • Cross-Platform Compatibility: Works seamlessly across web, mobile, and smart TV platforms.
  • Analytics Integration: Track user engagement and interaction with built-in analytics tools.

SDK Structure​

The SourceSync SDK is composed of three main libraries:

  1. Main SDK: Handles core functionality, initialization, and configuration.
  2. Moment Library: Manages time-based events and content synchronization.
  3. Render Library: Responsible for creating and managing interactive overlays.

Getting Started​

To begin using the SourceSync SDK, you'll need to:

  1. Sign up for a SourceSync account at sourcesync.io.
  2. Obtain your API key from the SourceSync dashboard.
  3. Install the SDK in your project: 
    npm install sourcesync-sdk
  4. Initialize the SDK in your application: 
    import { initializeApp } from 'sourcesync-sdk/app';

    const app = await initializeApp({
      appKey: 'YOUR_API_KEY',
      env: 'prod' // or 'dev' for development
    });

Key Concepts​

  • App Instance: The core object that represents your SourceSync integration.
  • Moments: Time-based events or content synchronized with your video.
  • Activations: Interactive elements or overlays that appear during video playback.
  • Renderers: Components responsible for displaying activations and handling user interactions.

Best Practices​

  1. Always initialize the SDK before using any of its features.
  2. Use environment variables to store your API key securely.
  3. Implement error handling for SDK operations.
  4. Test your integrations thoroughly in both development and production environments.

Next Steps​

Explore the individual library documentation for more detailed information: