Skip to content

Commit

Permalink
fix(player): Fixed typos when creating event and added documentation …
Browse files Browse the repository at this point in the history 
…about it
  • Loading branch information
@rafa8626
rafa8626 committed Oct 21, 2019
1 parent 0563935 commit e180e46
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 23 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Expand Up @@ -106,8 +106,8 @@ var player = new OpenPlayer('[player ID]', [valid VAST/VPAID URL|List of VAST/VP
startTime,
// Allow loader to be displayed when loading video (by default, `false`)
showLoaderOnInit,
// Callback to be executed once an error is found (efault, `console.error`)
// Params passed: `CustomEvent` error event
// Callback to be executed once an error is found (default, `console.error`)
// Params passed: Custom event with `detail: { type: 'HTML5|Ads|M(PEG)-DASH|HLS', message, data },`
onError,
ads: {
// Custom path/URL to IMA SDK
Expand Down
24 changes: 13 additions & 11 deletions dist/openplayer.js
View file
Expand Up @@ -4909,7 +4909,7 @@ var Captions = function () {
type: 'captions'
}
};
var e = events_1.addEvent('settingremoved', Object.assign({}, details));
var e = events_1.addEvent('settingremoved', details);

_this.player.getElement().dispatchEvent(e);

Expand Down Expand Up @@ -7490,11 +7490,11 @@ var DashMedia = function (_native_1$default) {
if (event.type === 'error') {
var details = {
detail: {
type: "M(PEG)-DASH",
type: 'M(PEG)-DASH',
message: event
}
};
var errorEvent = events_1.addEvent('playererror', Object.assign({}, details));
var errorEvent = events_1.addEvent('playererror', details);
this.element.dispatchEvent(errorEvent);
} else {
var e = events_1.addEvent(event.type, event);
Expand Down Expand Up @@ -7768,16 +7768,18 @@ var HlsMedia = function (_native_1$default) {
if (event === 'hlsError') {
var errorDetails = {
detail: {
type: "HLS",
type: 'HLS',
message: data[1].details,
data: data
}
};
var errorEvent = events_1.addEvent('playererror', Object.assign({}, errorDetails));
var errorEvent = events_1.addEvent('playererror', errorDetails);
this.element.dispatchEvent(errorEvent);
data = data[1];

var type = data.type,
fatal = data.fatal,
var _data = data,
type = _data.type,
fatal = _data.fatal,
details = __rest(data, ["type", "fatal"]);

if (fatal) {
Expand Down Expand Up @@ -7972,12 +7974,12 @@ var HTML5Media = function (_native_1$default) {
element.addEventListener('error', function (e) {
var details = {
detail: {
type: "HTML5",
type: 'HTML5',
message: e.message,
data: e
}
};
var errorEvent = events_1.addEvent('playererror', Object.assign({}, details));
var errorEvent = events_1.addEvent('playererror', details);

_this.element.dispatchEvent(errorEvent);
});
Expand Down Expand Up @@ -8349,12 +8351,12 @@ var Ads = function () {
value: function _error(event) {
var details = {
detail: {
type: "Ads",
type: 'Ads',
message: event.getMessage(),
data: event.getError()
}
};
var errorEvent = events_1.addEvent('playererror', Object.assign({}, details));
var errorEvent = events_1.addEvent('playererror', details);
this.element.dispatchEvent(errorEvent);

if (Array.isArray(this.ads) && this.ads.length > 1 && this.currentAdsIndex <= this.ads.length) {
Expand Down
2 changes: 1 addition & 1 deletion dist/openplayer.min.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/js/controls/captions.ts
View file
Expand Up @@ -230,7 +230,7 @@ class Captions implements PlayerComponent {
type: 'captions',
},
};
const e = addEvent('settingremoved', { ...details });
const e = addEvent('settingremoved', details);
this.player.getElement().dispatchEvent(e);

setTimeout(() => {
Expand Down
4 changes: 2 additions & 2 deletions src/js/media/ads.ts
View file
Expand Up @@ -677,12 +677,12 @@ class Ads {
private _error(event: any): void {
const details = {
detail: {
type: `Ads`,
type: 'Ads',
message: event.getMessage(),
data: event.getError(),
},
};
const errorEvent = addEvent('playererror', { ...details });
const errorEvent = addEvent('playererror', details);
this.element.dispatchEvent(errorEvent);

if (Array.isArray(this.ads) && this.ads.length > 1 && this.currentAdsIndex <= this.ads.length) {
Expand Down
4 changes: 2 additions & 2 deletions src/js/media/dash.ts
View file
Expand Up @@ -166,11 +166,11 @@ class DashMedia extends Native {
if (event.type === 'error') {
const details = {
detail: {
type: `M(PEG)-DASH`,
type: 'M(PEG)-DASH',
message: event,
},
};
const errorEvent = addEvent('playererror', { ...details });
const errorEvent = addEvent('playererror', details);
this.element.dispatchEvent(errorEvent);
} else {
const e = addEvent(event.type, event);
Expand Down
5 changes: 3 additions & 2 deletions src/js/media/hls.ts
View file
Expand Up @@ -227,13 +227,14 @@ class HlsMedia extends Native {
if (event === 'hlsError') {
const errorDetails = {
detail: {
type: `HLS`,
type: 'HLS',
message: data[1].details,
data,
},
};
const errorEvent = addEvent('playererror', { ...errorDetails });
const errorEvent = addEvent('playererror', errorDetails);
this.element.dispatchEvent(errorEvent);
data = data[1];

// borrowed from https://video-dev.github.io/hls.js/demo
const { type, fatal, ...details } = data;
Expand Down
4 changes: 2 additions & 2 deletions src/js/media/html5.ts
View file
Expand Up @@ -27,12 +27,12 @@ class HTML5Media extends Native {
element.addEventListener('error', (e: any) => {
const details = {
detail: {
type: `HTML5`,
type: 'HTML5',
message: e.message,
data: e,
},
};
const errorEvent = addEvent('playererror', { ...details });
const errorEvent = addEvent('playererror', details);
this.element.dispatchEvent(errorEvent);
})
if (!isAudio(element) && !isVideo(element)) {
Expand Down

0 comments on commit e180e46

Please sign in to comment.