react-native-tpstreams

A React Native video player component for TPStreams with offline download support.

Installation

npm install react-native-tpstreams

Quick Start

1. Initialize TPStreams

import { TPStreams } from "react-native-tpstreams";

// Initialize once at your app's entry point
TPStreams.initialize('YOUR_ORGANIZATION_ID');

2. Add Player Component

import { TPStreamsPlayerView } from "react-native-tpstreams";

<TPStreamsPlayerView 
  videoId="YOUR_VIDEO_ID"
  accessToken="YOUR_ACCESS_TOKEN"
  style={{ width: '100%', height: 300 }}
/>

API Reference

Player Props

Prop	Type	Required	Description
videoId	string	Yes	Video ID to play
accessToken	string	Yes	Access token for the video
shouldAutoPlay	boolean	No	Auto-play on load (default: true)
startAt	number	No	Start position in seconds (default: 0)
enableDownload	boolean	No	Enable download functionality (default: false)
offlineLicenseExpireTime	number	No	License expiration in seconds (default: 15 days)
showDefaultCaptions	boolean	No	Show captions if available (default: false)
startInFullscreen	boolean	No	Start the player in fullscreen mode (default: false)
downloadMetadata	object	No	Custom metadata for downloads

Player Methods

import { useRef } from 'react';
import type { TPStreamsPlayerRef } from 'react-native-tpstreams';

const playerRef = useRef<TPStreamsPlayerRef>(null);

// Control playback
playerRef.current?.play();
playerRef.current?.pause();
playerRef.current?.seekTo(30000); // 30 seconds
playerRef.current?.setPlaybackSpeed(2.0);

// Get player state (inside an async function)
const getPlayerState = async () => {
  const position = await playerRef.current?.getCurrentPosition();
  const duration = await playerRef.current?.getDuration();
  const isPlaying = await playerRef.current?.isPlaying();
  const speed = await playerRef.current?.getPlaybackSpeed();
  
  return { position, duration, isPlaying, speed };
};

Player Events

<TPStreamsPlayerView
  onPlayerStateChanged={(state) => console.log('State:', state)}
  onIsPlayingChanged={(isPlaying) => console.log('Playing:', isPlaying)}
  onPlaybackSpeedChanged={(speed) => console.log('Speed:', speed)}
  onIsLoadingChanged={(isLoading) => console.log('Loading:', isLoading)}
  onError={(error) => console.error('Error:', error)}
  onAccessTokenExpired={(videoId, callback) => {
    // Fetch new token and call callback(newToken)
  }}
/>

Downloads

Download Management

import {
  pauseDownload,
  resumeDownload,
  removeDownload,
  getAllDownloads,
  isDownloaded,
  isDownloading,
  getDownloadStatus,
} from 'react-native-tpstreams';

// Check download status
const checkDownloadStatus = async (videoId) => {
  const downloaded = await isDownloaded(videoId);
  const downloading = await isDownloading(videoId);
  const status = await getDownloadStatus(videoId);
  
  return { downloaded, downloading, status };
};

// Manage downloads
const manageDownload = async (videoId, action) => {
  switch (action) {
    case 'pause':
      await pauseDownload(videoId);
      break;
    case 'resume':
      await resumeDownload(videoId);
      break;
    case 'remove':
      await removeDownload(videoId);
      break;
  }
};

// Get all downloads
const getAllDownloadedVideos = async () => {
  const downloads = await getAllDownloads();
  return downloads;
};

Real-time Progress

import {
  addDownloadProgressListener,
  removeDownloadProgressListener,
  onDownloadProgressChanged,
} from 'react-native-tpstreams';

// Start listening
async function startListening() {
  await addDownloadProgressListener();
}

// Listen for updates
const subscription = onDownloadProgressChanged((downloads) => {
  console.log('Download progress:', downloads);
});

// Cleanup
async function cleanup() {
  subscription.remove();
  await removeDownloadProgressListener();
}

Resources

• Sample App: Complete working example
• Documentation: TPStreams Developer Docs

License

MIT