@flowplayer/spins 0.1.0-rc.9 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -30
- package/dist/index.js +19 -21
- package/dist/types.d.ts +55 -2
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -3,7 +3,6 @@ import { PlayerIMAConfig } from '@flowplayer/player/plugins/ads';
|
|
|
3
3
|
import { ConsentConfig } from '@flowplayer/player/plugins/consent';
|
|
4
4
|
import { ShareConfig } from '@flowplayer/player/plugins/share';
|
|
5
5
|
import { SubtitlesConfig } from '@flowplayer/player/plugins/subtitles';
|
|
6
|
-
import { ThumbnailsConfig } from '@flowplayer/player/plugins/thumbnails';
|
|
7
6
|
|
|
8
7
|
/**
|
|
9
8
|
* Emitted when a new spin is created.
|
|
@@ -20,20 +19,61 @@ declare const SPIN_IN_VIEWPORT = "spin:viewport";
|
|
|
20
19
|
declare const PlayerPlugins: readonly ["subtitles", "vtsel", "ads", "share", "thumbnails", "asel", "qsel"];
|
|
21
20
|
|
|
22
21
|
interface SpinsConfig {
|
|
22
|
+
/**
|
|
23
|
+
* The playlist value should either be a composite media ID with a playlist ID,
|
|
24
|
+
* or an array of SpinItem.
|
|
25
|
+
*
|
|
26
|
+
* @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/wowza-video-platform-integration/#add-composite-media-ids
|
|
27
|
+
* @see {@link SpinItem}
|
|
28
|
+
*/
|
|
23
29
|
playlist: string | Array<SpinItem>;
|
|
30
|
+
/**
|
|
31
|
+
* Sets the language of your preference.
|
|
32
|
+
* @default english
|
|
33
|
+
* @see https://developer.wowza.com/docs/wowza-flowplayer/player/translations/#configure-translations
|
|
34
|
+
*/
|
|
24
35
|
lang?: Config["lang"];
|
|
36
|
+
/**
|
|
37
|
+
* Your token.
|
|
38
|
+
* @see https://developer.wowza.com/docs/wowza-flowplayer/player/configure/#token-configuration
|
|
39
|
+
*/
|
|
25
40
|
token?: Config["token"];
|
|
41
|
+
/**
|
|
42
|
+
* User interface configuration
|
|
43
|
+
* @see https://developer.wowza.com/docs/wowza-flowplayer/player/configure/#user-interface-configuration
|
|
44
|
+
*/
|
|
26
45
|
ui?: Config["ui"];
|
|
46
|
+
/**
|
|
47
|
+
* Ads configuration
|
|
48
|
+
* @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/advertising/#ima-object-configuration
|
|
49
|
+
*/
|
|
27
50
|
ima?: PlayerIMAConfig;
|
|
51
|
+
/**
|
|
52
|
+
* Configuration for Share plugin
|
|
53
|
+
* @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/sharing/
|
|
54
|
+
*/
|
|
28
55
|
share?: ShareConfig["share"];
|
|
56
|
+
/**
|
|
57
|
+
* Consent plugin configuration. A bitmask property where the possible values can be found from `Consent.tracking` and `Consent.storage` enumerations.
|
|
58
|
+
* @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/consent/
|
|
59
|
+
*/
|
|
29
60
|
consent?: ConsentConfig["consent"];
|
|
30
61
|
/**
|
|
31
62
|
* A list of plugins to configure the player.
|
|
32
63
|
* @default ["subtitles", "vtsel", "ads", "share", "thumbnails", "asel"]
|
|
64
|
+
* @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/about-plugins/#plugin-descriptions
|
|
33
65
|
*/
|
|
34
66
|
plugins?: (typeof PlayerPlugins)[number][];
|
|
35
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* Describes an individual item used in a Spin playlist.
|
|
70
|
+
* @see {@link SpinsConfig.playlist}
|
|
71
|
+
*/
|
|
36
72
|
interface SpinItem {
|
|
73
|
+
/**
|
|
74
|
+
* The value should either be a media ID
|
|
75
|
+
* or a [Video source](https://developer.wowza.com/docs/wowza-flowplayer/player/configure#video-source)
|
|
76
|
+
*/
|
|
37
77
|
url: string | {
|
|
38
78
|
src: string;
|
|
39
79
|
type: string;
|
|
@@ -41,12 +81,25 @@ interface SpinItem {
|
|
|
41
81
|
title?: Config["title"];
|
|
42
82
|
poster?: Config["poster"];
|
|
43
83
|
description?: Config["description"];
|
|
84
|
+
/**
|
|
85
|
+
* Subtitles plugin configuration. Requires Subtitles plugin to be attached.
|
|
86
|
+
* @see https://developer.wowza.com/docs/wowza-flowplayer/plugins/html-subtitles/#configure-the-plugin
|
|
87
|
+
*/
|
|
44
88
|
subtitles?: SubtitlesConfig["subtitles"];
|
|
45
|
-
thumbnails?: ThumbnailsConfig["thumbnails"];
|
|
46
89
|
}
|
|
47
90
|
type SpinEventData = {
|
|
91
|
+
/**
|
|
92
|
+
* The SpinItem associated with the spin.
|
|
93
|
+
*/
|
|
48
94
|
config: SpinItem;
|
|
95
|
+
/**
|
|
96
|
+
* The spin container element
|
|
97
|
+
*/
|
|
49
98
|
spin: HTMLElement;
|
|
99
|
+
/**
|
|
100
|
+
* the index of the spin
|
|
101
|
+
*/
|
|
102
|
+
index: number;
|
|
50
103
|
};
|
|
51
104
|
interface SpinsContainer extends HTMLElement {
|
|
52
105
|
/**
|