Release 0.11.0

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup node and npm registry
         uses: actions/setup-node@v3
@@ -44,7 +44,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup node and npm registry
         uses: actions/setup-node@v3
@@ -79,7 +79,7 @@ jobs:
     runs-on: macOS-12
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup node and npm registry
         uses: actions/setup-node@v3
@@ -116,10 +116,11 @@ jobs:
         run: |
           bundle exec pod repo remove trunk
           bundle exec pod repo add bitmovin https://github.com/bitmovin/cocoapod-specs.git || bundle exec pod repo update bitmovin
-          NO_FLIPPER=1 bundle exec pod install --repo-update
+          bundle exec pod install --repo-update
         working-directory: example/ios
         env:
           CP_HOME_DIR: ${{ github.workspace }}/.cocoapods-cache
+          NO_FLIPPER: 1
 
       - name: Save Pods cache
         if: steps.pods-cache-restore.outputs.cache-hit != 'true'
@@ -141,7 +142,7 @@ jobs:
     runs-on: macOS-12
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup node and npm registry
         uses: actions/setup-node@v3

.github/workflows/create-sdk-update-pr.yml

@@ -23,7 +23,7 @@ jobs:
       GH_TOKEN: ${{ secrets.GH_TOKEN }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup git user
         run: |

.github/workflows/finish-release-train.yml

@@ -0,0 +1,89 @@
+name: Finish Release Train
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+env:
+  LC_ALL: en_US.UTF-8
+  LANG: en_US.UTF-8
+concurrency:
+  group: finish-release-train-${{ github.ref_name }}
+  cancel-in-progress: true
+jobs:
+  create_pr:
+    if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'release/v')
+    runs-on: ubuntu-latest
+    outputs:
+      version_number: ${{ steps.version_number.outputs.version_number }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Detect version number
+        id: version_number
+        run: |
+          version_number="$(npm view bitmovin-player-react-native version)"
+          echo "Detected version number: $version_number"
+          echo "version_number=$version_number" >> $GITHUB_OUTPUT
+
+      - name: Create PR
+        run: |
+          gh pr create \
+          --base "development" \
+          --head "main" \
+          --title "Finish release ${{ steps.version_number.outputs.version_number }}" \
+          --body "Finish release ${{ steps.version_number.outputs.version_number }}"
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+  publish_release:
+    needs: [create_pr]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Git User
+        run: |
+          # setup git
+          git config --global user.name "Bitmovin Release Automation"
+          git config --global user.email "[email protected]"
+
+      - name: Add tag
+        run: |
+          git tag v${{ needs.create_pr.outputs.version_number }}
+
+      - name: Git push
+        run: |
+          git push origin v${{ needs.create_pr.outputs.version_number }}
+
+      - name: Setup node and npm registry
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org/'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Build TypeScript files
+        run: yarn build
+
+      - name: Publish npm package
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Extract changelog
+        id: changelog
+        uses: ffurrer2/extract-release-notes@v1
+
+      - name: Create GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          body: ${{ steps.changelog.outputs.release_notes }}

.github/workflows/start-release-train.yml

@@ -0,0 +1,78 @@
+name: Start Release Train
+on:
+  workflow_dispatch:
+    inputs:
+      version_number:
+        description: 'Next version number of the release'
+        type: string
+        required: true
+      release_date:
+        description: 'Date of the final release. Will be used for CHANGELOG.md (format YYYY-MM-DD, e.g. 2023-02-27)'
+        type: string
+        required: true
+env:
+  LC_ALL: en_US.UTF-8
+  LANG: en_US.UTF-8
+concurrency:
+  group: start-release-train-${{ inputs.version_number }}
+  cancel-in-progress: true
+jobs:
+  create_release_pr:
+    name: Create release branch and bump version
+    runs-on: macos-latest
+    outputs:
+      branch_name: ${{ steps.branching.outputs.branch_name }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Git User
+        run: |
+          # setup git
+          git config --global user.name "Bitmovin Release Automation"
+          git config --global user.email "[email protected]"
+
+      - name: Setup node and npm registry
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org/'
+          cache: 'yarn'
+
+      - name: Set Release Branch name
+        id: branching
+        run: |
+          branch_name="release/v${{ inputs.version_number }}"
+          echo "branch_name=$branch_name" >> $GITHUB_OUTPUT
+
+      - name: Create Release Branch
+        run: |
+          # Delete the release branch if already exists, useful in case we need to re-run this workflow
+          git push origin --delete ${{ steps.branching.outputs.branch_name }} || true
+          git checkout -b ${{ steps.branching.outputs.branch_name }}
+
+      - name: Bump changelog version
+        run: |
+          sed -i'.bak' "s/\[Unreleased\]/\[${{ inputs.version_number }}\] \(${{ inputs.release_date }}\)/g" CHANGELOG.md
+
+      - name: Bump package.json version
+        run: |
+          npm version ${{ inputs.version_number }} --no-git-tag-version
+
+      - name: Update Podfile.lock
+        run: |
+          yarn bootstrap
+
+      - name: Commit changelog version bump
+        run: |
+          git add CHANGELOG.md package.json example/ios/Podfile.lock
+          git commit -m "chore: prepare release ${{ inputs.version_number }}"
+          git push origin ${{ steps.branching.outputs.branch_name }}
+
+      - name: Create PR
+        run: |
+          gh pr create \
+          --base "main" \
+          --title "Release ${{ inputs.version_number }}" \
+          --body "Release ${{ inputs.version_number }}"
+        env:
+          GH_TOKEN: ${{ github.token }}

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.11.0] (2023-09-11)
+
+### Added
+
+- `Player.getAudioTrack` and `Player.getSubtitleTrack` APIs to get currently selected audio and subtitle tracks
+- `SourceConfig.description` property to allow setting a description for the source
+- `Player.getThumbnail` and `Source.getThumbnail` APIs to get thumbnail images
+
+### Changed
+
+- Update Bitmovin's native Android SDK version to `3.43.0`
+
 ## [0.10.0] (2023-09-04)
 
 ### Added

android/build.gradle

@@ -53,7 +53,7 @@ dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlinVersion"
     implementation 'com.google.ads.interactivemedia.v3:interactivemedia:3.29.0'
     implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
-    implementation 'com.bitmovin.player:player:3.42.0'
+    implementation 'com.bitmovin.player:player:3.43.0'
     //noinspection GradleDynamicVersion
     implementation 'com.facebook.react:react-native:+' // From node_modules
 }

android/src/main/java/com/bitmovin/player/reactnative/PlayerModule.kt

@@ -291,6 +291,18 @@ class PlayerModule(private val context: ReactApplicationContext) : ReactContextB
         }
     }
 
+    /**
+     * Resolve `nativeId`'s currently selected audio track.
+     * @param nativeId Target player Id.
+     * @param promise JS promise object.
+     */
+    @ReactMethod
+    fun getAudioTrack(nativeId: NativeId, promise: Promise) {
+        uiManager()?.addUIBlock {
+            promise.resolve(JsonConverter.fromAudioTrack(players[nativeId]?.source?.selectedAudioTrack))
+        }
+    }
+
     /**
      * Resolve `nativeId`'s player available audio tracks.
      * @param nativeId Target player Id.
@@ -323,6 +335,18 @@ class PlayerModule(private val context: ReactApplicationContext) : ReactContextB
         }
     }
 
+    /**
+     * Resolve `nativeId`'s currently selected subtitle track.
+     * @param nativeId Target player Id.
+     * @param promise JS promise object.
+     */
+    @ReactMethod
+    fun getSubtitleTrack(nativeId: NativeId, promise: Promise) {
+        uiManager()?.addUIBlock {
+            promise.resolve(JsonConverter.fromSubtitleTrack(players[nativeId]?.source?.selectedSubtitleTrack))
+        }
+    }
+
     /**
      * Resolve `nativeId`'s player available subtitle tracks.
      * @param nativeId Target player Id.
@@ -428,6 +452,18 @@ class PlayerModule(private val context: ReactApplicationContext) : ReactContextB
         }
     }
 
+    /**
+     * Returns the thumbnail image for the active `Source` at a certain time.
+     * @param nativeId Target player id.
+     * @param time Playback time for the thumbnail.
+     */
+    @ReactMethod
+    fun getThumbnail(nativeId: NativeId, time: Double, promise: Promise) {
+        uiManager()?.addUIBlock {
+            promise.resolve(JsonConverter.fromThumbnail(players[nativeId]?.source?.getThumbnail(time)))
+        }
+    }
+
     /**
      * Helper function that returns the initialized `UIManager` instance.
      */

android/src/main/java/com/bitmovin/player/reactnative/SourceModule.kt

@@ -140,7 +140,6 @@ class SourceModule(private val context: ReactApplicationContext) : ReactContextB
     /**
      * Set the metadata for a loaded `nativeId` source.
      * @param nativeId Source `nativeId`.
-     * @param promise: JS promise object.
      */
     @ReactMethod
     fun setMetadata(nativeId: NativeId, metadata: ReadableMap?) {
@@ -149,6 +148,18 @@ class SourceModule(private val context: ReactApplicationContext) : ReactContextB
         }
     }
 
+    /**
+     * Returns the thumbnail image for the `Source` at a certain time.
+     * @param nativeId Target player id.
+     * @param time Playback time for the thumbnail.
+     */
+    @ReactMethod
+    fun getThumbnail(nativeId: NativeId, time: Double, promise: Promise) {
+        uiManager()?.addUIBlock {
+            promise.resolve(JsonConverter.fromThumbnail(sources[nativeId]?.getThumbnail(time)))
+        }
+    }
+
     /**
      * Helper method that converts a React `ReadableMap` into a kotlin String -> String map.
      */