@amazon-devices/kepler-player-server 2.2.3

package/dist/turbo-modules/PlayerServerHandler.d.ts

@@ -0,0 +1,374 @@
+import { IPlayerSessionId, IPlayerSessionLoadParams, IPlayerSessionMediaInfo, IViewHandle, ITrackType, IUnloadSyncStatus } from './PlayerServerDataTypes/PlayerServerDataTypes';
+/**
+ * An interface for a handler that provides the service logic of the PlayerServer.
+ */
+export interface IPlayerServerHandler {
+    /**
+     * Handles a request to load content by URL. This call is received when apps call
+     * `IPlayerClient.load` from interactive component.
+     *
+     * Apps must implement this function to initialize MediaPlayer instance with the fields
+     * values provided in `mediaInfo` and `loadParams` for player session corresponding to `sessionId`.
+     *
+     * @param mediaInfo The object to describe the necessary URLs and HTTP headers to load media content.
+     * @param loadParams Params required to load content by URL.
+     * @param sessionId The session ID to target for
+     * loading content. If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleLoad: (mediaInfo: IPlayerSessionMediaInfo, loadParams?: IPlayerSessionLoadParams, sessionId?: IPlayerSessionId) => void;
+    /**
+     * Unloads content from a media session in response to `IPlayerClient.unload` calls from the interactive component.
+     *
+     * Applications must implement this function to release MediaPlayer and Media Source Extensions (MSE) resources
+     * for the player session associated with the given `sessionId`.
+     *
+     * @param sessionId The session ID of the content to unload.
+     * If not provided, the PlayerServer determines how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleUnload: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * Unloads content from a media session in response to `IPlayerClient.unloadSync` calls from the interactive component.
+     *
+     * Applications must implement this function to release MediaPlayer and Media Source Extensions (MSE) resources
+     * for the player session associated with the given `sessionId` **synchronously**.
+     * For W3CMedia `MediaPlayer` instance, use `deinitializeSync` API.
+     *
+     * @param timeoutMsec Maximum allowed time (in milliseconds) for unloadSync API to execute.
+     *     Minimum value is 1000, maximum value is 5000.
+     * @param sessionId The session ID of the content to unload.
+     * If not provided, the PlayerServer determines how to handle the request.
+     *
+     * @returns The status of synchronous deinitialize of mediaplayer instance corresponding to `sessionId`.
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleUnloadSync?: (timeoutMsec: number, sessionId?: IPlayerSessionId) => IUnloadSyncStatus;
+    /**
+     * Handles a request to set the video view. This call is received when apps call
+     * `IPlayerClient.setVideoView` from interactive component.
+     *
+     * @param handle The identifier for the shared surface.
+     * @param sessionId The session ID to target for setting the video surface.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * Apps must implement this function to call `setSurfaceHandle` on
+     * VideoPlayer instance corresponding to `sessionId`.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleSetVideoView: (handle: IViewHandle, sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles a request to clear the text view. This call is received when apps call
+     * `IPlayerClient.clearVideoView` from interactive component.
+     *
+     * Apps must implement this function to call `clearSurfaceHandle` on
+     * VideoPlayer instance corresponding to `sessionId`.
+     *
+     * @param sessionId The session ID to target for clearing the text view.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleClearVideoView: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles a request to set the text view. This call is received when apps call
+     * `IPlayerClient.setTextView` from interactive component.
+     *
+     * Apps must implement this function to call `setCaptionViewHandle` on
+     * VideoPlayer instance corresponding to `sessionId`.
+     *
+     * @param handle The identifier for the shared surface.
+     * @param sessionId The session ID to target for setting the captions surface.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleSetTextView: (handle: IViewHandle, sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles a request to clear the text view. This call is received when apps call
+     * `IPlayerClient.clearTextView` from interactive component.
+     *
+     * Apps must implement this function to call `clearCaptionViewHandle` on
+     * VideoPlayer instance corresponding to `sessionId`.
+     *
+     * @param sessionId The session ID to target for clearing the captions surface.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleClearTextView: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles a request to resume or start playback. This call is received when apps call
+     * `IPlayerClient.play` from interactive component.
+     *
+     * Apps must implement this function to call `play` on {Video,Audio}Player instance corresponding to `sessionId`.
+     *
+     * @details If the application is already playing and the playback speed is not normal (not 1.0)
+     * this may return playback to normal speed.
+     * Receiving multiple play requests while already in playing state is not an error and should signal success.
+     * The media server should update the corresponding `IISessionStatus` to reflect the new playback status.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handlePlay: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles a request to pause playback. This call is received when apps call
+     * `IPlayerClient.pause` from interactive component.
+     *
+     * Apps must implement this function to call `pause` on {Video,Audio}Player instance corresponding to `sessionId`.
+     *
+     * @details Receiving multiple pause requests while already in pause state is not an error and should signal success.
+     * The media server should update the corresponding `IISessionStatus` to reflect the new playback status.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handlePause: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles a request to seek to seek to a given playback position. This call is received when apps call
+     * `IPlayerClient.seek` from interactive component.
+     *
+     * Apps must implement this function to change currentTime of {Video,Audio}Player
+     * instance corresponding to `sessionId`.
+     *
+     * @details The media server should update the corresponding `IISessionStatus` to reflect the new playback position.
+     *
+     * @param position The playback position to seek to, either relative to the
+     * current playback position (isRelative = true); or relative to the start of the media where 0
+     * represents the start of the media (isRelative = false).
+     * @param isRelative If the position provided is relative to the current playback
+     * position (isRelative = true) or an absolute position in the media (isRelative = false).
+     * Default value is false.
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleSeek: (position: number, isRelative?: boolean, sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles a request to mute playback. This call is received when apps call
+     * `IPlayerClient.setMute` from interactive component.
+     *
+     * Apps must implement this function to set `muted` on {Video,Audio}Player instance corresponding to `sessionId`.
+     *
+     * @details The media server should update the corresponding `IISessionStatus` to reflect the new playback status.
+     *
+     * @param isMuted If true, the media should be muted;
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleSetMute: (isMuted: boolean, sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles a request to set playback speed of media playback. This call is received when apps call
+     * `IPlayerClient.setPlaybackRate` from interactive component.
+     *
+     * Apps must implement this function to set `playbackRate` on {Video,Audio}Player instance corresponding to `sessionId`.
+     *
+     * @details The media sesssion should update its `IISessionStatus` to reflect the new playback status.
+     *
+     * @param playbackRate The playback speed to set, like 0.25, 0.5, 2.0 etc
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleSetPlaybackRate: (playbackRate: number, sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles a request to set volume of media playback. This call is received when apps call
+     * `IPlayerClient.setVolume` from interactive component.
+     *
+     * Apps must implement this function to set `volume` on {Video,Audio}Player instance corresponding to `sessionId`.
+     *
+     * @details The media sesssion should update its `IISessionStatus` to reflect the new playback status.
+     *
+     * @param volume The volume to set, in the range of 0.0 to 1.0.
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleSetVolume: (volume: number, sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles a request to set the active track of media playback. This call is received when apps call
+     * `IPlayerClient.setActiveTrack` from interactive component.
+     *
+     * Apps must implement this function to set audio, video or text track by ID on MSE player instance.
+     *
+     * @details The media sesssion should update its `IISessionStatus` to reflect the new playback status.
+     *
+     * @param trackType The type of the track to set as active.
+     * @param trackId The track ID of the track to set as active.
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleSetActiveTrack: (trackType: ITrackType, trackId: string, sessionId?: IPlayerSessionId) => void;
+    /**
+     * Handles request for interactive component to get the current playback position of media playback.
+     * This call is received when apps call `IPlayerClient.getCurrentPosition` from interactive component.
+     *
+     * Apps must implement this function to get `currentTime` from {Audio,Video} Player instance corresponding to `sessionId`
+     * and then apps must resolve promise with `number` indicating current playback position (in seconds).
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @returns The current playback position of media playback session
+     * corresponding to `sessionId`.
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleGetCurrentPosition: (sessionId?: IPlayerSessionId) => number;
+    /**
+     * Handles a request to receive a custom message from interactive component. Apps can use
+     * `message` object to perform custom operations.
+     * This call is received when apps call `IPlayerClient.sendMessage` from interactive component.
+     *
+     * Apps may implement this function to handle custom operations in service component.
+     *
+     * @param message The message to be handled. To be sent as JSON object.
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the PlayerServer decides how to handle the request.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleMessage: (message: any, sessionId?: IPlayerSessionId) => void;
+    /**
+     * This call is received when apps make at least one `IPlayerClient.registerBufferedRangesListener`
+     * call for sessionId from interactive component.
+     *
+     * Apps must start sending buffered ranges updates corresponding to sessionId
+     * by calling `IPlayerServer.updateBufferedRanges` API from service component.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the session to target is decided by the server.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleStartBufferedRangesUpdates: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * This call is received when apps unsubscribe all `IPlayerSessionBufferedRangesListener`
+     * instances for sessionId from interactive component.
+     *
+     * Apps must stop sending buffered ranges updates corresponding to sessionId
+     * from service component.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the session to target is decided by the server.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleStopBufferedRangesUpdates: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * This call is received when apps make at least one `IPlayerClient.registerStatusListener`
+     * call for sessionId from interactive component.
+     *
+     * Apps must start sending player session status updates corresponding to sessionId
+     * by calling `IPlayerServer.updateStatus` API from service component.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the session to target is decided by the server.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleStartStatusUpdates: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * This call is received when apps unsubscribe all `IPlayerSessionStatusListener`
+     * instances for sessionId from interactive component.
+     *
+     * Apps must stop sending player session status updates corresponding to sessionId
+     * from service compoenent.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the session to target is decided by the server.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleStopStatusUpdates: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * This call is received when apps make at least one `IPlayerClient.registerTrackListener`
+     * call for sessionId from interactive component.
+     *
+     * Apps must start sending player session track updates corresponding to sessionId by calling
+     * `IPlayerServer.addTrack` or `IPlayerServer.removeTrack` APIs from service component.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the session to target is decided by the server.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleStartTrackUpdates: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * This call is received when apps unsubscribe all `IPlayerSessionTrackListener`
+     * instances for sessionId from interactive component.
+     *
+     * Apps must stop sending player session track updates corresponding to sessionId
+     * from service component.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the session to target is decided by the server.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleStopTrackUpdates: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * This call is received when apps make at least one `IPlayerClient.registerMessageListener`
+     * call for sessionId from interactive component.
+     *
+     * Apps can start sending custom messages as JSON objects by calling
+     * `IPlayerServer.sendMessage` API corresponding to sessionId from service component.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the session to target is decided by the server.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleStartMessageUpdates: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * This call is received when apps unsubscribe all `IPlayerSessionTrackListener`
+     * instances for sessionId from interactive component. So, service component should not
+     * send any message corresponding to sessionId as there is no receiver of
+     * these messages available.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the session to target is decided by the server.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleStopMessageUpdates: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * This call is received when apps make at least one `IPlayerClient.registerErrorListener`
+     * call for sessionId from interactive component.
+     *
+     * Apps can start sending `IPlayerSessionError` as JSON objects by calling
+     * `IPlayerServer.sendError` API corresponding to sessionId from service component.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the session to target is decided by the server.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleStartErrorUpdates: (sessionId?: IPlayerSessionId) => void;
+    /**
+     * This call is received when apps unsubscribe all `IPlayerSessionErrorListener`
+     * instances for sessionId from interactive component. So, service component should not
+     * send any errors corresponding to sessionId as there is no receiver of
+     * these messages available.
+     *
+     * @param sessionId The session ID to target with the request.
+     * If not specified, the session to target is decided by the server.
+     *
+     * @throws {InvalidArgumentError} if the given sessionId does not exist.
+     */
+    handleStopErrorUpdates: (sessionId?: IPlayerSessionId) => void;
+}

package/dist/turbo-modules/PlayerServerHandler.js

@@ -0,0 +1 @@
+export {};

package/dist/turbo-modules/__mocks__/KeplerPlayerServerTurboModule.d.ts

@@ -0,0 +1,22 @@
+declare function identityFunction<T>(value: T): T;
+declare const _default: {
+    getConstants: () => {
+        const1: boolean;
+        const2: number;
+        const3: string;
+    };
+    voidFunc: () => {};
+    getBool: typeof identityFunction;
+    getNumber: typeof identityFunction;
+    getString: typeof identityFunction;
+    getArray: typeof identityFunction;
+    getArrayBuffer: typeof identityFunction;
+    getObject: typeof identityFunction;
+    getValue: typeof identityFunction;
+    getValueWithCallback: (callback: any) => void;
+    getValueWithPromise: (error: boolean) => Promise<string>;
+    getMajorVersion: () => number;
+    getMinorVersion: () => number;
+    getPatchVersion: () => number;
+};
+export default _default;

package/dist/turbo-modules/__mocks__/KeplerPlayerServerTurboModule.js

@@ -0,0 +1,32 @@
+function identityFunction(value) {
+    return value;
+}
+export default {
+    getConstants: () => ({
+        const1: true,
+        const2: 375,
+        const3: 'something',
+    }),
+    voidFunc: () => ({}),
+    getBool: identityFunction,
+    getNumber: identityFunction,
+    getString: identityFunction,
+    getArray: identityFunction,
+    getArrayBuffer: identityFunction,
+    getObject: identityFunction,
+    getValue: identityFunction,
+    getValueWithCallback: (callback) => {
+        callback('value from callback!');
+    },
+    getValueWithPromise: (error) => {
+        if (error) {
+            return Promise.reject('intentional promise rejection');
+        }
+        else {
+            return Promise.resolve('result!');
+        }
+    },
+    getMajorVersion: () => 1,
+    getMinorVersion: () => 0,
+    getPatchVersion: () => 0,
+};

package/kepler-compatibility.json

@@ -0,0 +1,14 @@
+{
+  "versions": {
+    "2.0.5": "/com.amazon.kepler.kepler_player_server_2@IKeplerPlayerServer_0",
+    "2.0.6": "/com.amazon.kepler.kepler_player_server_2@IKeplerPlayerServer_0",
+    "2.1.0": "/com.amazon.kepler.kepler_player_server_2@IKeplerPlayerServer_1",
+    "2.1.1": "/com.amazon.kepler.kepler_player_server_2@IKeplerPlayerServer_1",
+    "2.1.2": "/com.amazon.kepler.kepler_player_server_2@IKeplerPlayerServer_1",
+    "2.1.3": "/com.amazon.kepler.kepler_player_server_2@IKeplerPlayerServer_1",
+    "2.2.0": "/com.amazon.kepler.kepler_player_server_2@IKeplerPlayerServer_2",
+    "2.2.1": "/com.amazon.kepler.kepler_player_server_2@IKeplerPlayerServer_2",
+    "2.2.2": "/com.amazon.kepler.kepler_player_server_2@IKeplerPlayerServer_2",
+    "2.2.3": "/com.amazon.kepler.kepler_player_server_2@IKeplerPlayerServer_2"
+  }
+}

package/kepler-transformed-package-info.json

@@ -0,0 +1,3 @@
+{
+  "sourcePackageRef": "@amzn/kepler-player-server"
+}

package/package.json

@@ -0,0 +1 @@
+{"name": "@amazon-devices/kepler-player-server", "version": "2.2.3", "main": "dist/index.js", "types": "dist/index.d.ts", "files": ["dist", "react-native.config.js", "kepler-compatibility.json", "SystemModules", "SystemBundles", "kepler-transformed-package-info.json"], "scripts": {"clean": "rm -rf node_modules buildinfo.json dist bvm $(readlink -f build)", "docgen": "rm -rf docs && npx typedoc --logLevel Verbose --pretty false && zip server_docs.zip -r docs", "kepler-codegen": "keplerscript-turbomodule-api codegen src/turbo-modules/KeplerPlayerServerTurboModule.ts -o kepler/turbo-modules/ --new -s KeplerPlayerServerTurboModule && npm-run-all clean-codegen-backups", "clean-codegen-backups": "rm -rf kepler/turbo-modules/KeplerPlayerServerTurboModule.cpp.bak kepler/turbo-modules/KeplerPlayerServerTurboModule.h.bak", "test": "jest --colors", "lint": "eslint src test --ext .ts,.tsx", "lint:fix": "eslint src test --ext .ts,.tsx --fix", "build:js": "tsc -p tsconfig.json", "build": "npm-run-all build:js && [ -n \"$SKIP_TESTS\" ] || npm test", "build:debug": "npm-run-all build:js", "prepublishOnly": "KEPLER_NPM_COMMAND=npm-pretty-much react-native build-system-bundle-kepler"}, "dependencies": {"@amazon-devices/keplerscript-turbomodule-api": "^1.0.0"}, "devDependencies": {"@babel/runtime": "^7.7.7", "@react-native/eslint-config": "0.72.2", "@types/jest": "^28.0.0", "@typescript-eslint/eslint-plugin": "^5.30.0", "babel-jest": "^28.0.0", "eslint": "^8.12.0", "jest": "^28.0.0", "metro-react-native-babel-preset": "^0.76.5", "npm-run-all": "^4.1.5", "prettier": "^2.6.2", "ts-jest": "^28.0.0", "typescript": "4.8.4", "@amazon-devices/kepler-cli-platform": "^0", "@react-native-community/cli": "^11.2.0"}, "kepler": {"toolchain": "clang", "projectType": "turbomodule", "targets": ["tv"], "features": ["vega"]}, "license": "See license in LICENSE"}

package/react-native.config.js

@@ -0,0 +1,17 @@
+
+module.exports = {
+  dependency: {
+    platforms: {
+      kepler: {
+        autolink: {
+          KeplerPlayerServerTurboModule: {
+            "libraryName": "libkeplerscript-playerserver-lib-1.so",
+            "linkDynamic": true,
+            "components": [],
+            "turbomodules": ["KeplerPlayerServerTurboModule"]
+          }
+        },
+      },
+    },
+  },
+};