Skip to content

Commit

Permalink
HFP-1779 Prevent triggering paused before seeked
Browse files Browse the repository at this point in the history
The current implementation of H5P.Video was not designed to track
the experience of the user or video state as perceived by the user.
This job is left to the content type using H5P.Video, which forces the
implementation of new xAPI verbs to be quirky. Also, it might not be
possible to get rid of some unneccesary xAPI statements that are
fired unless there's some refactoring which would also include e.g.
Interactive Video.
  • Loading branch information
otacke committed Apr 1, 2018
1 parent 5c1f995 commit 1f18bdb
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 15 deletions.
11 changes: 3 additions & 8 deletions scripts/html5.js
Original file line number Diff line number Diff line change
Expand Up @@ -188,13 +188,7 @@ H5P.VideoHtml5 = (function ($) {
}

if (arg === H5P.Video.PLAYING) {
if (self.seeking === true) {
extraArg = self.videoXAPI.getArgsXAPISeeked(self.seekedTo);
extraTrigger = 'seeked';
lastSend = 'seeked';
self.seeking = false;
}
else if (lastSend !== 'play') {
if (lastSend !== 'play') {
extraArg = self.videoXAPI.getArgsXAPIPlayed(video.currentTime);
extraTrigger = 'play';
lastSend = 'play';
Expand All @@ -203,7 +197,7 @@ H5P.VideoHtml5 = (function ($) {

if (arg === H5P.Video.PAUSED) {
// Put together extraArg for sending to xAPI statement.
if (!video.seeking && self.seeking === false && video.currentTime !== video.duration) {
if (!video.seeking && self.seeking === false && video.currentTime !== video.duration && self.previousState !== H5P.Video.BUFFERING) {
extraTrigger = 'paused';
extraArg = self.videoXAPI.getArgsXAPIPaused(video.currentTime, video.duration);
lastSend = 'paused';
Expand Down Expand Up @@ -300,6 +294,7 @@ H5P.VideoHtml5 = (function ($) {
arg = self.getPlaybackRate();
break;
}
self.previousState = arg;
self.trigger(h5p, arg);

// Make extra calls for events with needed values for xAPI statement.
Expand Down
24 changes: 22 additions & 2 deletions scripts/video.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,28 @@ H5P.Video = (function ($, ContentCopyrights, MediaCopyright, handlers) {
// Ref youtube.js - ipad & youtube - issue
self.pressToPlay = false;

// Values needed for xAPI triggering
// Values needed for xAPI triggering, set by handlers
self.previousTime = 0;
self.seeking = false;
self.seekedTo = 0;
self.duration = 0;
self.previousState = -1;
self.mousedown = false;

/*
* Used to distinguish seeking from pausing
* TODO: This might be much cleaner with refactoring IV, video and the handlers
*/
document.addEventListener('mousedown', function() {
self.mousedown = true;
});
document.addEventListener('mouseup', function() {
if (self.seeking) {
self.trigger('seeked', self.videoXAPI.getArgsXAPISeeked(self.seekedTo));
self.seeking = false;
}
self.mousedown = false;
});

// Initialize event inheritance
H5P.EventDispatcher.call(self);
Expand Down Expand Up @@ -147,7 +164,10 @@ H5P.Video = (function ($, ContentCopyrights, MediaCopyright, handlers) {
self.triggerXAPI('initialized', event.data);
});
self.on('paused', function (event) {
self.triggerXAPI('paused', event.data);
// if mouse button is down, we're seeking
if (self.mousedown === false) {
self.triggerXAPI('paused', event.data);
}
});

// Find player for video sources
Expand Down
7 changes: 2 additions & 5 deletions scripts/youtube.js
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,10 @@ H5P.VideoYouTube = (function ($) {
if (self.seeking === false) {
self.trigger('play', self.videoXAPI.getArgsXAPIPlayed(player.getCurrentTime()));
}
else {
self.trigger('seeked', self.videoXAPI.getArgsXAPISeeked(self.seekedTo));
self.seeking = false;
}
}
else if (state.data === 2) {
// This is a paused event.
if (self.seeking === false) {
if (self.seeking === false && self.previousState !== 3) {
self.trigger('paused', self.videoXAPI.getArgsXAPIPaused(player.getCurrentTime(), self.duration));
}
}
Expand All @@ -147,6 +143,7 @@ H5P.VideoYouTube = (function ($) {
}
}
}
self.previousState = state.data;
},
onPlaybackQualityChange: function (quality) {
self.trigger('qualityChange', quality.data);
Expand Down

0 comments on commit 1f18bdb

Please sign in to comment.