The purpose of this guide is to document the full list of events available to the Sizmek's Video Module used to track video interactions for Workspace video assets.
Video Module Associated Methods
|
Event Name |
Description and Usage |
|
StartVideoTimer |
Fired when the video starts playing to track video play duration. Ex: accepts two parameters - video asset and is fullscreen boolean EB.StartVideoTimer(theVideo.src, isFullScreen); |
|
StopVideoTimer |
Fire when video is not playing Ex: EB.StopVideoTimer(); |
Video Module Player Events
Use the EB.videoInteraction method to manually fire Player events. The EB.videoInteraction method accepts three parameters: EventName, LocalPath (of video source), and User Initiated (boolean).
|
Event Name |
Description and Usage |
|
FULLPLAY |
Fired when the video has reached the end To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.FULLPLAY, theVideo.src, isUserInitiated); |
|
FULLSCREEN_END |
Fired when the video asset plays to the end while in full screen mode To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.FULLSCREEN_END, theVideo.src, isUserInitiated); |
|
FULLSCREEN_MUTE |
Fired when the video asset is muted while in full screen mode To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.FULLSCREEN_MUTE, theVideo.src, isUserInitiated); |
|
FULLSCREEN_PAUSE |
Fired when the video asset is paused while in full screen mode To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.FULLSCREEN_PAUSE, theVideo.src, isUserInitiated); |
|
FULLSCREEN_START |
Fired when a video asset is started for the first time while in full screen mode To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.FULLSCREEN_START, theVideo.src, isUserInitiated); |
|
MUTE |
Fired when the video asset is muted To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.MUTE, theVideo.src, isUserInitiated); |
|
PAUSE |
Fired when the video asset is paused To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.PAUSE, theVideo.src, isUserInitiated); |
|
PERCENT_25_PLAYED |
Fired when the video asset has reached the first quartile To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.PERCENT_25_PLAYED, theVideo.src, isUserInitiated); |
|
PERCENT_50_PLAYED |
Fired when the video asset has reached the second quartile To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.PERCENT_50_PLAYED, theVideo.src, isUserInitiated); |
|
PERCENT_75_PLAYED |
Fired when the video asset has reached the third quartile To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.PERCENT_75_PLAYED, theVideo.src, isUserInitiated); |
|
REPLAY |
Fired when the video asset is played after the first full play To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.REPLAY, theVideo.src, isUserInitiated); |
|
SLIDER_DRAGGED |
Fired when the user has completed dragging the video play head to a new position To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.SLIDER_DRAGGED, theVideo.src, isUserInitiated); |
|
STARTED |
Fired when a new video asset is played for the first time To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.STARTED, theVideo.src, isUserInitiated); |
|
UNMUTE |
Fired when video is unmuted To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.UNMUTE, theVideo.src, isUserInitiated); |
|
UNMUTED |
Should be fired at the same time as the video started event if the video is not muted To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.UNMUTED, theVideo.src, isUserInitiated); |
|
USER_INITIATED_VIDEO |
Tracks whether the video was started by user. Note: this event is only tracked once per impression. To trigger event manually: EB.videoInteraction(EBG.VideoInteraction.USER_INITIATED_VIDEO, theVideo.src, isUserInitiated); |
Comments