Skip to content

Releases: Source-Digital/native-sdk

Release list

v0.0.1-alpha

v0.0.1-alpha Pre-release
Pre-release

Choose a tag to compare

View all tags
@onexdata onexdata released this 25 Nov 23:28
v0.0.1-alpha
f725ffd

SourceSync SDK 0.0.1 Release Notes

Overview

Initial release of the SourceSync Android SDK, providing synchronized overlay content capabilities for Android applications. The SDK enables dynamic content display over video content with precise timing control and multiple overlay positions.

Features

Core Functionality

  • Real-time video position monitoring (60fps polling)
  • Multiple overlay position support
  • Precise content timing windows
  • Dynamic content loading and caching
  • Automatic state management
  • Configuration validation using JSON Schema

Content Display

  • Preview and detail view modes
  • Smooth transitions between states
  • Multiple overlay positions (top, bottom, etc.)
  • Configurable opacity and padding
  • Background blur effects

Content Types

  • Text segments with rich formatting
  • Image segments with size/position control
  • Interactive buttons
  • Flexible layout containers (rows and columns)
  • Custom segment processor support

Layout System

  • Percentage-based sizing
  • Token-based spacing system
  • Flexible alignment options
  • Nested container support
  • Dynamic size calculations

Configuration

  • JSON-based configuration
  • Size token system
  • Default styling options
  • Custom settings support
  • API-driven configuration updates

Technical Details

Initialization

// Initialize SDK
SourceSync sourcesync = SourceSync.setup(context, "api-key");

// Load distribution
Distribution distribution = sourcesync.getDistribution("distribution-id");

// Create overlays
Map<String, View> overlays = sourcesync.createPositionedOverlays(
    distribution, 
    videoView, 
    "top", "bottom"
);

Key Components

  • SourceSync: Main SDK entry point
  • Distribution: Content distribution configuration
  • Activation: Individual content unit management
  • SegmentProcessor: Content rendering system

Performance Features

  • Content preloading
  • State caching
  • Efficient view recycling
  • Memory management optimizations

Requirements

  • Minimum SDK: Android 24 (Android 7.0)
  • Compile SDK: Android 34
  • Java 11
  • AndroidX compatibility

Dependencies

  • androidx.appcompat:appcompat:1.6.1
  • com.fasterxml.jackson.core:jackson-databind:2.14.2
  • com.networknt:json-schema-validator:1.0.72

Known Limitations

  • Maximum of one active activation per position
  • Content must be pre-loaded before playback
  • Equal start/end times in windows are invalid
  • Preview dimensions limited to one-third screen width

Best Practices

  1. Always validate distribution JSON against schema
  2. Monitor activation state changes via logs
  3. Handle back button events for detail mode
  4. Clear activations when video playback ends
  5. Maintain proper error handling

Future Considerations

  • Animation support enhancements
  • Additional position types
  • Configurable update intervals
  • Manual position control
  • Extended transition effects
  • Content preloading optimizations

Breaking Changes

  • Initial release, no breaking changes to document

Security Notes

  • API keys should be kept secure
  • HTTPS required for API communication
  • Local asset access restrictions apply

Documentation

Full SDK documentation available in README.md and inline code documentation.

Loading