react-native-theoplayer 1.7.1 → 1.8.0

package/lib/typescript/src/internal/THEOplayerView.d.ts

@@ -1,6 +1,6 @@
 import React, { PureComponent } from 'react';
 import { NativeSyntheticEvent, HostComponent } from 'react-native';
-import type { DurationChangeEvent, ErrorEvent, LoadedMetadataEvent, ReadyStateChangeEvent, THEOplayerViewComponent, THEOplayerViewProps, TimeUpdateEvent, ProgressEvent, PlayerError, SegmentNotFoundEvent, TextTrackListEvent, TextTrackEvent, AdEvent, AdsAPI } from 'react-native-theoplayer';
+import type { DurationChangeEvent, ErrorEvent, LoadedMetadataEvent, ReadyStateChangeEvent, THEOplayerViewComponent, THEOplayerViewProps, TimeUpdateEvent, ProgressEvent, PlayerError, SegmentNotFoundEvent, TextTrackListEvent, TextTrackEvent, AdEvent, AdsAPI, MediaTrackEvent, MediaTrackListEvent, CastAPI, CastEvent } from 'react-native-theoplayer';
 import type { SourceDescription } from 'react-native-theoplayer';
 interface THEOplayerRCTViewProps extends THEOplayerViewProps {
     ref: React.RefObject<THEOplayerViewNativeComponent>;
@@ -24,7 +24,10 @@ interface THEOplayerRCTViewProps extends THEOplayerViewProps {
     onNativeSegmentNotFound: (event: NativeSyntheticEvent<SegmentNotFoundEvent>) => void;
     onNativeTextTrackListEvent: (event: NativeSyntheticEvent<TextTrackListEvent>) => void;
     onNativeTextTrackEvent: (event: NativeSyntheticEvent<TextTrackEvent>) => void;
+    onNativeMediaTrackListEvent: (event: NativeSyntheticEvent<MediaTrackListEvent>) => void;
+    onNativeMediaTrackEvent: (event: NativeSyntheticEvent<MediaTrackEvent>) => void;
     onNativeAdEvent: (event: NativeSyntheticEvent<AdEvent>) => void;
+    onNativeCastEvent: (event: NativeSyntheticEvent<CastEvent>) => void;
     onNativeFullscreenPlayerWillPresent?: () => void;
     onNativeFullscreenPlayerDidPresent?: () => void;
     onNativeFullscreenPlayerWillDismiss?: () => void;
@@ -40,6 +43,7 @@ interface THEOplayerViewNativeComponent extends THEOplayerViewComponent, HostCom
 export declare class THEOplayerView extends PureComponent<THEOplayerViewProps, THEOplayerRCTViewState> implements THEOplayerViewComponent {
     private readonly _root;
     private readonly _adsApi;
+    private readonly _castApi;
     private static initialState;
     constructor(props: THEOplayerRCTViewProps);
     componentWillUnmount(): void;
@@ -47,6 +51,7 @@ export declare class THEOplayerView extends PureComponent<THEOplayerViewProps, T
     seek(time: number): void;
     get nativeHandle(): number | null;
     get ads(): AdsAPI;
+    get cast(): CastAPI;
     private reset;
     private setNativeProps;
     private maybeChangeBufferingState;
@@ -68,7 +73,10 @@ export declare class THEOplayerView extends PureComponent<THEOplayerViewProps, T
     private _onSegmentNotFound;
     private _onTextTrackListEvent;
     private _onTextTrackEvent;
+    private _onMediaTrackListEvent;
+    private _onMediaTrackEvent;
     private _onAdEvent;
+    private _onCastEvent;
     private _onFullscreenPlayerWillPresent;
     private _onFullscreenPlayerDidPresent;
     private _onFullscreenPlayerWillDismiss;

package/lib/typescript/src/internal/THEOplayerView.web.d.ts

@@ -1,5 +1,5 @@
 import { PureComponent } from 'react';
-import type { AdsAPI, PlayerError, THEOplayerViewProps } from 'react-native-theoplayer';
+import type { AdsAPI, CastAPI, PlayerError, THEOplayerViewProps } from 'react-native-theoplayer';
 import { THEOplayerViewComponent } from 'react-native-theoplayer';
 import * as THEOplayer from 'theoplayer';
 interface THEOplayerRCTViewState {
@@ -8,20 +8,25 @@ interface THEOplayerRCTViewState {
 }
 export declare class THEOplayerView extends PureComponent<THEOplayerViewProps, THEOplayerRCTViewState> implements THEOplayerViewComponent {
     private _player;
-    private _adsApi;
+    private readonly _adsApi;
+    private readonly _castApi;
     private static initialState;
     constructor(props: THEOplayerViewProps);
     componentDidMount(): void;
     componentWillUnmount(): void;
     seek(time: number): void;
     get ads(): AdsAPI;
+    get cast(): CastAPI;
     get nativePlayer(): THEOplayer.ChromelessPlayer | null;
     private reset;
     componentDidUpdate(prevProps: Readonly<THEOplayerViewProps>): void;
     private maybeChangeBufferingState;
     private onAddTextTrackCue;
     private onRemoveTextTrackCue;
+    private onActiveQualityChanged;
     private addEventListeners;
+    private dispatchTextTrackListEvent;
+    private dispatchMediaTrackListEvent;
     render(): JSX.Element;
 }
 export {};

package/lib/typescript/src/internal/cast/THEOplayerNativeAirplay.d.ts

@@ -0,0 +1,9 @@
+import type { Airplay, CastState, THEOplayerView } from 'react-native-theoplayer';
+export declare class THEOplayerNativeAirplay implements Airplay {
+    private readonly _player;
+    constructor(_player: THEOplayerView);
+    casting(): Promise<boolean>;
+    state(): Promise<CastState>;
+    start(): void;
+    stop(): void;
+}

package/lib/typescript/src/internal/cast/THEOplayerNativeCastApi.d.ts

@@ -0,0 +1,10 @@
+import type { Airplay, CastAPI, Chromecast, THEOplayerView } from 'react-native-theoplayer';
+export declare class THEOplayerNativeCastAPI implements CastAPI {
+    private readonly _player;
+    private readonly _chromecast;
+    private readonly _airplay;
+    constructor(_player: THEOplayerView);
+    casting(): Promise<boolean>;
+    get chromecast(): Chromecast | undefined;
+    get airplay(): Airplay | undefined;
+}

package/lib/typescript/src/internal/cast/THEOplayerNativeChromecast.d.ts

@@ -0,0 +1,11 @@
+import type { CastState, Chromecast, THEOplayerView } from 'react-native-theoplayer';
+export declare class THEOplayerNativeChromecast implements Chromecast {
+    private readonly _player;
+    constructor(_player: THEOplayerView);
+    casting(): Promise<boolean>;
+    state(): Promise<CastState>;
+    start(): void;
+    stop(): void;
+    join(): void;
+    leave(): void;
+}

package/lib/typescript/src/internal/cast/THEOplayerWebCastApi.d.ts

@@ -0,0 +1,9 @@
+import type { Airplay, CastAPI, Chromecast } from 'react-native-theoplayer';
+import type { THEOplayerView } from '../THEOplayerView.web';
+export declare class THEOplayerWebCastAPI implements CastAPI {
+    private readonly _player;
+    constructor(_player: THEOplayerView);
+    casting(): Promise<boolean>;
+    get chromecast(): Chromecast | undefined;
+    get airplay(): Airplay | undefined;
+}

package/lib/typescript/src/internal/web/stub/CastButtonStub.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { ViewProps } from 'react-native';
+export declare function CastButton(_props: ViewProps): JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-theoplayer",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "A THEOplayer video component for react-native.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -111,6 +111,6 @@
   },
   "dependencies": {
     "buffer": "^6.0.3",
-    "theoplayer": "^3.4.0"
+    "theoplayer": "^4.6.0"
   }
 }

package/react-native-theoplayer.podspec

@@ -13,8 +13,8 @@ Pod::Spec.new do |s|
   s.platforms    = { :ios => "11.0", :tvos => "12.0" }
   s.source       = { :git => "https://www.theoplayer.com/.git", :tag => "#{s.version}" }
 
-  s.source_files = "ios/**/*.{h,m,mm,swift}"
-  s.resources = ['ios/**/*.css']
+  s.source_files = "ios/*.{h,m,mm,swift}"
+  s.resources = ['ios/*.css']
 
   s.dependency "React-Core"
   s.dependency "THEOplayerSDK-basic"

package/src/api/THEOplayerView.ts

@@ -9,11 +9,13 @@ import type {
   ProgressEvent,
   SegmentNotFoundEvent,
 } from './event/PlayerEvent';
-import type { TextTrackEvent, TextTrackListEvent } from './event/TrackEvent';
+import type { MediaTrackEvent, MediaTrackListEvent, TextTrackEvent, TextTrackListEvent } from './event/TrackEvent';
 import type { PlayerConfiguration } from './config/PlayerConfiguration';
 import type { ABRConfiguration } from './abr/ABRConfiguration';
-import type { AdEvent } from "./event/AdEvent";
-import type { AdsAPI } from "./ads/AdsAPI";
+import type { AdEvent } from './event/AdEvent';
+import type { AdsAPI } from './ads/AdsAPI';
+import type { CastAPI } from './cast/CastAPI';
+import type { CastEvent } from './event/CastEvent';
 
 export interface THEOplayerViewProps {
   /**
@@ -225,10 +227,25 @@ export interface THEOplayerViewProps {
    */
   onTextTrackEvent?: (event: TextTrackEvent) => void;
 
+  /**
+   * Invoked when a media track list event occurs.
+   */
+  onMediaTrackListEvent?: (event: MediaTrackListEvent) => void;
+
+  /**
+   * Invoked when a media track event occurs.
+   */
+  onMediaTrackEvent?: (event: MediaTrackEvent) => void;
+
   /**
    * Invoked when an ad event occurs.
    */
   onAdEvent?: (event: AdEvent) => void;
+
+  /**
+   * Invoked when a cast event occurs, either for Chromecast or Airplay.
+   */
+  onCastEvent?: (event: CastEvent) => void;
 }
 
 export interface THEOplayerViewComponent {
@@ -243,4 +260,9 @@ export interface THEOplayerViewComponent {
    * The API for advertisements.
    */
   ads: AdsAPI;
+
+  /**
+   * The API for casting devices.
+   */
+  cast: CastAPI;
 }

package/src/api/barrel.ts

@@ -1,5 +1,6 @@
 export * from './abr/barrel';
 export * from './ads/barrel';
+export * from './cast/barrel';
 export * from './config/barrel';
 export * from './error/barrel';
 export * from './event/barrel';

package/src/api/cast/Airplay.ts

@@ -0,0 +1,31 @@
+/**
+ * The Airplay API.
+ *
+ * @public
+ */
+import type {CastState} from "./CastState";
+
+export interface Airplay {
+  /**
+   * Whether the player is connected with an airplay device.
+   */
+  casting(): Promise<boolean>;
+
+  /**
+   * The state of the casting process.
+   */
+  state(): Promise<CastState>;
+
+  /**
+   * Start a casting session with the player's source.
+   *
+   * @remarks
+   * <br/> - A native browser pop-up will prompt to choose an airplay device.
+   */
+  start(): void;
+
+  /**
+   * Stop the active casting session.
+   */
+  stop(): void;
+}

package/src/api/cast/CastAPI.ts

@@ -0,0 +1,30 @@
+import type {Airplay} from "./Airplay";
+import type {Chromecast} from "./Chromecast";
+
+/**
+ * The API for casting.
+ */
+
+
+export interface CastAPI {
+  /**
+   * Whether the player is connected with a casting device.
+   */
+  casting(): Promise<boolean>;
+
+  /**
+   * The Chromecast API.
+   *
+   * @remarks
+   * <br/> - Only available when the feature or extension `'chromecast'` is enabled.
+   */
+  readonly chromecast?: Chromecast;
+
+  /**
+   * The Airplay API.
+   *
+   * @remarks
+   * <br/> - Only available when the feature or extension `'airplay'` is enabled.
+   */
+  readonly airplay?: Airplay;
+}

package/src/api/cast/CastConfiguration.ts

@@ -0,0 +1,44 @@
+/**
+ * Describes the configuration of the Cast integrations.
+ *
+ * @public
+ */
+export interface CastConfiguration {
+  /**
+   * The Chromecast configuration.
+   *
+   * @defaultValue A {@link ChromecastConfiguration} with default values.
+   */
+  chromecast?: ChromecastConfiguration;
+
+  /**
+   * The join strategy of the player.
+   *
+   * @defaultValue `'manual'`
+   */
+  strategy?: JoinStrategy;
+}
+
+/**
+ * The join strategy, represented by a value from the following list:
+ * <br/> - `'auto'` : The player will automatically join a cast session if one exists when play is called. Otherwise it will prompt the user with all available devices.
+ * <br/> - `'manual'` : The player will take over an existing session if there is one and the cast button is clicked. Otherwise it will prompt the user with all available devices.
+ * <br/> - `'disabled'` : The player is not affected by cast sessions and is not castable.
+ *
+ * @public
+ */
+export type JoinStrategy = 'auto' | 'manual' | 'disabled';
+
+/**
+ * Describes the configuration of the Chromecast integration.
+ *
+ * @public
+ */
+export interface ChromecastConfiguration {
+  /**
+   * The identifier of a custom Chromecast receiver app.
+   *
+   * @defaultValue The default THEOplayer receiver app.
+   */
+  appID?: string;
+}

package/src/api/cast/CastState.ts

@@ -0,0 +1,10 @@
+/**
+ * The state of a casting process, represented by a value from the following list:
+ * <br/> - `'unavailable'`: No available cast devices.
+ * <br/> - `'available'`: Cast device available, but the player is not connected.
+ * <br/> - `'connecting'`: Cast device available and the player is connecting.
+ * <br/> - `'connected'`: Cast device available and the player is connected.
+ *
+ * @public
+ */
+export type CastState = 'unavailable' | 'available' | 'connecting' | 'connected';

package/src/api/cast/Chromecast.ts

@@ -0,0 +1,45 @@
+/**
+ * The Airplay API.
+ *
+ * @public
+ */
+import type {CastState} from "./CastState";
+
+export interface Chromecast {
+  /**
+   * Whether the player is connected with a chromecast device.
+   */
+  casting(): Promise<boolean>;
+
+  /**
+   * The state of the casting process.
+   */
+  state(): Promise<CastState>;
+
+  /**
+   * Start a casting session with the player's source.
+   *
+   * @remarks
+   * <br/> - A native browser pop-up will prompt to choose a chromecast device.
+   */
+  start(): void;
+
+  /**
+   * Stop the active casting session.
+   */
+  stop(): void;
+
+  /**
+   * Join an active casting session.
+   */
+  join(): void;
+
+  /**
+   * Leave the active casting session.
+   *
+   * @remarks
+   * <br/> - Does not stop the session when other devices are connected.
+   * <br/> - Use {@link stop} to fully stop the session.
+   */
+  leave(): void;
+}

package/src/api/cast/barrel.ts

@@ -0,0 +1,5 @@
+export * from './Airplay';
+export * from './CastAPI';
+export * from './CastConfiguration';
+export * from './CastState';
+export * from './Chromecast';

package/src/api/config/PlayerConfiguration.ts

@@ -1,4 +1,5 @@
-import type { AdsConfiguration } from "../ads/AdsConfiguration";
+import type { AdsConfiguration } from '../ads/AdsConfiguration';
+import type { CastConfiguration } from '../cast/CastConfiguration';
 
 export interface PlayerConfiguration {
   /**
@@ -6,6 +7,11 @@ export interface PlayerConfiguration {
    */
   ads?: AdsConfiguration;
 
+  /**
+   * The cast configuration for the player.
+   */
+  cast?: CastConfiguration;
+
   /**
    * The license for the player
    */

package/src/api/error/ChromecastError.ts

@@ -0,0 +1,46 @@
+/**
+ * The chromecast error code, represented by a value from the following list:
+ * <br/> - `'CANCEL'`: The operation was canceled by the user.
+ * <br/> - `'TIMEOUT'`: The operation timed out.
+ * <br/> - `'API_NOT_INITIALIZED'`: The API is not initialized.
+ * <br/> - `'INVALID_PARAMETER'`: The parameters to the operation were not valid.
+ * <br/> - `'EXTENSION_NOT_COMPATIBLE'`: The API script is not compatible with the installed Cast extension.
+ * <br/> - `'EXTENSION_MISSING'`: The Cast extension is not available.
+ * <br/> - `'RECEIVER_UNAVAILABLE'`: No receiver was compatible with the session request.
+ * <br/> - `'SESSION_ERROR'`: A session could not be created, or a session was invalid.
+ * <br/> - `'CHANNEL_ERROR'`: A channel to the receiver is not available.
+ * <br/> - `'LOAD_MEDIA_FAILED'`: Load media failed.
+ *
+ * @remarks
+ * <br/> - The error codes correspond to the error codes documented in the {@link https://developers.google.com/cast/docs/reference/chrome/chrome.cast.html#.ErrorCode | Chromecast API reference}.
+ *
+ * @public
+ */
+export type ChromecastErrorCode =
+  | 'CANCEL'
+  | 'TIMEOUT'
+  | 'API_NOT_INITIALIZED'
+  | 'INVALID_PARAMETER'
+  | 'EXTENSION_NOT_COMPATIBLE'
+  | 'EXTENSION_MISSING'
+  | 'RECEIVER_UNAVAILABLE'
+  | 'SESSION_ERROR'
+  | 'CHANNEL_ERROR'
+  | 'LOAD_MEDIA_FAILED';
+
+/**
+ * An error that occurred while casting or attempting to cast to Chromecast.
+ *
+ * @public
+ */
+export interface ChromecastError {
+  /**
+   * The error code of the error.
+   */
+  errorCode: ChromecastErrorCode;
+
+  /**
+   * The human-readable description of the error.
+   */
+  description: string;
+}

package/src/api/error/barrel.ts

@@ -1 +1,2 @@
 export * from './PlayerError';
+export * from './ChromecastError';

package/src/api/event/CastEvent.ts

@@ -0,0 +1,45 @@
+import type { CastState, ChromecastError } from 'react-native-theoplayer';
+
+export const CastEventNames = [
+  /**
+   * Dispatched when the ChromeCast state was changed.
+   */
+  'chromecaststatechange',
+
+  /**
+   * Dispatched when the Airplay state was changed.
+   */
+  'airplaystatechange',
+
+  /**
+   * Dispatched when an error occurred when using Chromecast.
+   */
+  'chromecasterror',
+] as const;
+
+export type CastEventType = typeof CastEventNames[number];
+
+export interface CastEvent {
+  /**
+   * Type of ad event.
+   */
+  readonly type: CastEventType;
+}
+
+export interface ChromecastChangeEvent extends CastEvent {
+  readonly type: 'chromecaststatechange';
+
+  readonly state: CastState;
+}
+
+export interface AirplayStateChangeEvent extends CastEvent {
+  readonly type: 'airplaystatechange';
+
+  readonly state: CastState;
+}
+
+export interface ChromecastErrorEvent extends CastEvent {
+  readonly type: 'chromecasterror';
+
+  readonly error: ChromecastError;
+}

package/src/api/event/TrackEvent.ts

@@ -1,5 +1,7 @@
 import type { TextTrack } from '../track/TextTrack';
 import type { TextTrackCue } from '../track/TextTrackCue';
+import type { MediaTrack } from '../track/MediaTrack';
+import type { Quality } from '../track/Quality';
 
 export enum TrackListEventType {
   /**
@@ -11,14 +13,21 @@ export enum TrackListEventType {
    * Dispatched when track has been removed from the track list.
    */
   RemoveTrack,
+
+  /**
+   * Fired when a track has been changed.
+   */
+  ChangeTrack,
 }
 
-export interface TextTrackListEvent {
+export interface TrackListEvent {
   /**
-   * The type of text track list event.
+   * The type of track list event.
    */
   readonly type: TrackListEventType;
+}
 
+export interface TextTrackListEvent extends TrackListEvent {
   /**
    * The relevant text track.
    */
@@ -53,3 +62,50 @@ export interface TextTrackEvent {
    */
   readonly cue: TextTrackCue;
 }
+
+export enum MediaTrackType {
+  Audio,
+
+  Video,
+}
+
+export interface MediaTrackListEvent extends TrackListEvent {
+  /**
+   * The relevant media track type, either {@link MediaTrackType.Audio} or {@link MediaTrackType.Video}.
+   */
+  readonly trackType: MediaTrackType;
+
+  /**
+   * The relevant media track.
+   */
+  readonly track: MediaTrack;
+}
+
+export enum MediaTrackEventType {
+  /**
+   * Dispatched when the media track's active quality changes.
+   */
+  ActiveQualityChanged,
+}
+
+export interface MediaTrackEvent {
+  /**
+   * The type of media track event.
+   */
+  readonly type: MediaTrackEventType;
+
+  /**
+   * The media track's type to which event belongs, either {@link MediaTrackType.Audio} or {@link MediaTrackType.Video}.
+   */
+  readonly trackType: MediaTrackType;
+
+  /**
+   * The media track's uid to which event belongs.
+   */
+  readonly trackUid: number;
+
+  /**
+   * The affected media track's qualities.
+   */
+  readonly qualities?: Quality | Quality[];
+}

package/src/api/event/barrel.ts

@@ -1,3 +1,4 @@
+export * from './AdEvent';
+export * from './CastEvent';
 export * from './PlayerEvent';
 export * from './TrackEvent';
-export * from './AdEvent';

package/src/api/source/SourceDescription.ts

@@ -10,6 +10,7 @@ import type { DashPlaybackConfiguration } from './dash/DashPlaybackConfiguration
 import type { DRMConfiguration } from './drm/DRMConfiguration';
 import type { HlsPlaybackConfiguration } from './hls/HlsPlaybackConfiguration';
 import type { AdDescription } from './ads/Ads';
+import type { MetadataDescription } from './metadata/MetadataDescription';
 import type { ServerSideAdInsertionConfiguration } from "./ads/ssai/ServerSideAdInsertionConfiguration";
 
 export type Source = TypedSource;
@@ -79,6 +80,13 @@ export interface SourceConfiguration {
    * <br/> - All sources will use the time server. Alternatively, for one source use {@link BaseSource.timeServer}.
    */
   timeServer?: string;
+
+  /**
+   * Describes the metadata of a source.
+   *
+   * @public
+   */
+  metadata?: MetadataDescription;
 }
 
 /**

package/src/api/source/barrel.ts

@@ -2,4 +2,5 @@ export * from './ads/barrel';
 export * from './drm/barrel';
 export * from './dash/barrel';
 export * from './hls/barrel';
+export * from './metadata/barrel';
 export * from './SourceDescription';

package/src/api/source/metadata/MetadataDescription.ts

@@ -0,0 +1,13 @@
+/**
+ * Describes the metadata of a source.
+ *
+ * @public
+ */
+export interface MetadataDescription {
+  [metadataKey: string]: any;
+
+  /**
+   * The title of the content.
+   */
+  readonly title?: string;
+}

package/src/api/source/metadata/barrel.ts

@@ -0,0 +1 @@
+export * from './MetadataDescription';