@gcorevideo/player 2.8.2 → 2.10.0

package/docs/api/player.player.md

@@ -0,0 +1,304 @@
+<!-- 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)
+
+## Player class
+
+> 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.
+> 
+
+The main component to use in the application code.
+
+**Signature:**
+
+```typescript
+export declare class Player 
+```
+
+## Remarks
+
+The Player object provides very basic API to control playback. To build a sophisticated UI, use the plugins framework to tap into the Clappr core. [https://github.com/clappr/clappr/wiki/Architecture](https://github.com/clappr/clappr/wiki/Architecture)
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(config)](./player.player._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Constructs a new instance of the `Player` class
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[attachTo(playerElement)](./player.player.attachto.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Initializes the player at the given container element.
+
+
+</td></tr>
+<tr><td>
+
+[configure(config)](./player.player.configure.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** 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).
+
+
+</td></tr>
+<tr><td>
+
+[destroy()](./player.player.destroy.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Destroys the player, releasing all resources and removing any DOM elements added.
+
+
+</td></tr>
+<tr><td>
+
+[getCurrentTime()](./player.player.getcurrenttime.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Current playback time in seconds, if appropriate.
+
+
+</td></tr>
+<tr><td>
+
+[getDuration()](./player.player.getduration.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Duration of the current media in seconds, if appropriate.
+
+
+</td></tr>
+<tr><td>
+
+[mute()](./player.player.mute.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Mutes the player.
+
+
+</td></tr>
+<tr><td>
+
+[off(event, handler)](./player.player.off.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Removes a listener from a player event
+
+
+</td></tr>
+<tr><td>
+
+[on(event, handler)](./player.player.on.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Adds a listener to a player event
+
+
+</td></tr>
+<tr><td>
+
+[pause()](./player.player.pause.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Pauses playback.
+
+
+</td></tr>
+<tr><td>
+
+[play()](./player.player.play.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Starts playback.
+
+
+</td></tr>
+<tr><td>
+
+[registerPlugin(plugin)](./player.player.registerplugin.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+**_(BETA)_** Registers a plugin.
+
+
+</td></tr>
+<tr><td>
+
+[resize(newSize)](./player.player.resize.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Resizes the player container element and everything within it.
+
+
+</td></tr>
+<tr><td>
+
+[seek(time)](./player.player.seek.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Seeks to the given time.
+
+
+</td></tr>
+<tr><td>
+
+[stop()](./player.player.stop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Stops playback.
+
+
+</td></tr>
+<tr><td>
+
+[unmute()](./player.player.unmute.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Unmutes the player.
+
+
+</td></tr>
+<tr><td>
+
+[unregisterPlugin(plugin)](./player.player.unregisterplugin.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+**_(BETA)_** Unregisters a plugin.
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.player.mute.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; [mute](./player.player.mute.md)
+
+## Player.mute() 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.
+> 
+
+Mutes the player.
+
+**Signature:**
+
+```typescript
+mute(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.player.off.md

@@ -0,0 +1,72 @@
+<!-- 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; [off](./player.player.off.md)
+
+## Player.off() 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.
+> 
+
+Removes a listener from a player event
+
+**Signature:**
+
+```typescript
+off<T extends PlayerEvent>(event: T, handler: PlayerEventHandler<T>): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+event
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+See [PlayerEvent](./player.playerevent.md)
+
+
+</td></tr>
+<tr><td>
+
+handler
+
+
+</td><td>
+
+[PlayerEventHandler](./player.playereventhandler.md)<!-- -->&lt;T&gt;
+
+
+</td><td>
+
+See [PlayerEventHandler](./player.playereventhandler.md)
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/player.player.on.md

@@ -0,0 +1,72 @@
+<!-- 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; [on](./player.player.on.md)
+
+## Player.on() 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.
+> 
+
+Adds a listener to a player event
+
+**Signature:**
+
+```typescript
+on<T extends PlayerEvent>(event: T, handler: PlayerEventHandler<T>): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+event
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+See [PlayerEvent](./player.playerevent.md)
+
+
+</td></tr>
+<tr><td>
+
+handler
+
+
+</td><td>
+
+[PlayerEventHandler](./player.playereventhandler.md)<!-- -->&lt;T&gt;
+
+
+</td><td>
+
+See [PlayerEventHandler](./player.playereventhandler.md)
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/player.player.pause.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; [pause](./player.player.pause.md)
+
+## Player.pause() 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.
+> 
+
+Pauses playback.
+
+**Signature:**
+
+```typescript
+pause(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.player.play.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; [play](./player.player.play.md)
+
+## Player.play() 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.
+> 
+
+Starts playback.
+
+**Signature:**
+
+```typescript
+play(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/player.player.registerplugin.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; [registerPlugin](./player.player.registerplugin.md)
+
+## Player.registerPlugin() 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.
+> 
+
+Registers a plugin.
+
+**Signature:**
+
+```typescript
+static registerPlugin(plugin: PlayerPlugin): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+plugin
+
+
+</td><td>
+
+[PlayerPlugin](./player.playerplugin.md)
+
+
+</td><td>
+
+plugin to register
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/player.player.resize.md

@@ -0,0 +1,59 @@
+<!-- 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; [resize](./player.player.resize.md)
+
+## Player.resize() 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.
+> 
+
+Resizes the player container element and everything within it.
+
+**Signature:**
+
+```typescript
+resize(newSize: {
+        width: number;
+        height: number;
+    }): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+newSize
+
+
+</td><td>
+
+{ width: number; height: number; }
+
+
+</td><td>
+
+new size of the player
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/player.player.seek.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; [seek](./player.player.seek.md)
+
+## Player.seek() 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.
+> 
+
+Seeks to the given time.
+
+**Signature:**
+
+```typescript
+seek(time: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+time
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+time to seek to in seconds
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/player.player.stop.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; [stop](./player.player.stop.md)
+
+## Player.stop() 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.
+> 
+
+Stops playback.
+
+**Signature:**
+
+```typescript
+stop(): void;
+```
+**Returns:**
+
+void
+