str-native-video-player 1.0.0

package/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "StrNativeVideoPlayer",
+    platforms: [.iOS(.v14)],
+    products: [
+        .library(
+            name: "StrNativeVideoPlayer",
+            targets: ["STRTVPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0")
+    ],
+    targets: [
+        .target(
+            name: "STRTVPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/STRTVPlugin"),
+        .testTarget(
+            name: "STRTVPluginTests",
+            dependencies: ["STRTVPlugin"],
+            path: "ios/Tests/STRTVPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,232 @@
+# str-native-video-player
+
+Allows for native video player functionality, fetching and storing videos from a CDN, switching between the playback of these videos with cross fade and preloading functionality
+
+## Install
+
+```bash
+npm install str-native-video-player
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`echo(...)`](#echo)
+* [`play_video(...)`](#play_video)
+* [`pause_video(...)`](#pause_video)
+* [`resume_video(...)`](#resume_video)
+* [`stop_video(...)`](#stop_video)
+* [`seek_video(...)`](#seek_video)
+* [`is_video_playing()`](#is_video_playing)
+* [`preload_video(...)`](#preload_video)
+* [`list_cached_videos()`](#list_cached_videos)
+* [`evict_videos(...)`](#evict_videos)
+* [`get_storage_stats()`](#get_storage_stats)
+* [`set_max_cache_size(...)`](#set_max_cache_size)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### echo(...)
+
+```typescript
+echo(options: { value: string; }) => Promise<{ value: string; }>
+```
+
+Simple echo for testing connectivity.
+
+| Param         | Type                            |
+| ------------- | ------------------------------- |
+| **`options`** | <code>{ value: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>
+
+--------------------
+
+
+### play_video(...)
+
+```typescript
+play_video(options: { uuid: string; url?: string; loop?: boolean; video_player?: any; }) => Promise<{ success: boolean; }>
+```
+
+Core video playback method.
+
+Plays a video identified by `uuid`. If it is not cached locally, it will stream from `url`
+while simultaneously caching it for future playback.
+
+| Param         | Type                                                                             |
+| ------------- | -------------------------------------------------------------------------------- |
+| **`options`** | <code>{ uuid: string; url?: string; loop?: boolean; video_player?: any; }</code> |
+
+**Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
+
+--------------------
+
+
+### pause_video(...)
+
+```typescript
+pause_video(options: { video_player?: any; }) => Promise<{ success: boolean; }>
+```
+
+Pauses the currently playing video.
+
+| Param         | Type                                 |
+| ------------- | ------------------------------------ |
+| **`options`** | <code>{ video_player?: any; }</code> |
+
+**Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
+
+--------------------
+
+
+### resume_video(...)
+
+```typescript
+resume_video(options: { video_player?: any; }) => Promise<{ success: boolean; }>
+```
+
+Resumes the currently playing video.
+
+| Param         | Type                                 |
+| ------------- | ------------------------------------ |
+| **`options`** | <code>{ video_player?: any; }</code> |
+
+**Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
+
+--------------------
+
+
+### stop_video(...)
+
+```typescript
+stop_video(options: { video_player?: any; }) => Promise<{ success: boolean; }>
+```
+
+Stops the currently playing video.
+
+| Param         | Type                                 |
+| ------------- | ------------------------------------ |
+| **`options`** | <code>{ video_player?: any; }</code> |
+
+**Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
+
+--------------------
+
+
+### seek_video(...)
+
+```typescript
+seek_video(options: { position_ms: number; video_player?: any; }) => Promise<{ success: boolean; }>
+```
+
+Seeks the currently playing video to a specific position in milliseconds.
+
+| Param         | Type                                                      |
+| ------------- | --------------------------------------------------------- |
+| **`options`** | <code>{ position_ms: number; video_player?: any; }</code> |
+
+**Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
+
+--------------------
+
+
+### is_video_playing()
+
+```typescript
+is_video_playing() => Promise<{ playing: boolean; }>
+```
+
+Returns whether a video is currently playing.
+
+**Returns:** <code>Promise&lt;{ playing: boolean; }&gt;</code>
+
+--------------------
+
+
+### preload_video(...)
+
+```typescript
+preload_video(options: { uuid: string; url: string; }) => Promise<{ success: boolean; }>
+```
+
+Preload a video into local storage (without playing).
+Will fetch and cache the video to speed up future playback.
+
+Optional: should respect max cache size and apply LRU eviction.
+
+| Param         | Type                                        |
+| ------------- | ------------------------------------------- |
+| **`options`** | <code>{ uuid: string; url: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
+
+--------------------
+
+
+### list_cached_videos()
+
+```typescript
+list_cached_videos() => Promise<{ value: { uuid: string; url: string; size_bytes: number; last_accessed: number; }[]; }>
+```
+
+List all currently cached videos with metadata.
+
+**Returns:** <code>Promise&lt;{ value: { uuid: string; url: string; size_bytes: number; last_accessed: number; }[]; }&gt;</code>
+
+--------------------
+
+
+### evict_videos(...)
+
+```typescript
+evict_videos(options: { uuids: string[]; }) => Promise<{ success: boolean; }>
+```
+
+Evict specific videos from cache manually.
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ uuids: string[]; }</code> |
+
+**Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
+
+--------------------
+
+
+### get_storage_stats()
+
+```typescript
+get_storage_stats() => Promise<{ available_bytes: number; total_bytes: number; used_bytes_videos: number; used_bytes_app: number; }>
+```
+
+Get cache/storage statistics.
+
+**Returns:** <code>Promise&lt;{ available_bytes: number; total_bytes: number; used_bytes_videos: number; used_bytes_app: number; }&gt;</code>
+
+--------------------
+
+
+### set_max_cache_size(...)
+
+```typescript
+set_max_cache_size(options: { max_bytes: number; }) => Promise<{ success: boolean; }>
+```
+
+Set maximum cache size for videos.
+When exceeded, LRU eviction should occur automatically.
+
+| Param         | Type                                |
+| ------------- | ----------------------------------- |
+| **`options`** | <code>{ max_bytes: number; }</code> |
+
+**Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
+
+--------------------
+
+</docgen-api>

package/StrNativeVideoPlayer.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'StrNativeVideoPlayer'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '14.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/android/build.gradle

@@ -0,0 +1,59 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.2'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "com.strtv.app"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation 'androidx.media3:media3-exoplayer:1.8.0'
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>