The video vocabulary of the xAPI was created to identify and standardize common video interactions that can be tracked. Note: Vocabulary terms that are not managed by the Video Community of Practice (CoP) and referenced from other vocabularies are higlighted in yellow .
Published by: xAPI Video CoP
Date Created: 2016-6-09
Last Modified: 2016-12-05
Enlish Label Description Scope Note ID (IRI) Related Match Closely Related Term Vocabulary
abandoned Used to express that the activity provider was able to deternmine that the session was terminated, however,a terminated statement was not received due to a failure. Any statement after this in the current video session is ignored. https://w3id.org/xapi/adl/verbs/abandoned https://w3id.org/xapi/adl
completed Used to express that the actor completed a video by watching all parts of the video at least once. http://adlnet.gov/expapi/verbs/completed https://w3id.org/xapi/adl
initialized This is usually the first statement in the video session. http://adlnet.gov/expapi/verbs/initialized https://w3id.org/xapi/adl
interacted Used to express that the actor interacted with the player (except play, pause, seek). e.g. mute, unmute, change resolution, change player size, etc. http://adlnet.gov/expapi/verbs/interacted https://w3id.org/xapi/adl
played Indicates that the actor started experiencing the recorded media object. Used when the actor generally played a video or clicked the play button. https://w3id.org/xapi/video/verbs/played closeMatch: http://activitystrea.ms/schema/1.0/play http://wordnet-rdf.princeton.edu/wn31/201721028-v https://w3id.org/xapi/video
paused Indicates that the actor temporary or permanently stopped experiencing the recorded media object. A paused statement must be sent before a terminated or abandoned statement if not already sent. https://w3id.org/xapi/video/verbs/paused closeMatch: http://id.tincanapi.com/verb/paused http://wordnet-rdf.princeton.edu/wn31/202647119-v https://w3id.org/xapi/video
seeked Indicates the actor changed the progress towards a specific point. Used in combination with time-from and time-to extensions when the Actor moves the progress bar forward or backward to a specific time in the video. https://w3id.org/xapi/video/verbs/seeked http://wordnet-rdf.princeton.edu/wn31/201843112-v https://w3id.org/xapi/video
terminated Used to express that the actor ended a video. Any statements after this in the current video session is ignored. http://adlnet.gov/expapi/verbs/terminated https://w3id.org/xapi/adl
Label Description Scope Note ID (IRI) Closely Related Term Vocabulary
video A recording of both the visual and audible components made available on a display screen. https://w3id.org/xapi/video/activity-type/video http://wordnet-rdf.princeton.edu/wn31/104541422-n https://w3id.org/xapi/video
Label Description Scope Note ID (IRI) Range Example Values
progress Used to expresses the percentage of media consumed by the actor. Value is a decimal between 0.0 and 1.0. https://w3id.org/xapi/video/extensions/progress
0.0
1.0
heat-map Heat map data showing parts of the video the actor watched during current registration in chronological order (e.g., 0.000[.]12.000[,]14.000[.]21.000[,]18.000[.]30.000). String Value. Each part of the video watched is separated with [,]. The 'Time From' and 'Time To' values are separated with [.]. The time values must match the values recorded as time, time-to and time-from in played, paused, seeked statements. https://w3id.org/xapi/video/extensions/heat-map xsd:string
time Used to express the time into the video. (e.g., “00000.000” in seconds and milliseconds). Float Value with maximum 3 decimals. Sent along with these verbs: Played, Paused, Terminated, Interacted, Completed (Required). https://w3id.org/xapi/video/extensions/time xsd:float 00000.000
time-from Used to identify the point in time the actor changed from in a media object (eg: “200.000” in seconds and milliseconds). Float Value with maximum 3 decimals. Required to be used exclusively with the verb "seeked." https://w3id.org/xapi/video/extensions/time-from xsd:float 200.000
time-to Used to identify the point in time the actor changed to in a media object (eg: “300.000” in seconds and milliseconds). Float Value with maximum 3 decimals. Required to be used exclusively with the verb "seeked." https://w3id.org/xapi/video/extensions/time-to xsd:float 300.000
Extension Description Scope Note ID (IRI) Range Example Values
cc-subtitle-enabled Used to expresses whether subtitle or closed captioning is enabled. Value is boolean as in true or false. https://w3id.org/xapi/video/extensions/cc-subtitle-enabled xsd:boolean true, false
cc-subtitle-lang Used to express the language of subtitle or closed captioning. Used only when cc-subtitle-enabled is true. The lexical and value spaces of xsd:language are the set of language codes defined by RFC 1766. https://w3id.org/xapi/video/extensions/cc-subtitle-lang xsd:language "en" for English or "en-US" for American English
frame-rate Used to express the frame rate or frames per second of a video (or average rate of frames per second in the case of variable frame-rate). Represented as a ratio of time base over frame duration, such as 30000/1001 or as a decimal, such as 29.970. https://w3id.org/xapi/video/extensions/frame-rate xsd:decimal 29.970
full-screen Used to expresses that the video is played in full screen mode. Value is boolean true or false. https://w3id.org/xapi/video/extensions/full-screen xsd:boolean true, false
quality Used to express the video quality. Integer Value (e.g., 360, 480, 720, 1080, etc.) https://w3id.org/xapi/video/extensions/quality xsd:integer 1080
screen-size Used to express the device playback screen size or the maximum available screensize for Video playback. Value WxH in pixels (e.g., 1080x960, 640x480, 800x600). https://w3id.org/xapi/video/extensions/screen-size xsd:string
session-id Used to tell which session the statement is part of. A session starts with the initiated statement and ends with terminated or abandoned statement. Value of session id has to be the UUID statement id of the initiated statement. https://w3id.org/xapi/video/extensions/session-id xsd:string
a49727a4-842c-11e6-ae22-56b6b6499611
speed Used to express the play-back speed (e.g., -2x, -1x, -0.5x, 0.5x, 1x, 2x). Float Value with an ‘x’ Negative = Rewind and Positive = Fast Forward https://w3id.org/xapi/video/extensions/speed xsd:string 1x
track Used to identify the name of the audio track in a media object. https://w3id.org/xapi/video/extensions/track xsd:string
user-agent Used to identify the User Agent string of the browser, if the video is launched in browser. https://w3id.org/xapi/video/extensions/user-agent xsd:string Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.116 Safari/537.36
volume Used to identify the loudness of sound specified for a media object. Volume Level (0 to 1). Float Value. Minimum 0 = Mute. Maximum 1 = 100% Volume https://w3id.org/xapi/video/extensions/volume
video-playback-size Used to identify the size in Width x Height of the video as viewed by the user Value WxH in pixels (e.g., 1080x960, 640x480, 800x600). https://w3id.org/xapi/video/extensions/video-playback-size xsd:string 1080x960