@gcorevideo/player 2.8.2 → 2.10.0

package/docs/api/player.md

@@ -0,0 +1,295 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md)
+
+## player package
+
+Video player for the GCore streaming platform
+
+## Remarks
+
+This package provides a video player for the GCore streaming platform. It is built on top of the Clappr library and provides a framework for building custom integrations.
+
+## Classes
+
+<table><thead><tr><th>
+
+Class
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[Player](./player.player.md)
+
+
+</td><td>
+
+**_(BETA)_** The main component to use in the application code.
+
+
+</td></tr>
+</tbody></table>
+
+## Enumerations
+
+<table><thead><tr><th>
+
+Enumeration
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[PlayerEvent](./player.playerevent.md)
+
+
+</td><td>
+
+**_(BETA)_** A top-level event on the player object
+
+
+</td></tr>
+</tbody></table>
+
+## Functions
+
+<table><thead><tr><th>
+
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[version()](./player.version.md)
+
+
+</td><td>
+
+**_(BETA)_** Version information about the gplayer and its main dependencies
+
+
+</td></tr>
+</tbody></table>
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[PlayerConfig](./player.playerconfig.md)
+
+
+</td><td>
+
+**_(BETA)_** Configuration options for the player
+
+
+</td></tr>
+<tr><td>
+
+[PlayerMediaSourceDesc](./player.playermediasourcedesc.md)
+
+
+</td><td>
+
+**_(BETA)_** Describes a media source with its MIME type and URL.
+
+
+</td></tr>
+</tbody></table>
+
+## Type Aliases
+
+<table><thead><tr><th>
+
+Type Alias
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[DashSettings](./player.dashsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** [DASH.js settings](https://cdn.dashjs.org/latest/jsdoc/module-Settings.html)
+
+
+</td></tr>
+<tr><td>
+
+[LangTag](./player.langtag.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[MediaTransport](./player.mediatransport.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[PlaybackModule](./player.playbackmodule.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[PlaybackType](./player.playbacktype.md)
+
+
+</td><td>
+
+**_(BETA)_** Type of a stream playback
+
+
+</td></tr>
+<tr><td>
+
+[PlayerDebugSettings](./player.playerdebugsettings.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[PlayerDebugTag](./player.playerdebugtag.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[PlayerEventHandler](./player.playereventhandler.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[PlayerMediaSource](./player.playermediasource.md)
+
+
+</td><td>
+
+**_(BETA)_** A media source to fetch the media data from
+
+
+</td></tr>
+<tr><td>
+
+[PlayerPlugin](./player.playerplugin.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[QualityLevel](./player.qualitylevel.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[TranslationKey](./player.translationkey.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[TranslationSettings](./player.translationsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** \[language\]\[key\] =<!-- -->&gt; string
+
+
+</td></tr>
+<tr><td>
+
+[TransportPreference](./player.transportpreference.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.mediatransport.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaTransport](./player.mediatransport.md)
+
+## MediaTransport type
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+**Signature:**
+
+```typescript
+export type MediaTransport = 'dash' | 'hls' | 'mpegts';
+```

package/docs/api/player.playbackmodule.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlaybackModule](./player.playbackmodule.md)
+
+## PlaybackModule type
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+**Signature:**
+
+```typescript
+export type PlaybackModule = 'dash' | 'hls' | 'native';
+```

package/docs/api/player.playbacktype.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlaybackType](./player.playbacktype.md)
+
+## PlaybackType type
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Type of a stream playback
+
+**Signature:**
+
+```typescript
+export type PlaybackType = 'live' | 'vod';
+```

package/docs/api/player.player._constructor_.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Player](./player.player.md) &gt; [(constructor)](./player.player._constructor_.md)
+
+## Player.(constructor)
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Constructs a new instance of the `Player` class
+
+**Signature:**
+
+```typescript
+constructor(config: PlayerConfig);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+config
+
+
+</td><td>
+
+[PlayerConfig](./player.playerconfig.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.player.attachto.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Player](./player.player.md) &gt; [attachTo](./player.player.attachto.md)
+
+## Player.attachTo() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Initializes the player at the given container element.
+
+**Signature:**
+
+```typescript
+attachTo(playerElement: HTMLElement): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+playerElement
+
+
+</td><td>
+
+HTMLElement
+
+
+</td><td>
+
+DOM element to host the player
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/player.player.configure.md

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Player](./player.player.md) &gt; [configure](./player.player.configure.md)
+
+## Player.configure() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Configures the player.
+
+Can be called multiple times. Each consequent call extends the previous configuration. After a reconfiguration, if something significant has changed, the must be reinitialized (i.e, a `.destroy()` followed by an `.init()` call).
+
+**Signature:**
+
+```typescript
+configure(config: Partial<PlayerConfig>): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+config
+
+
+</td><td>
+
+Partial&lt;[PlayerConfig](./player.playerconfig.md)<!-- -->&gt;
+
+
+</td><td>
+
+complete or partial configuration
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/player.player.destroy.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Player](./player.player.md) &gt; [destroy](./player.player.destroy.md)
+
+## Player.destroy() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Destroys the player, releasing all resources and removing any DOM elements added.
+
+**Signature:**
+
+```typescript
+destroy(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.player.getcurrenttime.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Player](./player.player.md) &gt; [getCurrentTime](./player.player.getcurrenttime.md)
+
+## Player.getCurrentTime() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Current playback time in seconds, if appropriate.
+
+**Signature:**
+
+```typescript
+getCurrentTime(): number;
+```
+**Returns:**
+
+number
+
+For live streams, it returns the current time of the current segment.
+

package/docs/api/player.player.getduration.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Player](./player.player.md) &gt; [getDuration](./player.player.getduration.md)
+
+## Player.getDuration() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Duration of the current media in seconds, if appropriate.
+
+**Signature:**
+
+```typescript
+getDuration(): number;
+```
+**Returns:**
+
+number
+
+For live streams, it returns the duration of the current segment.
+