@theoplayer/extended 7.8.0 → 7.9.0

package/THEOplayer.common.d.ts

@@ -2129,6 +2129,9 @@ type KeySystemId = 'widevine' | 'fairplay' | 'playready';
  * @category Source
  * @category SSAI
  * @public
+ *
+ * @deprecated
+ * Use the new [Yospace web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/yospace/) instead.
  */
 type YospaceSSAIIntegrationID = 'yospace';
 /**
@@ -2141,6 +2144,9 @@ type YospaceSSAIIntegrationID = 'yospace';
  * @category Source
  * @category SSAI
  * @public
+ *
+ * @deprecated
+ * Use the new [Yospace web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/yospace/) instead.
  */
 type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
 /**
@@ -2152,6 +2158,9 @@ type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
  * @category Source
  * @category SSAI
  * @public
+ *
+ * @deprecated
+ * Use the new [Yospace web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/yospace/) instead.
  */
 interface YospaceServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
     /**
@@ -2171,6 +2180,9 @@ interface YospaceServerSideAdInsertionConfiguration extends ServerSideAdInsertio
  * @category Source
  * @category SSAI
  * @public
+ *
+ * @deprecated
+ * Use the new [Yospace web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/yospace/) instead.
  */
 interface YospaceTypedSource extends TypedSource {
     ssai: YospaceServerSideAdInsertionConfiguration;
@@ -2355,7 +2367,7 @@ interface ImagineTypedSource extends TypedSource {
 
 /**
  * The identifier of a server-side ad insertion pre-integration, represented by a value from the following list:
- * <br/> - `'yospace'`: The configuration with this identifier is a {@link YospaceServerSideAdInsertionConfiguration}
+ * <br/> - `'yospace'`: The configuration with this identifier is a {@link YospaceServerSideAdInsertionConfiguration} (deprecated)
  * <br/> - `'google-dai'`: The configuration with this identifier is a {@link GoogleDAIConfiguration}
  * <br/> - `'imagine'`: The configuration with this identifier is a {@link ImagineServerSideAdInsertionConfiguration}
  *
@@ -2579,12 +2591,12 @@ interface VerizonMediaUiConfiguration {
  */
 interface SourceAbrConfiguration {
     /**
-     * A list of preferred audio codecs which will be used by the ABR algorithm to make an initial selection, if the codec is supported.
+     * A list of preferred audio codecs which will be used by the ABR algorithm for track selection, if the codec is supported.
      *
      */
     preferredAudioCodecs?: string[];
     /**
-     * A list of preferred video codecs which will be used by the ABR algorithm to make an initial selection, if the codec is supported.
+     * A list of preferred video codecs which will be used by the ABR algorithm for track selection, if the codec is supported.
      */
     preferredVideoCodecs?: string[];
     /**
@@ -4611,7 +4623,7 @@ type SourceIntegrationId = 'verizon-media' | 'mediatailor' | 'theolive';
 /**
  * The integration identifier of an analytics description, represented by a value from the following list:
  * <br/> - `'agama'`: The description is an {@link AgamaConfiguration}
- * <br/> - `'conviva'`: The description is a {@link ConvivaConfiguration}
+ * <br/> - `'conviva'`: The description is a {@link ConvivaConfiguration} (deprecated)
  * <br/> - `'youbora'`: The description is a {@link YouboraOptions}
  * <br/> - `'moat'`: The description is a {@link MoatConfiguration}
  * <br/> - `'streamone'`: The description is a {@link StreamOneConfiguration}
@@ -6814,6 +6826,9 @@ interface ABRConfiguration {
  *
  * @category Analytics
  * @public
+ *
+ * @deprecated
+ * Use the new [Conviva web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/conviva/) instead.
  */
 type ConvivaAnalyticsIntegrationID = 'conviva';
 /**
@@ -6824,6 +6839,9 @@ type ConvivaAnalyticsIntegrationID = 'conviva';
  *
  * @category Analytics
  * @public
+ *
+ * @deprecated
+ * Use the new [Conviva web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/conviva/) instead.
  */
 interface ConvivaConfiguration extends AnalyticsDescription {
     /**
@@ -6864,6 +6882,9 @@ interface ConvivaConfiguration extends AnalyticsDescription {
  *
  * @category Analytics
  * @public
+ *
+ * @deprecated
+ * Use the new [Conviva web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/conviva/) instead.
  */
 interface Conviva {
     /**
@@ -6907,6 +6928,9 @@ interface Conviva {
  *
  * @category Analytics
  * @public
+ *
+ * @deprecated
+ * Use the new [Conviva web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/conviva/) instead.
  */
 interface ConvivaContentMetadata {
     /**
@@ -6979,6 +7003,9 @@ interface Analytics {
      *
      * @remarks
      * <br/> - Only available with the feature `'conviva'`.
+     *
+     * @deprecated
+     * Use the new [Conviva web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/conviva/) instead.
      */
     conviva?: Conviva;
 }
@@ -8616,6 +8643,9 @@ interface VerizonMedia extends EventDispatcher<VerizonMediaEventMap> {
  *
  * @category SSAI
  * @public
+ *
+ * @deprecated
+ * Use the new [Yospace web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/yospace/) instead.
  */
 interface YospaceEventMap {
     /**
@@ -8631,6 +8661,9 @@ interface YospaceEventMap {
  *
  * @category SSAI
  * @public
+ *
+ * @deprecated
+ * Use the new [Yospace web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/yospace/) instead.
  */
 interface YospaceCallbackObject {
     AdBreakStart: () => void;
@@ -8648,6 +8681,9 @@ interface YospaceCallbackObject {
  *
  * @category SSAI
  * @public
+ *
+ * @deprecated
+ * Use the new [Yospace web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/yospace/) instead.
  */
 interface Yospace extends EventDispatcher<YospaceEventMap> {
     /**
@@ -9304,13 +9340,13 @@ interface EncryptedEvent extends Event<'encrypted'> {
 interface LatencyManager {
     /**
      * Whether the latency manager is enabled.
-     *
-     * @remarks
-     * <br/> - Can only be enabled for live playback.
      */
     enabled: boolean;
     /**
      * Whether the latency manager is monitoring to stay within the {@link LatencyManager.currentConfiguration | live playback configuration}.
+     *
+     * @remarks
+     * <br/> - Can only be monitored for live playback.
      */
     readonly monitoringLivePlayback: boolean;
     /**
@@ -9998,6 +10034,9 @@ declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap> {
      *
      * @remarks
      * <br/> - Only available with the feature `'yospace'`.
+     *
+     * @deprecated
+     * Use the new [Yospace web connector](https://www.theoplayer.com/docs/theoplayer/connectors/web/yospace/) instead.
      */
     readonly yospace?: Yospace;
     /**