Link copied to clipboard

Video Profile

Draft xAPI Profile · vv1.0.3 · May 10, 2019

The video profile of the xAPI was created to identify and standardize the common types of interactions that can be tracked in any video player.

Profile IRIhttps://w3id.org/xapi/video
See Alsohttps://github.com/liveaspankaj/xapi-video-cop
AuthorxAPI Video CoP
Concepts23
Statement Templates9
Patterns3
View JSON-LD Download Markdown Docs Log in to browse full details

Concepts (23)

paused

Indicates the actor paused the video being played at a specific point.

TypeVerb
IRIhttps://w3id.org/xapi/video/verbs/paused
In Schemehttps://w3id.org/xapi/video/v1.0.3
Exact Matchhttp://id.tincanapi.com/verb/paused

played

Indicates that the actor started experiencing the recorded media object.

TypeVerb
IRIhttps://w3id.org/xapi/video/verbs/played
In Schemehttps://w3id.org/xapi/video/v1.0.3
Exact Matchhttp://activitystrea.ms/schema/1.0/play

seeked

Indicates the actor changed the progress towards a specific point.

TypeVerb
IRIhttps://w3id.org/xapi/video/verbs/seeked
In Schemehttps://w3id.org/xapi/video/v1.0.3

video

A recording of both the visual and audible components made available on a display screen.

TypeActivityType
IRIhttps://w3id.org/xapi/video/activity-type/video
In Schemehttps://w3id.org/xapi/video/v1.0.3
Exact Matchhttp://activitystrea.ms/schema/1.0/video

completion-threshold

Used to specify the percentage of media that should be consumed to trigger a completion. Value MUST be between 0 and with maximum 3 decimals. If Completion Threshold is not included, it is assumed to be 1, i.e. 100%. If Completion Threshold is not 1, it MUST be included in Video Profile statements with these verbs: initialized, paused, completed, and terminated.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/completion-threshold
In Schemehttps://w3id.org/xapi/video/v1.0.3

cc-subtitle-enabled

Used to expresses whether subtitle or closed captioning is enabled.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/cc-subtitle-enabled
In Schemehttps://w3id.org/xapi/video/v1.0.3

cc-subtitle-lang

Used to express the language of subtitle or closed captioning. The lexical and value spaces of xsd:language are the set of language codes defined by RFC 5646. For example, 'en' for English or 'en-US' for American English.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/cc-subtitle-lang
In Schemehttps://w3id.org/xapi/video/v1.0.3

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).

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/frame-rate
In Schemehttps://w3id.org/xapi/video/v1.0.3

full-screen

Used to expresses that the video is played in full screen mode.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/full-screen
In Schemehttps://w3id.org/xapi/video/v1.0.3

length

The actual length of the media in seconds. Value MUST be a float value with maximum 3 decimals.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/length
In Schemehttps://w3id.org/xapi/video/v1.0.3

quality

Used to express the video resolution or quality. Integer Value (e.g., 360, 480, 720, 1080, etc.).

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/quality
In Schemehttps://w3id.org/xapi/video/v1.0.3

session-id

Used to provide the session identifier associated with the activity.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/session-id
In Schemehttps://w3id.org/xapi/video/v1.0.3

screen-size

Used to express the total available screen size for Video playback.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/screen-size
In Schemehttps://w3id.org/xapi/video/v1.0.3

speed

Used to express the play-back speed (e.g., 1x,2x,0,-1x,-2x).

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/speed
In Schemehttps://w3id.org/xapi/video/v1.0.3

track

Used to identify the name of the audio track in a media object.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/track
In Schemehttps://w3id.org/xapi/video/v1.0.3

user-agent

Used to identify the User Agent string of the browser, if the video is launched in browser.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/user-agent
In Schemehttps://w3id.org/xapi/video/v1.0.3

volume

Used to identify the loudness of sound specified for a media object.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/volume
In Schemehttps://w3id.org/xapi/video/v1.0.3

video-playback-size

Used to identify the current video size in Width x Height as viewed by the user.

TypeContextExtension
IRIhttps://w3id.org/xapi/video/extensions/video-playback-size
In Schemehttps://w3id.org/xapi/video/v1.0.3

played-segments

Played segments reveals potential heat map data for 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).

TypeResultExtension
IRIhttps://w3id.org/xapi/video/extensions/played-segments
In Schemehttps://w3id.org/xapi/video/v1.0.3

progress

Used to expresses the percentage of media consumed by the actor.

TypeResultExtension
IRIhttps://w3id.org/xapi/video/extensions/progress
In Schemehttps://w3id.org/xapi/video/v1.0.3

time

Used to express the time into the video. (e.g., “00000.000” in seconds and milliseconds).

TypeResultExtension
IRIhttps://w3id.org/xapi/video/extensions/time
In Schemehttps://w3id.org/xapi/video/v1.0.3

time-from

Used to identify the point in time the actor changed from in a media object (eg: “200.000” in seconds and milliseconds).

TypeResultExtension
IRIhttps://w3id.org/xapi/video/extensions/time-from
In Schemehttps://w3id.org/xapi/video/v1.0.3

time-to

Used to identify the point in time the actor changed to in a media object (eg: “300.000” in seconds and milliseconds).

TypeResultExtension
IRIhttps://w3id.org/xapi/video/extensions/time-to
In Schemehttps://w3id.org/xapi/video/v1.0.3

Statement Templates (9)

Initialized

The statement template and rules associated with a video being initialized or started.

IRIhttps://w3id.org/xapi/video/templates#initialized
Verbhttp://adlnet.gov/expapi/verbs/initialized
Rules:
  • $.id [included]
  • $.timestamp [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/length'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/cc-enabled'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/cc-subtitle-lang'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/frame-rate'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/full-screen'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/quality'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/screen-size'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/video-playback-size'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/speed'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/track'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/user-agent'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/volume'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/completion-threshold'] [recommended]

Played

The statement template and rules associated with a video being played.

IRIhttps://w3id.org/xapi/video/templates#played
Verbhttps://w3id.org/xapi/video/verbs/played
Object Activity Typehttps://w3id.org/xapi/video/activity-type/video
Rules:
  • $.id [included]
  • $.timestamp [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/time'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/length'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]

Paused

The statement template and rules associated with a video being paused.

IRIhttps://w3id.org/xapi/video/templates#paused
Verbhttps://w3id.org/xapi/video/verbs/paused
Object Activity Typehttps://w3id.org/xapi/video/activity-type/video
Rules:
  • $.id [included]
  • $.timestamp [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/length'] [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/time'] [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/progress'] [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/played-segments'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/completion-threshold'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]

Seeked

The statement template and rules associated with a video seekbar being moved from and to a specific position in the video.

IRIhttps://w3id.org/xapi/video/templates#seeked
Verbhttps://w3id.org/xapi/video/verbs/seeked
Object Activity Typehttps://w3id.org/xapi/video/activity-type/video
Rules:
  • $.id [included]
  • $.timestamp [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/time-to'] [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/time-from'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/length'] [recommended]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/progress'] [recommended]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/played-segments'] [recommended]

Completed

The statement template and rules associated with a video being completed.

IRIhttps://w3id.org/xapi/video/templates#completed
Verbhttp://adlnet.gov/expapi/verbs/completed
Object Activity Typehttps://w3id.org/xapi/video/activity-type/video
Rules:
  • $.id [included]
  • $.timestamp [included]
  • $.result.duration [included]
  • $.result.completion [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/length'] [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/time'] [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/progress'] [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/played-segments'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/completion-threshold'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]

Terminated

The statement template and rules associated with a terminating the player.

IRIhttps://w3id.org/xapi/video/templates#terminated
Verbhttp://adlnet.gov/expapi/verbs/terminated
Object Activity Typehttps://w3id.org/xapi/video/activity-type/video
Rules:
  • $.id [included]
  • $.timestamp [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/length'] [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/time'] [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/progress'] [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/played-segments'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/completion-threshold'] [recommended]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]

Enable Closed Captioning

Enable Closed Captioning

IRIhttps://w3id.org/xapi/video/templates#closed-captioning
Verbhttp://adlnet.gov/expapi/verbs/interacted
Object Activity Typehttps://w3id.org/xapi/video/activity-type/video
Rules:
  • $.id [included]
  • $.timestamp [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/time'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/cc-enabled'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/cc-subtitle-lang'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]

Volume Change Interaction

Volume Change Interaction

IRIhttps://w3id.org/xapi/video/templates#volumechange
Verbhttp://adlnet.gov/expapi/verbs/interacted
Object Activity Typehttps://w3id.org/xapi/video/activity-type/video
Rules:
  • $.id [included]
  • $.timestamp [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/time'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/volume'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]

Screen Change Interaction

Screen Change Interaction

IRIhttps://w3id.org/xapi/video/templates#screenchange
Verbhttp://adlnet.gov/expapi/verbs/interacted
Object Activity Typehttps://w3id.org/xapi/video/activity-type/video
Rules:
  • $.id [included]
  • $.timestamp [included]
  • $.result.extensions['https://w3id.org/xapi/video/extensions/time'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/full-screen'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/screen-size'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/video-playback-size'] [included]
  • $.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]

Patterns (3)

General Pattern Primary

The general pattern and sequence of Statement templates using the Video Profile.

IRIhttps://w3id.org/xapi/video/patterns#generalpattern
Sequencehttps://w3id.org/xapi/video/templates#initialized
https://w3id.org/xapi/video/patterns#optionalmiddlestatements
https://w3id.org/xapi/video/templates#terminated

All Activities Pattern

All of the Video Profile statement templates.

IRIhttps://w3id.org/xapi/video/patterns#all-activities-pattern
Alternateshttps://w3id.org/xapi/video/templates#played
https://w3id.org/xapi/video/templates#paused
https://w3id.org/xapi/video/templates#seeked
https://w3id.org/xapi/video/templates#volumechange
https://w3id.org/xapi/video/templates#screenchange
https://w3id.org/xapi/video/templates#closed-captioning
https://w3id.org/xapi/video/templates#completed

Optional Middle Statements

A combined pattern of zero or more Video Profile standard statement templates that can be used with the general pattern.

IRIhttps://w3id.org/xapi/video/patterns#optionalmiddlestatements
Zero Or Morehttps://w3id.org/xapi/video/patterns#all-activities-pattern