@theoplayer/extended 2.89.1 → 2.91.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/THEOplayer.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * THEOplayer
3
3
  * https://www.theoplayer.com
4
4
  *
5
- * Version: 2021.3.2 (2.89.1)
5
+ * Version: 2021.4.1 (2.91.1)
6
6
  */
7
7
 
8
8
  /**
@@ -1655,8 +1655,14 @@ export declare interface Chromecast extends VendorCast, EventDispatcher<Chromeca
1655
1655
  receiverName: string | undefined;
1656
1656
  /**
1657
1657
  * The source of the active casting session, if any.
1658
+ *
1659
+ * @deprecated Superseded by {@link Chromecast.connectionCallback}.
1658
1660
  */
1659
1661
  source: SourceDescription | undefined;
1662
+ /**
1663
+ * The callback for the Chromecast connection changes.
1664
+ */
1665
+ connectionCallback: ChromecastConnectionCallback | undefined;
1660
1666
  /**
1661
1667
  * Join an active casting session.
1662
1668
  */
@@ -1693,6 +1699,58 @@ export declare interface ChromecastConfiguration {
1693
1699
  appID?: string;
1694
1700
  }
1695
1701
 
1702
+ /**
1703
+ * The ChromecastConnectionCallback.
1704
+ *
1705
+ * @public
1706
+ */
1707
+ export declare interface ChromecastConnectionCallback {
1708
+ /**
1709
+ * Called after the player has started the connection to the receiver.
1710
+ *
1711
+ * @remarks
1712
+ * <br/> - At this point we are trying to load the media from the sender to the receiver.
1713
+ * <br/> - Returning null will behave same as returning the provided SourceDescription.
1714
+ *
1715
+ * @param sourceDescription - The current SourceDescription on the sender device.
1716
+ * @returns The SourceDescription to be loaded on the receiver device.
1717
+ */
1718
+ onStart(sourceDescription: SourceDescription | undefined): SourceDescription | undefined;
1719
+ /**
1720
+ * Called after the player has stopped the connection to the receiver.
1721
+ *
1722
+ * @remarks
1723
+ * <br/> - At this point we are trying to load the media from the receiver to the sender.
1724
+ * <br/> - Returning null will behave same as returning the provided SourceDescription.
1725
+ *
1726
+ * @param sourceDescription - The current SourceDescription on the receiver device.
1727
+ * @returns The SourceDescription to be loaded on the sender device.
1728
+ */
1729
+ onStop(sourceDescription: SourceDescription | undefined): SourceDescription | undefined;
1730
+ /**
1731
+ * Called after the player has joined an already existing connection to the receiver.
1732
+ *
1733
+ * @remarks
1734
+ * <br/> - At this point it's possible to load a new media from the sender to the receiver.
1735
+ * <br/> - Returning null will not change the source on the receiver.
1736
+ *
1737
+ * @param sourceDescription - The current SourceDescription on the current sender device.
1738
+ * @returns The SourceDescription to be loaded on the receiver device.
1739
+ */
1740
+ onJoin(sourceDescription: SourceDescription | undefined): SourceDescription | undefined;
1741
+ /**
1742
+ * Called after the player has left the connection to the receiver.
1743
+ *
1744
+ * @remarks
1745
+ * <br/> - At this point we are trying to load the media from the receiver to the sender.
1746
+ * <br/> - Returning null will behave same as returning the provided SourceDescription.
1747
+ *
1748
+ * @param sourceDescription - The current SourceDescription on the receiver device.
1749
+ * @returns The SourceDescription to be loaded on the sender device.
1750
+ */
1751
+ onLeave(sourceDescription: SourceDescription | undefined): SourceDescription | undefined;
1752
+ }
1753
+
1696
1754
  /**
1697
1755
  * An error that occurred while casting or attempting to cast to Chromecast.
1698
1756
  *
@@ -3747,6 +3805,29 @@ export declare interface FreeWheelCue {
3747
3805
  timeOffset: number;
3748
3806
  }
3749
3807
 
3808
+ /**
3809
+ * @public
3810
+ */
3811
+ declare interface FullscreenOptions_2 {
3812
+ /**
3813
+ * Whether or not to show navigation UI while in fullscreen.
3814
+ *
3815
+ * @remarks
3816
+ * <p>On mobile devices, the platform may want to show a native on-screen navigation UI (such as a back button or home button)
3817
+ * while the player is in fullscreen mode. This setting controls whether or not this should be shown:
3818
+ * <br/> - If set to "show", then the native navigation UI is preferred.
3819
+ * <br/> - If set to "hide", then more screen space for the player is preferred.
3820
+ * <br/> - If set to "auto", then the choice is left to the platform.
3821
+ * <p>By default, the player prefers to hide the on-screen navigation UI, since it already provides its own "exit fullscreen" button
3822
+ * on its control bar.
3823
+ *
3824
+ * @defaultValue `"hide"`
3825
+ * @public
3826
+ */
3827
+ navigationUI?: 'auto' | 'show' | 'hide';
3828
+ }
3829
+ export { FullscreenOptions_2 as FullscreenOptions }
3830
+
3750
3831
  /**
3751
3832
  * Represents a geographical location.
3752
3833
  *
@@ -8646,6 +8727,13 @@ export declare interface UIConfiguration {
8646
8727
  * Each entry contains a language code with associated {@link UILanguage | language map}.
8647
8728
  */
8648
8729
  languages?: Record<string, UILanguage>;
8730
+ /**
8731
+ * Options to control transitions to fullscreen mode.
8732
+ *
8733
+ * @remarks
8734
+ * <br/> - Available since v2.90.0.
8735
+ */
8736
+ fullscreenOptions?: FullscreenOptions_2;
8649
8737
  }
8650
8738
 
8651
8739
  /**
@@ -10808,6 +10896,15 @@ export declare interface VRConfiguration {
10808
10896
  * @defaultValue `''`
10809
10897
  */
10810
10898
  stereoMode?: VRStereoMode;
10899
+ /**
10900
+ * Whether the source plays using native VR.
10901
+ *
10902
+ * @remarks
10903
+ * <br/> - This property is only available for iOS.
10904
+ *
10905
+ * @defaultValue `false`
10906
+ */
10907
+ nativeVR?: boolean;
10811
10908
  }
10812
10909
 
10813
10910
  /**