About
The History module allows video portal users to access their watch history from the My History option in the user menu or header menu, or via https://{your_KMS_URL}/history. After enabling this module, you can configure the My History option in the headermenu module. For the My History user guide, visit our article My History.
Additionally, this module is used to enable the Resume Playback feature, displaying a progress bar below the video. This feature is applicable to both KMS and KAF applications.
Only the Resume Playback feature is available in KAF applications. The My History link is blocked in KAF applications.
Below is an example of a video portal user menu with the My History option.
Configure
- Go to your KMS Configuration Management console, and navigate to the History module. Your link should look like this: https://{your_KMS_URL}/admin/config/tab/history.
- Configure the following:
- videoEndPercent - Enter the percentage of the remaining playback to consider the video 'completely watched'. Reaching this percentage or higher will count as ‘finished watching’.
- videoEndSeconds - Enter the amount in seconds before the end of the video that will be considered as 'a completely watched video'. Reaching this amount of seconds or lower will count as ‘finished watching’.
- barColorBackground - Enter the hex code for the background color of the progress bar.
- barColorDone - Enter the hex code for the background color of the finished progress bar.
- emptyHistory - You can customize the message users see when reaching an empty History page by changing the text here. The default message is: 'Your feed is empty. But it doesn't have to be! Go to the Homepage or browse our Channels to fill your feed with amazing videos each and every day.
- deleteAllText - You can customize the message users see when clicking the 'Clear all History' button by changing the text here. The default message is: 'This will clear all your watch history, from other applications as well. Are you sure you want to clear your entire watch history? You can't undo this.'
- showUnlisted - Set to 'Yes' to show unlisted entries in the history.
- supportSecureEmbed - Set to 'Yes' to allow videos that are securely embedded to be added to history.
- addToHistoryTrigger - Choose the way videos are added to the user's history: 'Play' or 'View'.
'Play' = videos will be added with a play trigger (click on the Play button is needed if autoplay is not turned on).
'View' = videos will be added by landing on the video page. (Entries of type image will always be triggered by view event.) - Click Save.
The History module page displays.
enabled - Set to 'Yes' to enable the module.
resumePlayback - Set to 'Yes' to enable the resume playback feature. This feature displays an indicator bar below the video thumbnail, showing the progress. It allows both KMS and KAF users to resume watching from the last point viewed.
When set to 'Yes', the resumeplaybackOptions section opens:
