Skip to content

Commit

Permalink
Deploy preview for PR 41 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
@theoplayer-bot
theoplayer-bot[bot] committed Apr 11, 2024
1 parent 17b5012 commit 06d85a2
Show file tree
Hide file tree
Showing 6,881 changed files with 3,629,483 additions and 0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
Empty file added pr-preview/pr-41/.nojekyll
View file
Empty file.
21 changes: 21 additions & 0 deletions pr-preview/pr-41/404.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!doctype html>
<html lang="en" dir="ltr" class="plugin-native plugin-id-default" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.2.0">
<title data-rh="true">Page Not Found | THEOdocs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://www.theoplayer.com/documentation/pr-preview/pr-41/404.html/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | THEOdocs"><link data-rh="true" rel="icon" href="/documentation/pr-preview/pr-41/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://www.theoplayer.com/documentation/pr-preview/pr-41/404.html/"><link data-rh="true" rel="alternate" href="https://www.theoplayer.com/documentation/pr-preview/pr-41/404.html/" hreflang="en"><link data-rh="true" rel="alternate" href="https://www.theoplayer.com/documentation/pr-preview/pr-41/404.html/" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://7HRS9V6FEL-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="THEOdocs" href="/documentation/pr-preview/pr-41/opensearch.xml">




<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Francois+One&family=Open+Sans:ital,wght@0,300..800;1,300..800&display=swap">
<script src="//js.hs-scripts.com/2163521.js" id="hs-script-loader" async defer="defer"></script><link rel="stylesheet" href="/documentation/pr-preview/pr-41/assets/css/styles.219338a8.css">
<script src="/documentation/pr-preview/pr-41/assets/js/runtime~main.bed31e18.js" defer="defer"></script>
<script src="/documentation/pr-preview/pr-41/assets/js/main.7ca6d769.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const a=new URLSearchParams(window.location.search).entries();for(var[t,e]of a)if(t.startsWith("docusaurus-data-")){var n=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(n,e)}}catch(t){}}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="announcementBar_mb4j" style="background-color:#9cb9c9;color:#344a5e" role="banner"><div class="content_knG7 announcementBarContent_xLdY">This is a preview of the documentation website from <a target="_blank" rel="noopener noreferrer" href="https://github.com/THEOplayer/documentation/pull/41">pull request #41</a>.</div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/documentation/pr-preview/pr-41/"><div class="navbar__logo"><img src="/documentation/pr-preview/pr-41/img/logo.svg" alt="THEOdocs" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/documentation/pr-preview/pr-41/img/logo_dark.svg" alt="THEOdocs" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a><a class="navbar__item navbar__link" href="/documentation/pr-preview/pr-41/theoplayer/">THEOplayer</a><a class="navbar__item navbar__link" href="/documentation/pr-preview/pr-41/open-video-ui/">Open Video UI</a><a href="https://developers.theo.live/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">THEOlive<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></div><div class="navbar__items navbar__items--right"><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 <a href="https://www.theoplayer.com/">THEO Technologies</a></div></div></div></footer></div>
</body>
</html>
1 change: 1 addition & 0 deletions pr-preview/pr-41/assets/css/styles.219338a8.css
View file

Large diffs are not rendered by default.

107 changes: 107 additions & 0 deletions pr-preview/pr-41/assets/files/ABRConfiguration-e5922627f1e12f45da3666c5d05213fc.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
/**
* The adaptive bitrate strategy of the first segment, represented by a value from the following list:
* <br/> - `'performance'`: The player will optimize ABR behavior to focus on the performance of the player. This strategy initiates playback with the lowest quality suitable for the device which means faster start-up time.
* <br/> - `'quality'`: The player will optimize ABR behavior to focus displaying the best visual quality to the end-user. This strategy initiates playback with the highest bit rate suitable for the device.
* <br/> - `'bandwidth'`: The player will optimize the ABR behavior to focus on displaying the most optimal quality based on historic data of available bandwidth and knowledge of the network conditions.
*
* @public
*/
export enum ABRStrategyType {
performance = 'performance',
quality = 'quality',
bandwidth = 'bandwidth',
}

/**
* Describes the metadata of the adaptive bitrate strategy.
*
* @public
*/
export interface ABRMetadata {
/**
* The initial bitrate, in bits per second.
*
* @defaultValue Bitrate available to the browser.
*/
bitrate?: number;
}

/**
* Describes the configuration of the adaptive bitrate strategy.
*
* @public
*/
export interface ABRStrategyConfiguration {
/**
* The strategy for initial playback.
*/
type: ABRStrategyType;

/**
* The metadata for the initial playback strategy.
*
* @defaultValue A {@link ABRMetadata} object with default values.
*/
metadata?: ABRMetadata;
}

/**
* The adaptive bitrate stratey.
*
* @public
*/
export type ABRStrategy = ABRStrategyConfiguration | ABRStrategyType;

/**
* Describes the adaptive bitrate configuration.
*
* @public
*/
export interface ABRConfiguration {
/**
* The adaptive bitrate strategy.
*
* @defaultValue `'bandwidth'`
*/
strategy?: ABRStrategy;

/**
* The amount which the player should buffer ahead of the current playback position, in seconds.
*
* @remarks
* <br/> - Before v4.3.0: This duration has a maximum of 60 seconds.
* <br/> - After v4.3.0: This duration has no maximum.
* <br/> - The player might reduce or ignore the configured amount because of device or performance constraints.
*
* @defaultValue `20`
*/
targetBuffer?: number;

/**
* The amount of data which the player should keep in its buffer before the current playback position, in seconds.
* This configuration option can be used to reduce the memory footprint on memory restricted devices or on devices
* which don't automatically prune decoder buffers.
*
* Note that the player can decide to keep less data in the decoder buffer in case memory is running low.
* A value of 0 or lower is not accepted and will be treated as default.
*
* @defaultValue `30`
*
* @remarks
* <br/> - This property is currently supported on Web platforms only.
*/
bufferLookbackWindow?: number;

/**
* The maximum length of the player's buffer, in seconds.
*
* The player will initially buffer up to {@link ABRConfiguration.targetBuffer} seconds of media data.
* If the player detects that the decoder is unable to hold so much data,
* it will reduce `maxBufferLength` and restrict `targetBuffer` to be less than
* this maximum.
*
* @remarks
* <br/> - This property is currently supported on Web platforms only.
*/
readonly maxBufferLength?: number;
}
267 changes: 267 additions & 0 deletions pr-preview/pr-41/assets/files/Ad-f36cefb29d0e9a8486a7ad9794bf1c79.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,267 @@
/**
* Represents a VAST creative. It is either a linear or non-linear ad.
*
* @public
*/
import type { AdBreak } from './AdBreak';
import type { CompanionAd } from 'theoplayer';

export interface Ad {
/**
* The source ad server information included in the ad response.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
adSystem: string | undefined;

/**
* The integration of the ad, represented by a value from the following list:
* <br/> - `'theo'`
* <br/> - `'google-ima'`
* <br/> - `'google-dai'`
* <br/> - `'freewheel'`
*
* @defaultValue `'theo'`
*/
integration?: string;

/**
* The type of the ad, represented by a value from the following list:
* <br/> - `'linear'`
* <br/> - `'nonlinear'`
*/
type: string;

/**
* The identifier of the creative.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
id: string | undefined;

/**
* The ready state of the ad.
*/
readyState?: AdReadyState;

/**
* The ad break which the ad is part of.
*
* @remarks
* <br/> - Available for VAST-ads.
*/
adBreak: AdBreak;

/**
* The duration of the ad, in seconds.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
* <br/> - Only available for LinearAd.
*/
duration?: number;

/**
* The width of the ad, in pixels.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
width: number | undefined;

/**
* The height of the ad.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
height: number | undefined;

/**
* The URI of the the ad content.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
resourceURI?: string;

/**
* The website of the advertisement.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
clickThrough: string | undefined;

/**
* List of companions which can be displayed outside the player.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
* <br/> - Only supported for `'theo'` and `'google-dai'`.
*/
companions: CompanionAd[];

/**
* Offset after which the ad break may be skipped, in seconds.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
* <br/> - If the offset is -1, the ad is unskippable.
* <br/> - If the offset is 0, the ad is immediately skippable.
* <br/> - Otherwise it must be a positive number indicating the offset.
*/
skipOffset: number | undefined;

/**
* The identifier of the selected creative for the ad.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
creativeId: string | undefined;

/**
* The list of universal ad ID information of the selected creative for the ad.
*
* @remarks
* <br/> - Only supported for `'theo'` and `'google-ima'`.
*/
universalAdIds: UniversalAdId[];
}

/**
* The ad readiness state, represented by a value from the following list:
* <br/> - `'none'`: The ad not loaded state.
* <br/> - `'ready'`: The ad loaded state.
*
* @remarks
* <br/> - An ad is loaded when the ad resource (e.g. VAST file) is downloaded.
* <br/> - another remark
*
* @public
*/
export type AdReadyState = 'none' | 'ready';

/**
* Represents the information regarding the universal identifier of an ad.
*
* @public
*/
export interface UniversalAdId {
/**
* The registry associated with cataloging the UniversalAdId of the selected creative for the ad.
*
* @remarks
* <br/> - Returns the registry value, or 'unknown' if unavailable.
*/
adIdRegistry: string;

/**
* The UniversalAdId of the selected creative for the ad.
*
* @remarks
* <br/> - Returns the id value or 'unknown' if unavailable.
*/
adIdValue: string;
}

/**
* Represents a non-linear ad in the VAST specification.
*
* @public
*/
export interface NonLinearAd extends Ad {
/**
* The alternative description for the ad.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
altText: string | undefined;

/**
* The website of the ad.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
clickThrough: string | undefined;

/**
* The HTML-string with the content of the ad.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
contentHTML: string | undefined;
}

/**
* The delivery type of the ad content file, represented by a value from the following list:
* <br/> - `'progressive'`: Delivered through progressive download protocols (e.g. HTTP).
* <br/> - `'streaming'`: Delivered through streaming download protocols.
*
* @remarks
* <br/> - `'streaming'` is currently not supported.
*
* @public
*/
export type DeliveryType = 'progressive' | 'streaming';

/**
* Represents metadata of an media file with ad content.
*
* @remarks
* <br/> - This metadata is retrieved from the VAST file.
*
* @public
*/
export interface MediaFile {
/**
* The delivery type of the video file.
*/
delivery: DeliveryType;

/**
* The MIME type for the file container.
*/
type: string;

/**
* The native width of the video file, in pixels.
*/
width: number;

/**
* The native height of the video file, in pixels.
*/
height: number;

/**
* The URI of the VAST content.
*/
contentURL: string;
}

/**
* Represents a linear ad in the VAST specification.
*
* @public
*/
export interface LinearAd extends Ad {
/**
* The duration of the ad, in seconds.
*
* @remarks
* <br/> - Available when the {@link Ad.readyState} is `'ready'`.
*/
duration: number;

/**
* List of media files which contain metadata about ad video files.
*/
mediaFiles: MediaFile[];
}
Loading

0 comments on commit 06d85a2

Please sign in to comment.