@amazon-devices/kepler-player-server 2.2.3

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

@@ -0,0 +1,319 @@
+/**
+ * Defines a HTTP header. Apps can send the headers required for
+ * authenticating and fetching the URL as name-value pair.
+ *
+ * Apps can also use it to send other metadata associated with
+ * the media content as well.
+ */
+export interface IHttpHeader {
+    /**
+     * The name of the HTTP header.
+     */
+    name: string;
+    /**
+     * The value of the HTTP header.
+     */
+    value: string;
+}
+/**
+ * Defines a time range for buffered content in media playback.
+ *
+ * The service component creates an array of these ranges and sends them to
+ * the interactive component via `IPlayerServer.updateBufferedRanges`.
+ */
+export interface ITimeRange {
+    /**
+     * Start position (in seconds)
+     */
+    start: number;
+    /**
+     * End position (in seconds)
+     */
+    end: number;
+}
+/**
+ * Defines a media URL with optional HTTP headers.
+ */
+export interface IMediaLocator {
+    /**
+     * Media URL
+     */
+    url: string;
+    /**
+     * Optional. HTTP headers (authentication and extra data) for fetching media URL.
+     */
+    httpHeaders?: Array<IHttpHeader>;
+}
+/**
+ * Defines the type of text track and how it should be handled.
+ *
+ * Possible values:
+ * - "subtitles": Translation of dialog for non-native language speakers
+ * - "captions": Transcription of dialog and sound effects for accessibility
+ * - "metadata": Track used for scripting purposes
+ *
+ * @see https://html.spec.whatwg.org/multipage/media.html#text-track-kind
+ */
+export declare type ITextTrackKind = "subtitles" | "captions" | "metadata";
+/**
+ * Defines out-of-band (OOB) text track information.
+ */
+export interface IOobTextTrackInfo {
+    /**
+     * URL and headers for fetching text track data
+     */
+    textUrl: IMediaLocator;
+    /**
+     * Track type (subtitles/captions/metadata)
+     */
+    kind: ITextTrackKind;
+    /**
+     * Display name of the text track
+     */
+    label: string;
+    /**
+     * Language code of the text track
+     *
+     * @see https://html.spec.whatwg.org/multipage/media.html#dom-texttrack-language
+     */
+    language: string;
+    /**
+     * MIME type of the text track content
+     */
+    mimeType: string;
+}
+/**
+ * Represents URLs and HTTP headers required for fetching media content.
+ */
+export interface IPlayerSessionMediaInfo {
+    /**
+     * The URL needed to fetch the media content.
+     */
+    mediaUrl: IMediaLocator;
+    /**
+     * Optional. The Licence Acquisition (LA) URL needed to fetch the DRM license.
+     */
+    laUrl?: IMediaLocator;
+    /**
+     * Optional. The Out-of-band (OOB) metadata required to fetch the subtitles.
+     */
+    oobTextTrackInfo?: Array<IOobTextTrackInfo>;
+}
+/**
+ * An interface describes surface handle returned by KeplerVideoSurfaceView or KeplerCaptionsView.
+ */
+export interface IViewHandle {
+    /**
+     * String handle for KeplerVideoSurfaceView or KeplerCaptionsView.
+     */
+    handle: string;
+}
+/**
+ * Describes media playback position and timing information
+ */
+export interface IPlayerSessionPosition {
+    /**
+     * Optional. Identifier for the media session
+     */
+    sessionId?: IPlayerSessionId;
+    /**
+     * Current playback position at the time of `updatedAtTime`
+     * in seconds.
+     */
+    position: number;
+}
+/**
+ * An interface describes media session ID.
+ * `IPlayerSessionId` is useful in case there are multiple media playbacks and clients want to call the
+ * IPlayerClient or IPlayerServer APIs for specific media playback.
+ */
+export interface IPlayerSessionId {
+    /**
+     * Identifier for player session represented by a positive number.
+     */
+    id: number;
+}
+/**
+ * Represents the possible states of media playback.
+ * This must be set in `IPlayerSessionStatus` depending on the events received
+ * after registering event listeners.
+ *
+ * @see https://html.spec.whatwg.org/#event-handlers-on-elements,-document-objects,-and-window-objects
+ */
+export declare enum IPlayerSessionState {
+    /**
+     * Playback is temporarily stopped
+     */
+    PAUSED = "PAUSED",
+    /**
+     * Media content is actively playing
+     */
+    PLAYING = "PLAYING",
+    /**
+     * Media is loading into temporary storage
+     */
+    BUFFERING = "BUFFERING",
+    /**
+     * Playback position is being changed
+     */
+    SEEKING = "SEEKING",
+    /**
+     * Media playback has reached its conclusion
+     */
+    ENDED = "ENDED",
+    /**
+     * Playback has encountered an error
+     */
+    ERROR = "ERROR"
+}
+/**
+ * Represents the possible status values of synchronous unload of media playback.
+ * Associated with {@link @amazon-devices/kepler-player-client#IPlayerClient.unloadSync} API.
+ * These values are in sync with {@link @amazon-devices/react-native-w3cmedia#MediaPlayerDeInitStatus|W3CMedia MediaPlayerDeInitStatus}
+ */
+export declare enum IUnloadSyncStatus {
+    /**
+     * Media playback instance was unloaded successfully.
+     */
+    SUCCESS = "success",
+    /**
+     * Media playback instance unload timed out.
+     */
+    TIMEDOUT = "timedout",
+    /**
+     * Invalid request for media playback unload.
+     */
+    INVALID = "invalid"
+}
+/**
+ * Represents a subscription that can be used to subscribe to various things.
+ * like media playback position listener, media state changes etc.
+ */
+export interface ISubscription {
+    /**
+     * Removes the subscription. Used to de-register the listener.
+     * Call this before destroying the client component.
+     */
+    unsubscribe: () => void;
+}
+/**
+ * Represents the current status of media playback.
+ * Apps can use this status to update their UI components.
+ */
+export interface IPlayerSessionStatus {
+    /**
+     * Optional. Identifier for the player session
+     */
+    readonly sessionId?: IPlayerSessionId;
+    /**
+     * Current playback speed (e.g., 0.5, 1.0, 2.0)
+     */
+    readonly playbackRate: number;
+    /**
+     * Current state of media playback
+     */
+    readonly playbackState: IPlayerSessionState;
+    /**
+     * Indicates if audio is muted
+     */
+    readonly isMuted: boolean;
+    /**
+     * Current volume level (range: 0.0 to 1.0)
+     */
+    readonly volume: number;
+    /**
+     * Indicates if seeking is allowed
+     */
+    readonly seekable: boolean;
+    /**
+     * Optional. Total duration of the media content
+     */
+    readonly duration?: number;
+}
+/**
+ * Defines parameters for loading media content by URL
+ */
+export interface IPlayerSessionLoadParams {
+    /**
+     * Initial playback position (in seconds)
+     *
+     * Specified relative to the start of the media, where 0 represents the beginning
+     */
+    startPosition: number;
+    /**
+     * Indicates whether playback should start automatically after content is loaded
+     */
+    autoPlay: boolean;
+}
+/**
+ * Defines the available types of media tracks:
+ *
+ * - AUDIO: Audio track containing sound content
+ * - VIDEO: Video track containing visual content
+ * - TEXT: Text track containing subtitles, captions, or metadata
+ */
+export declare type ITrackType = "AUDIO" | "VIDEO" | "TEXT";
+/**
+ * Represents the display mode of the text track.
+ *
+ * For additional information, see
+ * https://html.spec.whatwg.org/multipage/media.html#texttrackmode.
+ */
+export declare type ITextTrackMode = "disabled" | "hidden" | "showing";
+/**
+ * Represents detailed information about a media track
+ */
+export interface ITrackInfo {
+    /**
+     * Unique identifier of the track
+     */
+    readonly id: string;
+    /**
+     * Type of the track (AUDIO, VIDEO, or TEXT)
+     */
+    readonly type: ITrackType;
+    /**
+     * Specific classification of the track (e.g., "main", "commentary", "subtitles")
+     */
+    readonly kind: string;
+    /**
+     * User-friendly label for the track
+     */
+    readonly label: string;
+    /**
+     * Language of the track content (e.g., "en", "es")
+     *
+     * For "AUDIO" ITrackType, refer to: https://html.spec.whatwg.org/multipage/media.html#dom-audiotrack-language
+     * For "TEXT" ITrackType, refer to: https://html.spec.whatwg.org/multipage/media.html#dom-texttrack-language
+     */
+    readonly language: string;
+    /**
+     * Indicates if the track is currently active
+     * Applicable only for AUDIO or VIDEO tracks
+     */
+    readonly enabled?: boolean;
+    /**
+     * Display mode of the text track
+     * Applicable only for TEXT tracks
+     */
+    readonly mode?: ITextTrackMode;
+}
+/**
+ * Represents an error in the Kepler player session.
+ */
+export interface IPlayerSessionError {
+    /**
+     * Returns the current error's error code, from the list below.
+     *
+     * For additional information, see
+     * https://html.spec.whatwg.org/multipage/media.html#concept-mediaerror-code.
+     */
+    readonly code: number;
+    /**
+     * Returns a specific informative diagnostic message about the error condition encountered.
+     *
+     * For additional information, see
+     * https://html.spec.whatwg.org/multipage/media.html#dom-mediaerror-message.
+     */
+    readonly message: string;
+}

package/dist/turbo-modules/PlayerServerDataTypes/PlayerServerDataTypes.js

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2025 Amazon.com, Inc. or its affiliates. All rights reserved.
+ *
+ * AMAZON PROPRIETARY/CONFIDENTIAL
+ *
+ * You may not use this file except in compliance with the terms and
+ * conditions set forth in the accompanying LICENSE.TXT file.
+ *
+ * THESE MATERIALS ARE PROVIDED ON AN "AS IS" BASIS. AMAZON SPECIFICALLY
+ * DISCLAIMS, WITH RESPECT TO THESE MATERIALS, ALL WARRANTIES, EXPRESS,
+ * IMPLIED, OR STATUTORY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
+ */
+/**
+ * Represents the possible states of media playback.
+ * This must be set in `IPlayerSessionStatus` depending on the events received
+ * after registering event listeners.
+ *
+ * @see https://html.spec.whatwg.org/#event-handlers-on-elements,-document-objects,-and-window-objects
+ */
+export var IPlayerSessionState;
+(function (IPlayerSessionState) {
+    /**
+     * Playback is temporarily stopped
+     */
+    IPlayerSessionState["PAUSED"] = "PAUSED";
+    /**
+     * Media content is actively playing
+     */
+    IPlayerSessionState["PLAYING"] = "PLAYING";
+    /**
+     * Media is loading into temporary storage
+     */
+    IPlayerSessionState["BUFFERING"] = "BUFFERING";
+    /**
+     * Playback position is being changed
+     */
+    IPlayerSessionState["SEEKING"] = "SEEKING";
+    /**
+     * Media playback has reached its conclusion
+     */
+    IPlayerSessionState["ENDED"] = "ENDED";
+    /**
+     * Playback has encountered an error
+     */
+    IPlayerSessionState["ERROR"] = "ERROR";
+})(IPlayerSessionState || (IPlayerSessionState = {}));
+/**
+ * Represents the possible status values of synchronous unload of media playback.
+ * Associated with {@link @amazon-devices/kepler-player-client#IPlayerClient.unloadSync} API.
+ * These values are in sync with {@link @amazon-devices/react-native-w3cmedia#MediaPlayerDeInitStatus|W3CMedia MediaPlayerDeInitStatus}
+ */
+export var IUnloadSyncStatus;
+(function (IUnloadSyncStatus) {
+    /**
+     * Media playback instance was unloaded successfully.
+     */
+    IUnloadSyncStatus["SUCCESS"] = "success";
+    /**
+     * Media playback instance unload timed out.
+     */
+    IUnloadSyncStatus["TIMEDOUT"] = "timedout";
+    /**
+     * Invalid request for media playback unload.
+     */
+    IUnloadSyncStatus["INVALID"] = "invalid";
+})(IUnloadSyncStatus || (IUnloadSyncStatus = {}));

package/dist/turbo-modules/PlayerServerDataTypes/PlayerServerDataTypesInternal.d.ts

@@ -0,0 +1,17 @@
+import { IPlayerSessionId, IPlayerSessionLoadParams, IPlayerSessionMediaInfo, ITrackType, IViewHandle } from './PlayerServerDataTypes';
+/**
+ * Internal use-only interface for IPlayerServerHandler.
+ */
+export interface PlayerEventHandlerParams {
+    event: string;
+    urlInfo?: IPlayerSessionMediaInfo;
+    loadParams?: IPlayerSessionLoadParams;
+    sessionId?: IPlayerSessionId;
+    handle?: IViewHandle;
+    timevalue?: number;
+    boolValue?: boolean;
+    numberValue?: number;
+    stringValue?: string;
+    trackType?: ITrackType;
+    customData?: string;
+}

package/dist/turbo-modules/PlayerServerDataTypes/PlayerServerDataTypesInternal.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2025 Amazon.com, Inc. or its affiliates. All rights reserved.
+ *
+ * AMAZON PROPRIETARY/CONFIDENTIAL
+ *
+ * You may not use this file except in compliance with the terms and
+ * conditions set forth in the accompanying LICENSE.TXT file.
+ *
+ * THESE MATERIALS ARE PROVIDED ON AN "AS IS" BASIS. AMAZON SPECIFICALLY
+ * DISCLAIMS, WITH RESPECT TO THESE MATERIALS, ALL WARRANTIES, EXPRESS,
+ * IMPLIED, OR STATUTORY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
+ */
+export {};

package/dist/turbo-modules/PlayerServerDataTypes/PlayerSessionError.d.ts

@@ -0,0 +1,22 @@
+/**
+ * All media elements have an associated error status,
+ * which records the last error the element encountered since its resource
+ * selection algorithm was last invoked.
+ * Onre getting an error while perforning handle functions,
+ * apps must create instance of `PlayerSessionError`
+ * to reject the promise in corresponding `PlayerServerHandler` handle functions.
+ *
+ * For additional information, see
+ * https://html.spec.whatwg.org/multipage/media.html#mediaerror.
+ */
+export declare class PlayerSessionError extends Error {
+    /**
+     * Initializes a new instance of `PlayerSessionError`.
+     */
+    constructor(message: any);
+}
+/**
+ * Error occurs when the given argument is invalid.
+ */
+export declare class InvalidArgumentError extends PlayerSessionError {
+}

package/dist/turbo-modules/PlayerServerDataTypes/PlayerSessionError.js

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2025 Amazon.com, Inc. or its affiliates. All rights reserved.
+ *
+ * AMAZON PROPRIETARY/CONFIDENTIAL
+ *
+ * You may not use this file except in compliance with the terms and
+ * conditions set forth in the accompanying LICENSE.TXT file.
+ *
+ * THESE MATERIALS ARE PROVIDED ON AN "AS IS" BASIS. AMAZON SPECIFICALLY
+ * DISCLAIMS, WITH RESPECT TO THESE MATERIALS, ALL WARRANTIES, EXPRESS,
+ * IMPLIED, OR STATUTORY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
+ */
+/**
+ * All media elements have an associated error status,
+ * which records the last error the element encountered since its resource
+ * selection algorithm was last invoked.
+ * Onre getting an error while perforning handle functions,
+ * apps must create instance of `PlayerSessionError`
+ * to reject the promise in corresponding `PlayerServerHandler` handle functions.
+ *
+ * For additional information, see
+ * https://html.spec.whatwg.org/multipage/media.html#mediaerror.
+ */
+export class PlayerSessionError extends Error {
+    /**
+     * Initializes a new instance of `PlayerSessionError`.
+     */
+    constructor(message) {
+        super(message);
+    }
+}
+/**
+ * Error occurs when the given argument is invalid.
+ */
+export class InvalidArgumentError extends PlayerSessionError {
+}

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

@@ -0,0 +1,38 @@
+import { IPlayerServer } from './IPlayerServer';
+/**
+ * Component that provides a kepler player server instance.
+ */
+export interface IPlayerServerFactory {
+    /**
+     * Get or make an instance of kepler player server.
+     *
+     * @example
+     * ```typescript
+     * // Sample usage
+     * import {
+     *   PlayerServerFactory,
+     *   IPlayerServer
+     * } from '@amazon-devices/kepler-player-server';
+     *
+     * const playerServerRef = useRef<IPlayerClient | null>(null);
+     * const playerServerFactory = new PlayerServerFactory();
+     *
+     * if (playerServerRef.current == null) {
+     *   playerServerRef.current = playerServerFactory.getOrMakeServer();
+     * }
+     * ```
+     *
+     * @returns {IPlayerServer} A kepler player server instance.
+     */
+    getOrMakeServer(): IPlayerServer;
+}
+/** @ignore */
+export declare class PlayerServerFactory {
+    private static server;
+    /**
+     * Makes or returns the PlayerServer singleton
+     */
+    getOrMakeServer(): IPlayerServer;
+}
+declare const _default: PlayerServerFactory;
+export default _default;

package/dist/turbo-modules/PlayerServerFactory.js

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2025 Amazon.com, Inc. or its affiliates. All rights reserved.
+ *
+ * AMAZON PROPRIETARY/CONFIDENTIAL
+ *
+ * You may not use this file except in compliance with the terms and
+ * conditions set forth in the accompanying LICENSE.TXT file.
+ *
+ * THESE MATERIALS ARE PROVIDED ON AN "AS IS" BASIS. AMAZON SPECIFICALLY
+ * DISCLAIMS, WITH RESPECT TO THESE MATERIALS, ALL WARRANTIES, EXPRESS,
+ * IMPLIED, OR STATUTORY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
+ */
+import { PlayerServer } from './PlayerServer';
+/** @ignore */
+export class PlayerServerFactory {
+    static server;
+    /**
+     * Makes or returns the PlayerServer singleton
+     */
+    getOrMakeServer() {
+        if (!PlayerServerFactory.server) {
+            PlayerServerFactory.server = new PlayerServer();
+        }
+        return PlayerServerFactory.server;
+    }
+}
+export default new PlayerServerFactory();