@gcorevideo/player 2.8.2 → 2.10.0

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

package/docs/api/player.player.unregisterplugin.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; [unregisterPlugin](./player.player.unregisterplugin.md)
+
+## Player.unregisterPlugin() 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.
+> 
+
+Unregisters a plugin.
+
+**Signature:**
+
+```typescript
+static unregisterPlugin(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 unregister
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/player.playerconfig.autoplay.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; [PlayerConfig](./player.playerconfig.md) &gt; [autoPlay](./player.playerconfig.autoplay.md)
+
+## PlayerConfig.autoPlay property
+
+> 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.
+> 
+
+Start playback automatically when the player is ready
+
+**Signature:**
+
+```typescript
+autoPlay?: boolean;
+```

package/docs/api/player.playerconfig.dash.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; [PlayerConfig](./player.playerconfig.md) &gt; [dash](./player.playerconfig.dash.md)
+
+## PlayerConfig.dash property
+
+> 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.
+> 
+
+Configuration settings for the DASH playback engine
+
+**Signature:**
+
+```typescript
+dash?: DashSettings;
+```

package/docs/api/player.playerconfig.debug.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; [PlayerConfig](./player.playerconfig.md) &gt; [debug](./player.playerconfig.debug.md)
+
+## PlayerConfig.debug property
+
+> 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.
+> 
+
+Controls the debug output level
+
+**Signature:**
+
+```typescript
+debug?: PlayerDebugSettings;
+```

package/docs/api/player.playerconfig.language.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; [PlayerConfig](./player.playerconfig.md) &gt; [language](./player.playerconfig.language.md)
+
+## PlayerConfig.language property
+
+> 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.
+> 
+
+A language code for the player UI, for example, `es`<!-- -->. Must reference a key in the [strings](./player.playerconfig.strings.md) record.
+
+**Signature:**
+
+```typescript
+language?: string;
+```

package/docs/api/player.playerconfig.loop.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; [PlayerConfig](./player.playerconfig.md) &gt; [loop](./player.playerconfig.loop.md)
+
+## PlayerConfig.loop property
+
+> 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.
+> 
+
+Repeat playback when the media ends. Is used with the `vod` [playbackType](./player.playerconfig.playbacktype.md)
+
+**Signature:**
+
+```typescript
+loop?: boolean;
+```

package/docs/api/player.playerconfig.md

@@ -0,0 +1,266 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlayerConfig](./player.playerconfig.md)
+
+## PlayerConfig interface
+
+> 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.
+> 
+
+Configuration options for the player
+
+**Signature:**
+
+```typescript
+export interface PlayerConfig extends Record<string, unknown> 
+```
+**Extends:** Record&lt;string, unknown&gt;
+
+## Remarks
+
+You can specify multiple sources, each in two forms: just a plain URL or a full object with `source` and `mimeType` fields [PlayerMediaSource](./player.playermediasource.md)<!-- -->. The player will pick the first viable media source according to the source availability, and either the transport preference or standard transport selection order.
+
+`priorityTransport` is used to specify the preferred transport protocol when multiple sources are available. It will first try to use the transport specified if it's supported (by a playback engine) and the source is available. Otherwise it will try the other transports in the regular order (dash, hls, mpegts).
+
+The `autoPlay` option should be used together with the [mute](./player.playerconfig.mute.md) to avoid issues with the browsers' autoplay policies.
+
+Note that the `playbackType` is specified explicitly in the examle below, but a playback engine might be able to detect the type of the stream automatically.
+
+A plugin options can be specified in the configuration object under a unique key, typically corresponding to the plugin name. The plugin object will have access to the internal normalized configuration object that contains all the custom options. in the examle below, the `poster` field is the `Poster` plugin configuration options.
+
+## Example
+
+
+```ts
+{
+  autoPlay: true,
+  mute: true,
+  playbackType: 'live',
+  priorityTransport: 'dash',
+  sources: [{
+    source: 'https://example.com/myownair66.mpd',
+    mimeType: 'application/dash+xml',
+  }, {
+    source: 'https://example.com/myownair66.m3u8',
+    mimeType: 'application/x-mpegURL',
+  }],
+  poster: {
+    url: settings.poster,
+  },
+}
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[autoPlay?](./player.playerconfig.autoplay.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Start playback automatically when the player is ready
+
+
+</td></tr>
+<tr><td>
+
+[dash?](./player.playerconfig.dash.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[DashSettings](./player.dashsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Configuration settings for the DASH playback engine
+
+
+</td></tr>
+<tr><td>
+
+[debug?](./player.playerconfig.debug.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[PlayerDebugSettings](./player.playerdebugsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Controls the debug output level
+
+
+</td></tr>
+<tr><td>
+
+[language?](./player.playerconfig.language.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ A language code for the player UI, for example, `es`<!-- -->. Must reference a key in the [strings](./player.playerconfig.strings.md) record.
+
+
+</td></tr>
+<tr><td>
+
+[loop?](./player.playerconfig.loop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Repeat playback when the media ends. Is used with the `vod` [playbackType](./player.playerconfig.playbacktype.md)
+
+
+</td></tr>
+<tr><td>
+
+[mute?](./player.playerconfig.mute.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Mute the audio output in order to comply with browsers' autoplay policy.
+
+
+</td></tr>
+<tr><td>
+
+[playbackType?](./player.playerconfig.playbacktype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[PlaybackType](./player.playbacktype.md)
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ The type of playback (live stream or video on demand).
+
+
+</td></tr>
+<tr><td>
+
+[priorityTransport?](./player.playerconfig.prioritytransport.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[TransportPreference](./player.transportpreference.md)
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Preferred transport protocol when multiple sources are available.
+
+
+</td></tr>
+<tr><td>
+
+[sources](./player.playerconfig.sources.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[PlayerMediaSource](./player.playermediasource.md)<!-- -->\[\]
+
+
+</td><td>
+
+**_(BETA)_** List of media sources, at least one is required.
+
+
+</td></tr>
+<tr><td>
+
+[strings](./player.playerconfig.strings.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[TranslationSettings](./player.translationsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** Localization strings for the player UI.
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.playerconfig.mute.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; [PlayerConfig](./player.playerconfig.md) &gt; [mute](./player.playerconfig.mute.md)
+
+## PlayerConfig.mute property
+
+> 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.
+> 
+
+Mute the audio output in order to comply with browsers' autoplay policy.
+
+**Signature:**
+
+```typescript
+mute?: boolean;
+```

package/docs/api/player.playerconfig.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; [PlayerConfig](./player.playerconfig.md) &gt; [playbackType](./player.playerconfig.playbacktype.md)
+
+## PlayerConfig.playbackType property
+
+> 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 type of playback (live stream or video on demand).
+
+**Signature:**
+
+```typescript
+playbackType?: PlaybackType;
+```

package/docs/api/player.playerconfig.prioritytransport.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; [PlayerConfig](./player.playerconfig.md) &gt; [priorityTransport](./player.playerconfig.prioritytransport.md)
+
+## PlayerConfig.priorityTransport property
+
+> 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.
+> 
+
+Preferred transport protocol when multiple sources are available.
+
+**Signature:**
+
+```typescript
+priorityTransport?: TransportPreference;
+```

package/docs/api/player.playerconfig.sources.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; [PlayerConfig](./player.playerconfig.md) &gt; [sources](./player.playerconfig.sources.md)
+
+## PlayerConfig.sources property
+
+> 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.
+> 
+
+List of media sources, at least one is required.
+
+**Signature:**
+
+```typescript
+sources: PlayerMediaSource[];
+```

package/docs/api/player.playerconfig.strings.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; [PlayerConfig](./player.playerconfig.md) &gt; [strings](./player.playerconfig.strings.md)
+
+## PlayerConfig.strings property
+
+> 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.
+> 
+
+Localization strings for the player UI.
+
+**Signature:**
+
+```typescript
+strings: TranslationSettings;
+```

package/docs/api/player.playerdebugsettings.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; [PlayerDebugSettings](./player.playerdebugsettings.md)
+
+## PlayerDebugSettings 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 PlayerDebugSettings = PlayerDebugTag | boolean;
+```
+**References:** [PlayerDebugTag](./player.playerdebugtag.md)
+
+## Remarks
+
+true is equivalent to 'all', false is equivalent to 'none'
+

package/docs/api/player.playerdebugtag.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; [PlayerDebugTag](./player.playerdebugtag.md)
+
+## PlayerDebugTag 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 PlayerDebugTag = 'all' | 'clappr' | 'dash' | 'hls' | 'none';
+```

package/docs/api/player.playerevent.md

@@ -0,0 +1,116 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlayerEvent](./player.playerevent.md)
+
+## PlayerEvent enum
+
+> 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.
+> 
+
+A top-level event on the player object
+
+**Signature:**
+
+```typescript
+export declare enum PlayerEvent 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+Ended
+
+
+</td><td>
+
+`"ended"`
+
+
+</td><td>
+
+**_(BETA)_** Playback has reached the end of the media.
+
+
+</td></tr>
+<tr><td>
+
+Pause
+
+
+</td><td>
+
+`"pause"`
+
+
+</td><td>
+
+**_(BETA)_** Playback has been paused.
+
+
+</td></tr>
+<tr><td>
+
+Play
+
+
+</td><td>
+
+`"play"`
+
+
+</td><td>
+
+**_(BETA)_** Playback has started.
+
+
+</td></tr>
+<tr><td>
+
+Ready
+
+
+</td><td>
+
+`"ready"`
+
+
+</td><td>
+
+**_(BETA)_** The player is ready to use.
+
+
+</td></tr>
+<tr><td>
+
+Stop
+
+
+</td><td>
+
+`"stop"`
+
+
+</td><td>
+
+**_(BETA)_** Playback has been stopped.
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.playereventhandler.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlayerEventHandler](./player.playereventhandler.md)
+
+## PlayerEventHandler 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 PlayerEventHandler<T extends PlayerEvent> = () => void;
+```
+**References:** [PlayerEvent](./player.playerevent.md)
+