├── SUMMARY.md
├── overview.md
├── profile.md
├── references.md
├── GLOSSARY.md
├── README.md
├── templates.md
└── statement_data_model.md


/SUMMARY.md:
--------------------------------------------------------------------------------
 1 | # Summary
 2 | 
 3 | * [Introduction](README.md)
 4 | * [Summary](SUMMARY.md)
 5 | * [Overview](overview.md)
 6 | * [xAPI Statement Data Model](statement_data_model.md)
 7 | * [References](references.md)
 8 | * [Templates](templates.md)
 9 | * [Glossary](GLOSSARY.md)
10 | 
11 | 


--------------------------------------------------------------------------------
/overview.md:
--------------------------------------------------------------------------------
 1 | # Overview
 2 | 
 3 | This Video Profile built by xAPI Video Community of Practice describes Experience API Vocabulary to track Video consumption and explains how to use them.
 4 | 
 5 | ## Version
 6 | 
 7 | Current version is: xAPI Video Profile v1.0
 8 | 
 9 | ## History
10 | 
11 | | Date | Event |
12 | | :--- | :--- |
13 | | May 9th, 2019 | Version 1.0 |
14 | | Feb 4th, 2019 | Release Candidate 1 \(RC1\) |
15 | | Jan 21st, 2015 | First Meeting |
16 | 
17 | 
18 | 
19 | 


--------------------------------------------------------------------------------
/profile.md:
--------------------------------------------------------------------------------
 1 | #xAPI Video Profile
 2 | 
 3 | ---
 4 | 
 5 | ## Table of Contents
 6 | [__Revision History__](#revhistory)
 7 | * [__1.0 Overview__](#overview)
 8 |   * [1.1 Scope](#scope)
 9 | * [__2.0 References__](#references)
10 | * [__3.0 Definitions__](#definitions)
11 |   * [3.1 Abbreviations and Acronyms](#acronyms)
12 | * [__4.0 xAPI Statement Data Model__](#xapi_data_model)
13 |   * [4.1 Statement ID](#statement_id)
14 |   * [4.2 Actor](#actor)
15 |   * [4.3 Verbs](#verbs)
16 |   
17 | 


--------------------------------------------------------------------------------
/references.md:
--------------------------------------------------------------------------------
 1 | # References
 2 | 
 3 | The following referenced resources are indispensable for the application of this specification. 
 4 | 
 5 | * "Experience API", version 1.0.3, ADL<br>
 6 | https://github.com/adlnet/xAPI-Spec/blob/xAPI-1.0.3/xAPI.md
 7 | 
 8 | * Internationalized Resource Identifiers (IRIs): IRI Syntax January 2005<br>
 9 | https://www.ietf.org/rfc/rfc3987.txt
10 | 
11 | * The JSON Data Interchange Format<br>
12 |  http://json.org/
13 |  
14 | * RFC 5646 Language Tags<br>
15 | https://www.w3.org/International/articles/language-tags/
16 |  


--------------------------------------------------------------------------------
/GLOSSARY.md:
--------------------------------------------------------------------------------
 1 | # Glossary
 2 | 
 3 | ## ADL
 4 | 
 5 | Advanced Distributed Learning
 6 | 
 7 | ## API
 8 | 
 9 | Application Programming Interface. A set of rules and standards created to allow access into a software application or tool.
10 | 
11 | ## IRI
12 | 
13 | Internationalized Resource Identifier. A unique identifier which could be an IRL. Used to identify an object such as a verb, activity or activity type. Unlike URIs, IRIs can contain some characters outside of the ASCII character set in order to support international languages.
14 | 
15 | IRIs always include a scheme. This is not a requirement of this standard, but part of the definition of IRIs, per RFC 3987. What are sometimes called "relative IRIs" are not IRIs.
16 | 
17 | ## IRL
18 | 
19 | Internationalized Resource Locator. In the context of this document, an IRL is an IRI that when translated into a URI (per the IRI to URI rules), is a URL.
20 | 
21 | ## JSON
22 | 
23 | JavaScript Object Notation
24 | 
25 | ## LMS
26 | 
27 | Learning Management System.  "A software package used to administer one or more courses to one or more learners. An LMS is typically a web-based system that allows learners to authenticate themselves, register for courses, complete courses and take assessments" (Learning Systems Architecture Lab definition). An LMS in this document is used as an example of how a user is identified as "trusted" within a system and able to access its Learning Experiences.
28 | 
29 | ## LRP
30 | 
31 | Learning Record Provider. An xAPI Client that sends data to Learning Record Store\(s\). Often, the Learning Record Provider will create Learning Records while monitoring a learner as a part of a Learning Experience.
32 | 
33 | ## LRS
34 | 
35 | Learning Record Store. A server \(i.e. system capable of receiving and processing web requests\) that is responsible for receiving, storing, and providing access to Learning Records.
36 | 
37 | ## URI
38 | 
39 | Uniform Resource Identifier
40 | 
41 | ## URL
42 | 
43 | Uniform Resource Locator
44 | 
45 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # xAPI Video Community of Practice
  2 | 
  3 | This is an official ADL community to build a profile of the xAPI to identify and standardize video interactions that can be tracked. The profile is known as **xAPI Video Profile**. 
  4 | 
  5 | ## xAPI Video CoP Meetings
  6 | 
  7 | Meetings have been suspended since the release of xAPI Video Profile v1.0
  8 | 
  9 | For any questions, or to request for a meeting, please contact the Chair of the Group: 
 10 | 
 11 | **Pankaj Agrawal**
 12 | contact@pankajagrawal.com  
 13 | 
 14 | or raise a [GitHub ticket](https://github.com/liveaspankaj/xapi-video-cop/issues). 
 15 | 
 16 | Please visit the Wiki for details and Meeting Minutes:  
 17 | https://github.com/liveaspankaj/xapi-video-cop/wiki
 18 | 
 19 | ## xAPI Video CoP Google Group
 20 | 
 21 | * URL: https://groups.google.com/forum/#!members/xapi-video-cop
 22 | 
 23 | 
 24 | ## xAPI Video CoP Contributors 
 25 | 
 26 | <table cellspacing="0" cellpadding="0" dir="ltr" border="1" style="table-layout: fixed; font-size: 10pt; font-family: arial, sans, sans-serif; width: 0px; border-collapse: collapse; border: none;">
 27 |    <colgroup>
 28 |       <col width="243">
 29 |       <col width="309">
 30 |    </colgroup>
 31 |    <tbody>
 32 |       <tr style="font-weight:bold;">
 33 |          <td>Name</td>
 34 |          <td>Company</td>
 35 |       </tr>
 36 |       <tr>
 37 |          <td>Pankaj Agrawal</td>
 38 |          <td>Next Software Solutions</td>
 39 |       </tr>
 40 |       <tr>
 41 |          <td>Humera Shazia</td>
 42 |          <td>Next Software Solutions</td>
 43 |       </tr>
 44 |       <tr>
 45 |          <td>Jonathan Mark Kevan</td>
 46 |          <td>University of Hawaii at Manoa</td>
 47 |       </tr>
 48 |       <tr>
 49 |          <td>Jason Haag</td>
 50 |          <td>ADL &amp; Veracity</td>
 51 |       </tr>
 52 |       <tr>
 53 |          <td>Anthony Altieri</td>
 54 |          <td>RedCross</td>
 55 |       </tr>
 56 |       <tr>
 57 |          <td>Patrick Selby</td>
 58 |          <td>LexisNexis</td>
 59 |       </tr>
 60 |       <tr>
 61 |          <td>Mark Grant</td>
 62 |          <td></td>
 63 |       </tr>
 64 |       <tr>
 65 |          <td>Charles Touron</td>
 66 |          <td>US ARMY</td>
 67 |       </tr>
 68 |       <tr>
 69 |          <td>Craig Wiggins</td>
 70 |          <td>ADL</td>
 71 |       </tr>
 72 |       <tr>
 73 |          <td>Andy Johnson</td>
 74 |          <td>ADL</td>
 75 |       </tr>
 76 |       <tr>
 77 |          <td>Bill McDonald</td>
 78 |          <td>cmi5 working group leader</td>
 79 |       </tr>
 80 |       <tr>
 81 |          <td>Henry Ryng</td>
 82 |          <td>inXsol</td>
 83 |       </tr>
 84 |       <tr>
 85 |          <td>Adam Cooper</td>
 86 |          <td>Cetis, University of Bolton, UK</td>
 87 |       </tr>
 88 |       <tr>
 89 |          <td>Andrew Downes</td>
 90 |          <td>Rustici</td>
 91 |       </tr>
 92 |       <tr>
 93 |          <td>Christopher Thompson</td>
 94 |          <td></td>
 95 |       </tr>
 96 |       <tr>
 97 |          <td>Daniel Latourelle</td>
 98 |          <td></td>
 99 |       </tr>
100 |       <tr>
101 |          <td>Florian Tolk</td>
102 |          <td>ADL</td>
103 |       </tr>
104 |       <tr>
105 |          <td>Ingo Dahn</td>
106 |          <td>University of Koblenz-Landau</td>
107 |       </tr>
108 |       <tr>
109 |          <td>J Pablo Caballero</td>
110 |          <td>Acutilis s.l</td>
111 |       </tr>
112 |       <tr>
113 |          <td>Jeff Segall</td>
114 |          <td></td>
115 |       </tr>
116 |       <tr>
117 |          <td>Jessie Chuang</td>
118 |          <td>Classroom Aid Inc.</td>
119 |       </tr>
120 |       <tr>
121 |          <td>John Costa</td>
122 |          <td>IEEE ADB/RePubIT</td>
123 |       </tr>
124 |       <tr>
125 |          <td>Marko Grolo</td>
126 |          <td></td>
127 |       </tr>
128 |       <tr>
129 |          <td>Michael Stordeur</td>
130 |          <td>JDI Software</td>
131 |       </tr>
132 |       <tr>
133 |          <td>Trey Hayden</td>
134 |          <td>ADL</td>
135 |       </tr>
136 |       <tr>
137 |          <td>Vincent</td>
138 |          <td></td>
139 |       </tr>
140 |    </tbody>
141 | </table>
142 | 
143 | 
144 | ## xAPI Video Profile (current version)
145 | 
146 | **Current Version:** xAPI Video Profile v1.0
147 | 
148 | [Online Version](https://liveaspankaj.gitbooks.io/xapi-video-profile/content/SUMMARY.html) 
149 | 
150 | **Downloads:**  [PDF](https://www.gitbook.com/download/pdf/book/liveaspankaj/xapi-video-profile) | [Mobi](https://www.gitbook.com/download/mobi/book/liveaspankaj/xapi-video-profile) | [ePub](https://www.gitbook.com/download/epub/book/liveaspankaj/xapi-video-profile) 
151 | 
152 | ## License
153 | Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
154 | 
155 | Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License."
156 | 
157 | 
158 | 
159 | 


--------------------------------------------------------------------------------
/templates.md:
--------------------------------------------------------------------------------
  1 | # Statement Template Examples
  2 | 
  3 | The following example statements are provided for your convenience and conform to the video profile requirements.
  4 | 
  5 | ## Initialized
  6 | 
  7 | ```
  8 | {
  9 |     "actor": {
 10 |         "mbox": "mailto:jlh@example.com",
 11 |         "name": "Video User",
 12 |         "objectType": "Agent"
 13 |     },
 14 |     "verb": {
 15 |         "id": "http://adlnet.gov/expapi/verbs/initialized",
 16 |         "display": {
 17 |             "en-US": "initialized"
 18 |         }
 19 |     },
 20 |     "timestamp": "2018-08-07T15:27:52.365Z",
 21 |     "object": {
 22 |         "definition": {
 23 |             "type": "https://w3id.org/xapi/video/activity-type/video",
 24 |             "name": {
 25 |                 "en-US": "Ocean Life"
 26 |             },
 27 |             "description": {
 28 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
 29 |             }
 30 |         },
 31 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
 32 |         "objectType": "Activity"
 33 |     },
 34 |     "context": {
 35 |         "contextActivities": {
 36 |             "category": [
 37 |                 {
 38 |                     "id": "https://w3id.org/xapi/video"
 39 |                 }
 40 |             ]
 41 |         },
 42 |         "extensions": {
 43 |             "https://w3id.org/xapi/video/extensions/volume": 1,
 44 |             "https://w3id.org/xapi/video/extensions/video-playback-size": "640x264",
 45 |             "https://w3id.org/xapi/video/extensions/user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.84 Safari/537.36",
 46 |             "https://w3id.org/xapi/video/extensions/speed": "1x",
 47 |             "https://w3id.org/xapi/video/extensions/cc-subtitle-lang": "",
 48 |             "https://w3id.org/xapi/video/extensions/completion-threshold": "1.0",
 49 |             "https://w3id.org/xapi/video/extensions/session-id": "86c5b148-4462-4da9-a13f-b570c27fa049",
 50 |             "https://w3id.org/xapi/video/extensions/length": 46.613333,
 51 |             "https://w3id.org/xapi/video/extensions/quality": "960x400",
 52 |             "https://w3id.org/xapi/video/extensions/screen-size": "2560x1440",
 53 |             "https://w3id.org/xapi/video/extensions/frame-rate": "23.98",
 54 |             "https://w3id.org/xapi/video/extensions/cc-enabled": false,
 55 |             "https://w3id.org/xapi/video/extensions/full-screen": false
 56 |         },
 57 |         "registration": "96094a33-cc66-4d9a-8810-a0850ae2a4e1"
 58 |     },
 59 |     "id": "86c5b148-4462-4da9-a13f-b570c27fa049"
 60 | }
 61 | ```
 62 | 
 63 | ## Played
 64 | 
 65 | ```
 66 | {
 67 |     "actor": {
 68 |         "mbox": "mailto:jlh@example.com",
 69 |         "name": "Video User",
 70 |         "objectType": "Agent"
 71 |     },
 72 |     "verb": {
 73 |         "id": "https://w3id.org/xapi/video/verbs/played",
 74 |         "display": {
 75 |             "en-US": "played"
 76 |         }
 77 |     },
 78 |     "timestamp": "2018-08-07T15:27:52.376Z",
 79 |     "object": {
 80 |         "definition": {
 81 |             "type": "https://w3id.org/xapi/video/activity-type/video",
 82 |             "name": {
 83 |                 "en-US": "Ocean Life"
 84 |             },
 85 |             "description": {
 86 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
 87 |             }
 88 |         },
 89 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
 90 |         "objectType": "Activity"
 91 |     },
 92 |     "result": {
 93 |         "extensions": {
 94 |             "https://w3id.org/xapi/video/extensions/time": 0
 95 |         }
 96 |     },
 97 |     "context": {
 98 |         "contextActivities": {
 99 |             "category": [
100 |                 {
101 |                     "id": "https://w3id.org/xapi/video"
102 |                 }
103 |             ]
104 |         },
105 |         "extensions": {
106 |             "https://w3id.org/xapi/video/extensions/session-id": "86c5b148-4462-4da9-a13f-b570c27fa049",
107 |             "https://w3id.org/xapi/video/extensions/length": 46.613333
108 |         },
109 |         "registration": "96094a33-cc66-4d9a-8810-a0850ae2a4e1"
110 |     },
111 |     "id": "ac522d8a-ed56-4a5e-bc86-14067aec4101"
112 | }
113 | ```
114 | 
115 | ## Paused
116 | 
117 | ```
118 | {
119 |     "actor": {
120 |         "mbox": "mailto:jlh@example.com",
121 |         "name": "Video User",
122 |         "objectType": "Agent"
123 |     },
124 |     "verb": {
125 |         "id": "https://w3id.org/xapi/video/verbs/paused",
126 |         "display": {
127 |             "en-US": "paused"
128 |         }
129 |     },
130 |     "timestamp": "2018-08-07T15:27:55.273Z",
131 |     "object": {
132 |         "definition": {
133 |             "type": "https://w3id.org/xapi/video/activity-type/video",
134 |             "name": {
135 |                 "en-US": "Ocean Life"
136 |             },
137 |             "description": {
138 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
139 |             }
140 |         },
141 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
142 |         "objectType": "Activity"
143 |     },
144 |     "result": {
145 |         "extensions": {
146 |             "https://w3id.org/xapi/video/extensions/played-segments": "0[.]2.997",
147 |             "https://w3id.org/xapi/video/extensions/progress": 0.06,
148 |             "https://w3id.org/xapi/video/extensions/time": 2.997
149 |         }
150 |     },
151 |     "context": {
152 |         "contextActivities": {
153 |             "category": [
154 |                 {
155 |                     "id": "https://w3id.org/xapi/video"
156 |                 }
157 |             ]
158 |         },
159 |         "extensions": {
160 |             "https://w3id.org/xapi/video/extensions/session-id": "86c5b148-4462-4da9-a13f-b570c27fa049",
161 |             "https://w3id.org/xapi/video/extensions/length": 46.613333
162 |         },
163 |         "registration": "96094a33-cc66-4d9a-8810-a0850ae2a4e1"
164 |     },
165 |     "id": "587c8e19-3a5e-4be2-ba09-9c6b68c4fb20"
166 | }
167 | ```
168 | 
169 | ## Seeked \(Change Video Playback from 4.473 Seconds to 1.9 Seconds \)
170 | 
171 | ```
172 | {
173 |     "actor": {
174 |         "mbox": "mailto:jlh@example.com",
175 |         "name": "Video User",
176 |         "objectType": "Agent"
177 |     },
178 |     "verb": {
179 |         "id": "https://w3id.org/xapi/video/verbs/seeked",
180 |         "display": {
181 |             "en-US": "seeked"
182 |         }
183 |     },
184 |     "timestamp": "2018-08-07T15:37:53.491Z",
185 |     "object": {
186 |         "definition": {
187 |             "type": "https://w3id.org/xapi/video/activity-type/video",
188 |             "name": {
189 |                 "en-US": "Ocean Life"
190 |             },
191 |             "description": {
192 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
193 |             }
194 |         },
195 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
196 |         "objectType": "Activity"
197 |     },
198 |     "result": {
199 |         "extensions": {
200 |             "https://w3id.org/xapi/video/extensions/time-to": 1.9,
201 |             "https://w3id.org/xapi/video/extensions/time-from": 4.473
202 |         }
203 |     },
204 |     "context": {
205 |         "contextActivities": {
206 |             "category": [
207 |                 {
208 |                     "id": "https://w3id.org/xapi/video"
209 |                 }
210 |             ]
211 |         },
212 |         "extensions": {
213 |             "https://w3id.org/xapi/video/extensions/session-id": "86c5b148-4462-4da9-a13f-b570c27fa049"
214 |         },
215 |         "registration": "96094a33-cc66-4d9a-8810-a0850ae2a4e1"
216 |     },
217 |     "id": "4183175b-a6b0-4e59-8614-fd9c0d2593dd"
218 | }
219 | ```
220 | 
221 | ## Interacted Event \(Change to Full Screen\)
222 | 
223 | ```
224 | {
225 |     "actor": {
226 |         "mbox": "mailto:jlh@example.com",
227 |         "name": "Video User",
228 |         "objectType": "Agent"
229 |     },
230 |     "verb": {
231 |         "id": "http://adlnet.gov/expapi/verbs/interacted",
232 |         "display": {
233 |             "en-US": "interacted"
234 |         }
235 |     },
236 |     "timestamp": "2018-08-07T15:41:59.549Z",
237 |     "object": {
238 |         "definition": {
239 |             "type": "https://w3id.org/xapi/video/activity-type/video",
240 |             "name": {
241 |                 "en-US": "Ocean Life"
242 |             },
243 |             "description": {
244 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
245 |             }
246 |         },
247 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
248 |         "objectType": "Activity"
249 |     },
250 |     "result": {
251 |         "extensions": {
252 |             "https://w3id.org/xapi/video/extensions/time": 10.096
253 |         }
254 |     },
255 |     "context": {
256 |         "contextActivities": {
257 |             "category": [
258 |                 {
259 |                     "id": "https://w3id.org/xapi/video"
260 |                 }
261 |             ]
262 |         },
263 |         "extensions": {
264 |             "https://w3id.org/xapi/video/extensions/session-id": "86c5b148-4462-4da9-a13f-b570c27fa049",
265 |             "https://w3id.org/xapi/video/extensions/video-playback-size": "1122x1177",
266 |             "https://w3id.org/xapi/video/extensions/screen-size": "2560x1440",
267 |             "https://w3id.org/xapi/video/extensions/full-screen": true
268 |         },
269 |         "registration": "96094a33-cc66-4d9a-8810-a0850ae2a4e1"
270 |     },
271 |     "id": "abe55d73-ffb3-4093-ab1a-424592c119ee"
272 | }
273 | ```
274 | 
275 | ## Interacted Event \(Change Back to Original Screen Size\)
276 | 
277 | ```
278 | {
279 |     "actor": {
280 |         "mbox": "mailto:jlh@example.com",
281 |         "name": "Video User",
282 |         "objectType": "Agent"
283 |     },
284 |     "verb": {
285 |         "id": "http://adlnet.gov/expapi/verbs/interacted",
286 |         "display": {
287 |             "en-US": "interacted"
288 |         }
289 |     },
290 |     "timestamp": "2018-08-07T15:42:03.400Z",
291 |     "object": {
292 |         "definition": {
293 |             "type": "https://w3id.org/xapi/video/activity-type/video",
294 |             "name": {
295 |                 "en-US": "Ocean Life"
296 |             },
297 |             "description": {
298 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
299 |             }
300 |         },
301 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
302 |         "objectType": "Activity"
303 |     },
304 |     "result": {
305 |         "extensions": {
306 |             "https://w3id.org/xapi/video/extensions/time": 13.947
307 |         }
308 |     },
309 |     "context": {
310 |         "contextActivities": {
311 |             "category": [
312 |                 {
313 |                     "id": "https://w3id.org/xapi/video"
314 |                 }
315 |             ]
316 |         },
317 |         "extensions": {
318 |             "https://w3id.org/xapi/video/extensions/session-id": "86c5b148-4462-4da9-a13f-b570c27fa049",
319 |             "https://w3id.org/xapi/video/extensions/video-playback-size": "640x264",
320 |             "https://w3id.org/xapi/video/extensions/screen-size": "2560x1440",
321 |             "https://w3id.org/xapi/video/extensions/full-screen": false
322 |         },
323 |         "registration": "96094a33-cc66-4d9a-8810-a0850ae2a4e1"
324 |     },
325 |     "id": "c3371384-4598-43f2-b1b3-86be5df66ed5"
326 | }
327 | ```
328 | 
329 | ## Interacted Event \(Change Volume to Muted\)
330 | 
331 | ```
332 | {
333 |     "actor": {
334 |         "mbox": "mailto:jlh@example.com",
335 |         "name": "Video User",
336 |         "objectType": "Agent"
337 |     },
338 |     "verb": {
339 |         "id": "http://adlnet.gov/expapi/verbs/interacted",
340 |         "display": {
341 |             "en-US": "interacted"
342 |         }
343 |     },
344 |     "timestamp": "2018-08-07T15:42:12.016Z",
345 |     "object": {
346 |         "definition": {
347 |             "type": "https://w3id.org/xapi/video/activity-type/video",
348 |             "name": {
349 |                 "en-US": "Ocean Life"
350 |             },
351 |             "description": {
352 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
353 |             }
354 |         },
355 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
356 |         "objectType": "Activity"
357 |     },
358 |     "result": {
359 |         "extensions": {
360 |             "https://w3id.org/xapi/video/extensions/time": 20.536
361 |         }
362 |     },
363 |     "context": {
364 |         "contextActivities": {
365 |             "category": [
366 |                 {
367 |                     "id": "https://w3id.org/xapi/video"
368 |                 }
369 |             ]
370 |         },
371 |         "extensions": {
372 |             "https://w3id.org/xapi/video/extensions/volume": 0,
373 |             "https://w3id.org/xapi/video/extensions/session-id": "86c5b148-4462-4da9-a13f-b570c27fa049"
374 |         },
375 |         "registration": "96094a33-cc66-4d9a-8810-a0850ae2a4e1"
376 |     },
377 |     "id": "eb6ca563-1e61-4776-a5b0-2a23be8e43b0"
378 | }
379 | ```
380 | 
381 | ## Interacted Event \(Change Volume to Unmuted\)
382 | 
383 | ```
384 | {
385 |     "actor": {
386 |         "mbox": "mailto:jlh@example.com",
387 |         "name": "Video User",
388 |         "objectType": "Agent"
389 |     },
390 |     "verb": {
391 |         "id": "http://adlnet.gov/expapi/verbs/interacted",
392 |         "display": {
393 |             "en-US": "interacted"
394 |         }
395 |     },
396 |     "timestamp": "2018-08-07T15:42:15.443Z",
397 |     "object": {
398 |         "definition": {
399 |             "type": "https://w3id.org/xapi/video/activity-type/video",
400 |             "name": {
401 |                 "en-US": "Ocean Life"
402 |             },
403 |             "description": {
404 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
405 |             }
406 |         },
407 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
408 |         "objectType": "Activity"
409 |     },
410 |     "result": {
411 |         "extensions": {
412 |             "https://w3id.org/xapi/video/extensions/time": 24.036
413 |         }
414 |     },
415 |     "context": {
416 |         "contextActivities": {
417 |             "category": [
418 |                 {
419 |                     "id": "https://w3id.org/xapi/video"
420 |                 }
421 |             ]
422 |         },
423 |         "extensions": {
424 |             "https://w3id.org/xapi/video/extensions/volume": 1,
425 |             "https://w3id.org/xapi/video/extensions/session-id": "86c5b148-4462-4da9-a13f-b570c27fa049"
426 |         },
427 |         "registration": "96094a33-cc66-4d9a-8810-a0850ae2a4e1"
428 |     },
429 |     "id": "f48f70b2-505e-46ae-a562-19fcae19f2ae"
430 | }
431 | ```
432 | 
433 | ## Interacted \(Enabled Closed Captioning\)
434 | 
435 | ```
436 | {
437 |     "actor": {
438 |         "mbox": "mailto:jlh@example.com",
439 |         "name": "Video User",
440 |         "objectType": "Agent"
441 |     },
442 |     "verb": {
443 |         "id": "http://adlnet.gov/expapi/verbs/interacted",
444 |         "display": {
445 |             "en-US": "interacted"
446 |         }
447 |     },
448 |     "timestamp": "2018-08-07T15:42:20.066Z",
449 |     "object": {
450 |         "definition": {
451 |             "type": "https://w3id.org/xapi/video/activity-type/video",
452 |             "name": {
453 |                 "en-US": "Ocean Life"
454 |             },
455 |             "description": {
456 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
457 |             }
458 |         },
459 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
460 |         "objectType": "Activity"
461 |     },
462 |     "result": {
463 |         "extensions": {
464 |             "https://w3id.org/xapi/video/extensions/time": 28.799
465 |         }
466 |     },
467 |     "context": {
468 |         "contextActivities": {
469 |             "category": [
470 |                 {
471 |                     "id": "https://w3id.org/xapi/video"
472 |                 }
473 |             ]
474 |         },
475 |         "extensions": {
476 |             "https://w3id.org/xapi/video/extensions/session-id": "86c5b148-4462-4da9-a13f-b570c27fa049",
477 |             "https://w3id.org/xapi/video/extensions/cc-subtitle-lang": "en",
478 |             "https://w3id.org/xapi/video/extensions/cc-enabled": true
479 |         },
480 |         "registration": "96094a33-cc66-4d9a-8810-a0850ae2a4e1"
481 |     },
482 |     "id": "f71a5b62-53d5-4794-aa75-7e0dc2570eed"
483 | }
484 | ```
485 | 
486 | ## Completed
487 | 
488 | ```
489 | {
490 |     "actor": {
491 |         "mbox": "mailto:jlh@example.com",
492 |         "name": "Video User",
493 |         "objectType": "Agent"
494 |     },
495 |     "verb": {
496 |         "id": "http://adlnet.gov/expapi/verbs/completed",
497 |         "display": {
498 |             "en-US": "completed"
499 |         }
500 |     },
501 |     "timestamp": "2018-08-07T16:10:24.158Z",
502 |     "object": {
503 |         "definition": {
504 |             "type": "https://w3id.org/xapi/video/activity-type/video",
505 |             "name": {
506 |                 "en-US": "Ocean Life"
507 |             },
508 |             "description": {
509 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
510 |             }
511 |         },
512 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
513 |         "objectType": "Activity"
514 |     },
515 |     "result": {
516 |         "completion": true,
517 |         "extensions": {
518 |             "https://w3id.org/xapi/video/extensions/played-segments": "0[.]46.613",
519 |             "https://w3id.org/xapi/video/extensions/progress": 1,
520 |             "https://w3id.org/xapi/video/extensions/time": 46.613
521 |         }
522 |     },
523 |     "context": {
524 |         "contextActivities": {
525 |             "category": [
526 |                 {
527 |                     "id": "https://w3id.org/xapi/video"
528 |                 }
529 |             ]
530 |         },
531 |         "extensions": {
532 |             "https://w3id.org/xapi/video/extensions/session-id": "7a1f8a80-8b62-4cf5-9165-a4976280f6c4",
533 |             "https://w3id.org/xapi/video/extensions/completion-threshold": "1.0",
534 |             "https://w3id.org/xapi/video/extensions/length": 46.613333
535 |         },
536 |         "registration": "70ec479c-a37d-4407-89ad-9727313e71dc"
537 |     },
538 |     "id": "019b33ec-4426-40b7-b296-54f05cb9291e"
539 | }
540 | ```
541 | 
542 | ## Terminated
543 | 
544 | ```
545 | {
546 |     "actor": {
547 |         "mbox": "mailto:jlh@example.com",
548 |         "name": "Video User",
549 |         "objectType": "Agent"
550 |     },
551 |     "verb": {
552 |         "id": "http://adlnet.gov/expapi/verbs/terminated",
553 |         "display": {
554 |             "en-US": "terminated"
555 |         }
556 |     },
557 |     "timestamp": "2018-08-07T16:10:28.452Z",
558 |     "object": {
559 |         "definition": {
560 |             "type": "https://w3id.org/xapi/video/activity-type/video",
561 |             "name": {
562 |                 "en-US": "Ocean Life"
563 |             },
564 |             "description": {
565 |                 "en-US": "A short video clip of ocean lifeforms, used by videojs.com as part of their demo."
566 |             }
567 |         },
568 |         "id": "http://vjs.zencdn.net/v/oceans.mp4",
569 |         "objectType": "Activity"
570 |     },
571 |     "result": {
572 |         "extensions": {
573 |             "https://w3id.org/xapi/video/extensions/played-segments": "0[.]46.613",
574 |             "https://w3id.org/xapi/video/extensions/progress": 1,
575 |             "https://w3id.org/xapi/video/extensions/time": 46.613
576 |         }
577 |     },
578 |     "context": {
579 |         "contextActivities": {
580 |             "category": [
581 |                 {
582 |                     "id": "https://w3id.org/xapi/video"
583 |                 }
584 |             ]
585 |         },
586 |         "extensions": {
587 |             "https://w3id.org/xapi/video/extensions/session-id": "7a1f8a80-8b62-4cf5-9165-a4976280f6c4",
588 |             "https://w3id.org/xapi/video/extensions/completion-threshold": "1.0",
589 |             "https://w3id.org/xapi/video/extensions/length": 46.613333
590 |         },
591 |         "registration": "70ec479c-a37d-4407-89ad-9727313e71dc"
592 |     },
593 |     "id": "b3cd221b-cd2c-40cd-9291-e3fdcd1f4129"
594 | }
595 | ```
596 | 
597 | 
598 | 
599 | 


--------------------------------------------------------------------------------
/statement_data_model.md:
--------------------------------------------------------------------------------
  1 | <b>Current Version:</b> xAPI Video Profile v1.0
  2 | 
  3 | 
  4 | #2. xAPI Statement Data Model
  5 | 
  6 | 
  7 | ##2.1 Statement ID
  8 | 
  9 | The LRP MUST assign a statement id property in UUID format (as defined in the xAPI specification) for all statements it issues.
 10 | 
 11 | 
 12 | ##2.2 Actor
 13 | 
 14 | The Actor property must be defined as per the xAPI Specification. 
 15 | 
 16 | When the video is launched in an LMS, Actor must be provided by the LMS. 
 17 | 
 18 | ##2.3 Verbs
 19 | 
 20 | The following xAPI verbs are defined in this specification.
 21 | 
 22 | LRP MUST use the below verbs that are indicated as mandatory in other sections of this specification. 
 23 | 
 24 | <a name="verbs_initialized"></a>
 25 | ###2.3.1 Initialized
 26 | <table>
 27 | <tr><th align="left">Verb</th><td>Initialized</td></tr>
 28 | <tr><th align="left">ID</th><td>http://adlnet.gov/expapi/verbs/initialized</td></tr>
 29 | <tr><th align="left">Description</th><td>An "Initialized" statement is used by the LRP to indicate that the video has been fully initialized or launched.</td></tr>
 30 | <tr><th align="left" nowrap>LRP Obligations</th><td>The LRP MUST use "Initialized" in the first statement in the video session.  The LRP MUST NOT issue multiple statements with "Initialized" for the same video session.</td></tr>
 31 | <tr><th align="left">Usage</th><td>An "Initialized" statement is used by the LRP to indicate that the video has been fully initialized or launched.</td></tr>
 32 | </table>
 33 | 
 34 | 
 35 | <a name="verbs_played"></a>
 36 | ###2.3.2 Played
 37 | <table>
 38 | <tr><th align="left">Verb</th><td>Played</td></tr>
 39 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/verbs/played</td></tr>
 40 | <tr><th align="left">Description</th><td>Indicates that the actor started experiencing the recorded media object.</td></tr>
 41 | <tr><th align="left" nowrap>LRP Obligations</th><td>The LRP MUST use "Played" when the actor starts experiencing the media.</td></tr>
 42 | <tr><th align="left">Usage</th><td>Used when the actor generally played a video or clicked the play button.</td></tr>
 43 | </table>
 44 | 
 45 | <a name="verbs_paused"></a>
 46 | ###2.3.3 Paused
 47 | <table>
 48 | <tr><th align="left">Verb</th><td>Paused</td></tr>
 49 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/verbs/paused</td></tr>
 50 | <tr><th align="left">Description</th><td>Indicates that the actor temporary or permanently stopped experiencing the recorded media object.</td></tr>
 51 | <tr><th align="left" nowrap>LRP Obligations</th><td>The LRP MUST use "Paused" when the media is stopped. A paused statement MUST be sent before a terminated statement if not already sent.</td></tr>
 52 | <tr><th align="left">Usage</th><td>Indicates that the actor temporary or permanently stopped experiencing the recorded media object.</td></tr>
 53 | </table>
 54 | 
 55 | <a name="verbs_seeked"></a>
 56 | ###2.3.4 Seeked
 57 | <table>
 58 | <tr><th align="left">Verb</th><td>Seeked</td></tr>
 59 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/verbs/seeked</td></tr>
 60 | <tr><th align="left">Description</th><td>Indicates the actor changed the progress towards a specific point.</td></tr>
 61 | <tr><th align="left" nowrap>LRP Obligations</th><td>The LRP MUST use "Seeked" when the Actor moves the progress bar forward or backward to a specific time in video.</td></tr>
 62 | <tr><th align="left">Usage</th><td>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.</td></tr>
 63 | </table>
 64 | 
 65 | <a name="verbs_interacted"></a>
 66 | ###2.3.5 Interacted
 67 | <table>
 68 | <tr><th align="left">Verb</th><td>Interacted</td></tr>
 69 | <tr><th align="left">ID</th><td>http://adlnet.gov/expapi/verbs/interacted</td></tr>
 70 | <tr><th align="left">Description</th><td>Used to express that the actor interacted with the player (except play, pause, seek). e.g. mute, unmute, change resolution, change player size, etc.</td></tr>
 71 | <tr><th align="left" nowrap>LRP Obligations</th><td>Optional</td></tr>
 72 | <tr><th align="left">Usage</th><td>Used to express that the actor interacted with the player (except play, pause, seek). e.g. mute, unmute, change resolution, change player size, etc.</td></tr>
 73 | </table>
 74 | 
 75 | 
 76 | <a name="verbs_completed"></a>
 77 | ###2.3.6 Completed
 78 | <table>
 79 | <tr><th align="left">Verb</th><td>Completed</td></tr>
 80 | <tr><th align="left">ID</th><td>http://adlnet.gov/expapi/verbs/completed</td></tr>
 81 | <tr><th align="left">Description</th><td>Used to express that the actor completed a video by watching all parts of the video at least once.</td></tr>
 82 | <tr><th align="left" nowrap>LRP Obligations</th><td>The LRP MUST use "Completed" when the Actor has completed a video by watching all parts of the video at least once.<br>
 83 | The "completion" property of the result MUST be set to true for this statement.<br>
 84 | The "duration" property of the result MUST be included in this statement and MUST represent total time spent during consuming the video under current registration. e.g. PT218S
 85 | 
 86 | </td></tr>
 87 | <tr><th align="left">Usage</th><td>Used to express that the actor completed a video by watching all parts of the video at least once. The progress and heatmap result extension can be used to calculate the duration and completion of video.</td></tr>
 88 | </table>
 89 | 
 90 | <a name="verbs_terminated"></a>
 91 | ###2.3.7 Terminated
 92 | <table>
 93 | <tr><th align="left">Verb</th><td>Terminated</td></tr>
 94 | <tr><th align="left">ID</th><td>http://adlnet.gov/expapi/verbs/terminated</td></tr>
 95 | <tr><th align="left">Description</th><td>Used to express that the actor ended a video.</td></tr>
 96 | <tr><th align="left" nowrap>LRP Obligations</th><td>Optional. 
 97 | <ul>
 98 | <li>The LRP MAY use "Terminated" when the Actor has terminated the video. </li>
 99 | <li>A "Paused" statement MUST be sent before "Terminated" statement if not already sent.</li>
100 | <li>Any statements after this in the current video session MUST NOT be sent, and will be ignored if sent.</li>
101 | </ul>
102 | 
103 | </ul>
104 | </td></tr>
105 | <tr><th align="left">Usage</th><td>Used to express that the actor ended a video. </td></tr>
106 | </table>
107 | 
108 | ##2.4 Object
109 | 
110 | An Object with objectType "Activity" MUST be present, as specified in the xAPI Spec.
111 | 
112 | The Object represents the video or media being consumed by the Actor.  
113 | 
114 | ###2.4.1 Definition
115 | 
116 | Object definition MAY contain name, description and other details of the media, as per the xAPI Spec. 
117 | 
118 | Object definition MUST be present and MUST contain activity "type" as: https://w3id.org/xapi/video/activity-type/video
119 | 
120 | 
121 | 
122 | ##2.5 Result
123 | 
124 | Result is an optional property that represents a measured outcome related to the Statement in which it is included.
125 | 
126 | It may be present in a statement depending on the verb used.
127 | 
128 | ###2.5.1 Score
129 | 
130 | A score is not required to be reported. If a score is reported, it must be as per the xAPI Spec. 
131 | 
132 | 
133 | ###2.5.2 Completion
134 | 
135 | The "completion" property of the result MUST be set to true for the 'completed' statement. 
136 | 
137 | Other Video Profile statements MUST NOT include the "completion" property.
138 | 
139 | ###2.5.3 Duration
140 | 
141 | The "duration" property is an ISO 8601 formatted time value. 
142 | 
143 | Duration MUST be included in "completed" statement and MUST represent total time spent consuming the video under current registration. e.g. PT218S
144 | 
145 | ###2.5.4 Result Extensions
146 | 
147 | There are several additional results related values defined in Video Profile that can be added to the statement under result extensions. 
148 | 
149 | ###2.5.4.1 Time
150 | 
151 | <table>
152 | <tr><th align="left">Extension</th><td>time
153 | </td></tr>
154 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/time</td></tr>
155 | <tr><th align="left">Description</th><td>Used to express the time into the video.</td></tr>
156 | <tr><th align="left" nowrap>LRP Obligations</th><td>
157 | <ul>
158 | <li>The LRP MUST assign time value to statements with "played", "paused", "terminated", "interacted" and "completed" verbs.</li>
159 | <li>Float Value with maximum 3 decimals.</li>
160 | </ul>
161 | 
162 | </td></tr>
163 | <tr><th align="left">Usage</th><td>Example: "23.560" represents video position at 23 seconds and 560 milliseconds.</td></tr>
164 | </table>
165 | 
166 | ###2.5.4.2 Time From
167 | 
168 | <table>
169 | <tr><th align="left">Extension</th><td>time-from
170 | </td></tr>
171 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/time-from</td></tr>
172 | <tr><th align="left">Description</th><td>Used to identify the point in time the actor changed from in a media object during a seek operation.</td></tr>
173 | <tr><th align="left" nowrap>LRP Obligations</th><td>
174 | <ul>
175 | <li>The LRP MUST assign time-from value to statements with "seeked" verbs only.</li>
176 | <li>Float Value with maximum 3 decimals.</li>
177 | </ul>
178 | 
179 | </td></tr>
180 | <tr><th align="left">Usage</th><td>Example: "23.560" represents video position at 23 seconds and 560 milliseconds.</td></tr>
181 | </table>
182 | 
183 | ###2.5.4.3 Time To
184 | 
185 | <table>
186 | <tr><th align="left">Extension</th><td>time-to
187 | </td></tr>
188 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/time-to</td></tr>
189 | <tr><th align="left">Description</th><td>Used to identify the point in time the actor changed to in a media object during a seek operation.</td></tr>
190 | <tr><th align="left" nowrap>LRP Obligations</th><td>
191 | <ul>
192 | <li>The LRP MUST assign time-to value to statements with "seeked" verbs only.</li>
193 | <li>Float Value with maximum 3 decimals.</li>
194 | </ul>
195 | 
196 | </td></tr>
197 | <tr><th align="left">Usage</th><td>Example: "23.560" represents video position at 23 seconds and 560 milliseconds.</td></tr>
198 | </table>
199 | 
200 | 
201 | ###2.5.4.4 Progress
202 | 
203 | <table>
204 | <tr><th align="left">Extension</th><td>progress
205 | </td></tr>
206 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/progress</td></tr>
207 | <tr><th align="left">Description</th><td>Used to expresses the percentage of media consumed by the actor.</td></tr>
208 | <tr><th align="left" nowrap>LRP Obligations</th><td>
209 | <ul>
210 | <li>The LRP MUST assign progress value to statements with "paused", "terminated" and "completed" verbs.</li>
211 | <li>The LRP MAY assign progress value to other statements.</li>
212 | <li>Float value between 0 and 1, with a maximum of 3 decimals.</li>
213 | </ul>
214 | 
215 | </td></tr>
216 | <tr><th align="left">Usage</th><td>The progress value includes all attempts made during the current registration. The heatmap extension can be used to calculate the progress.</td></tr>
217 | </table>
218 | 
219 | ###2.5.4.5 Played Segments
220 | 
221 | 
222 | <table>
223 | <tr><th align="left">Extension</th><td>played-segments
224 | </td></tr>
225 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/played-segments
226 | </td></tr>
227 | <tr><th align="left">Description</th><td>Played segments
228 |  data shows parts of the video the actor watched during current registration in chronological order.</td></tr>
229 | <tr><th align="left" nowrap>LRP Obligations</th><td>
230 | <ul>
231 | <li>The LRP MUST assign played-segments value to statements with "paused", "terminated" and "completed" verbs.</li>
232 | <li>The LRP MAY assign played-segments value to other statements.</li>
233 | <li>Value is a string. Each part of the video watched is separated with [,]. The 'Time From' and 'Time To' values are separated with [.].</li> 
234 | <li>The time values must match the values recorded as time, time-to and time-from in played, paused, seeked statements.</li>
235 | </ul>
236 | 
237 | </td></tr>
238 | <tr><th align="left">Usage</th><td>The played-segments value includes all attempts made during the current registration. It is used for computing the progress and completion. It can also be used to generate heat map of the users consumption of the video. 
239 | <br/>Example:  0.000[.]12.000[,]14.000[.]21.000[,]18.000[.]30.000</td>
240 | </td>
241 | </tr>
242 | </table>
243 | 
244 | 
245 | ##2.6 Context
246 | 
247 | All Video Profile statements MUST contain a context that includes all objects/values as defined in this section.  
248 | 
249 | ###2.6.1 Registration
250 | 
251 | The value for the registration property used in the context object MAY be the value provided by the LMS via the launch URL. If registration is not provided via the launch mechanism, the LRP MAY set a fixed registration value.
252 | 
253 | The registration value is important because the "progress", the "played-segments" value and "completion" is based on aggregate of all attempts with same registration value attempted by the Actor for the specific media.
254 | 
255 | ###2.6.2 Language
256 | 
257 | Code representing the language in which the experience being recorded in this Statement (mainly) occurred in, if applicable and known. 
258 | 
259 | Language is used to provide the spoken language for the audio.
260 | 
261 | The value must be RFC 5646, e.g en, en-US, etc
262 | 
263 | ###2.6.2 Context Extensions
264 | 
265 | ####2.6.2.1 Session ID
266 | 
267 | <table>
268 | <tr><th align="left">Extension</th><td>session-id
269 | </td></tr>
270 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/session-id</td></tr>
271 | <tr><th align="left">Description</th><td>Used to tell which session the statement is part of. A session starts with the initiated statement and ends with terminated statement.</td></tr>
272 | <tr><th align="left" nowrap>LRP Obligations</th><td>
273 | <ul>
274 | <li>The LRP SHOULD assign a session id to all the statements sent during a session.</li>
275 | <li>Value of session id MUST be the UUID statement id of the initiated statement, i.e. the initialized statement. </li>
276 | </ul>
277 | 
278 | </td></tr>
279 | <tr><th align="left">Usage</th><td></td></tr>
280 | </table>
281 | 
282 | 
283 | ###2.6.2.2 CC/Subtitle Enabled
284 | 
285 | <table>
286 | <tr><th align="left">Extension</th><td>cc-subtitle-enabled
287 | </td></tr>
288 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/cc-subtitle-enabled</td></tr>
289 | <tr><th align="left">Description</th><td>Used to expresses whether subtitle or closed captioning is enabled.</td></tr>
290 | <tr><th align="left" nowrap>LRP Obligations</th><td>
291 | <ul>
292 | <li>Value MUST be boolean i.e. true or false.	</li>
293 | </ul>
294 | 
295 | </td></tr>
296 | <tr><th align="left">Usage</th><td></td></tr>
297 | </table>
298 | 
299 | 
300 | ###2.6.2.3 CC/Subtitle Language
301 | <table>
302 | <tr><th align="left">Extension</th><td>cc-subtitle-lang
303 | </td></tr>
304 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/cc-subtitle-lang</td></tr>
305 | <tr><th align="left">Description</th><td>Used to express the language of subtitle or closed captioning.</td></tr>
306 | <tr><th align="left" nowrap>LRP Obligations</th><td>
307 | <ul>
308 | <li>Used only when cc-subtitle-enabled is true.</li>
309 | </ul>
310 | 
311 | </td></tr>
312 | <tr><th align="left">Usage</th><td>The lexical and value spaces of xsd:language are the set of language codes defined by RFC 5646. Examples: "en" for English or "en-US" for American English
313 | </td></tr>
314 | </table>
315 | 
316 | ###2.6.2.4 Frame Rate
317 | 
318 | <table>
319 | <tr><th align="left">Extension</th><td>frame-rate
320 | </td></tr>
321 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/frame-rate</td></tr>
322 | <tr><th align="left">Description</th><td>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).</td></tr>
323 | <tr><th align="left" nowrap>LRP Obligations</th><td>
324 | </td></tr>
325 | <tr><th align="left">Usage</th><td>Represented as a decimal, such as 29.970.</td></tr>
326 | </table>
327 | 
328 | ###2.6.2.5 Full Screen
329 | 
330 | <table>
331 | <tr><th align="left">Extension</th><td>full-screen
332 | </td></tr>
333 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/full-screen</td></tr>
334 | <tr><th align="left">Description</th><td>Used to expresses that the video is played in full screen mode.</td></tr>
335 | <tr><th align="left" nowrap>LRP Obligations</th><td>
336 | <ul>
337 | <li>Value MUST be boolean i.e. true or false.	</li>
338 | </ul>
339 | 
340 | </td></tr>
341 | <tr><th align="left">Usage</th><td></td></tr>
342 | </table>
343 |  
344 | 
345 | ###2.6.2.6 Quality
346 | 
347 | <table>
348 | <tr><th align="left">Extension</th><td>quality
349 | </td></tr>
350 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/quality</td></tr>
351 | <tr><th align="left">Description</th><td>Used to express the video resolution or quality.</td></tr>
352 | <tr><th align="left" nowrap>LRP Obligations</th><td>
353 | <ul>
354 | <li>Value is a string. e.g. 360, 480, 720, 1080, 2160, sd, hd, 4k, 8k etc.</li>
355 | </ul>
356 | </td></tr>
357 | <tr><th align="left">Usage</th><td></td></tr>
358 | </table>
359 | 
360 | ###2.6.2.7 Screen Size	
361 | 
362 | <table>
363 | <tr><th align="left">Extension</th><td>screen-size
364 | </td></tr>
365 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/screen-size</td></tr>
366 | <tr><th align="left">Description</th><td>Used to express the device playback screen size or the maximum available screen size for Video playback.</td></tr>
367 | <tr><th align="left" nowrap>LRP Obligations</th><td>
368 | <ul>
369 | <li>Value MUST be in WxH format in pixels. e.g. 1080x960, 640x480, 800x600</li>
370 | </ul>
371 | </td></tr>
372 | <tr><th align="left">Usage</th><td></td></tr>
373 | </table>
374 | 
375 | ###2.6.2.8 Video Playback Size
376 | 
377 | <table>
378 | <tr><th align="left">Extension</th><td>video-playback-size
379 | </td></tr>
380 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/video-playback-size</td></tr>
381 | <tr><th align="left">Description</th><td>Used to identify the size in Width x Height of the video as viewed by the user.</td></tr>
382 | <tr><th align="left" nowrap>LRP Obligations</th><td>
383 | <ul>
384 | <li>Value MUST be in WxH format in pixels. e.g. 1080x960, 640x480, 800x600</li>
385 | </ul>
386 | </td></tr>
387 | <tr><th align="left">Usage</th><td></td></tr>
388 | </table>
389 | 
390 | ###2.6.2.9 Speed
391 | 
392 | <table>
393 | <tr><th align="left">Extension</th><td>speed
394 | </td></tr>
395 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/speed</td></tr>
396 | <tr><th align="left">Description</th><td>Used to express the play-back speed.</td></tr>
397 | <tr><th align="left" nowrap>LRP Obligations</th><td>
398 | <ul>
399 | <li>Value MUST be represented with decimal or integer values along with an 'x' meaning multiplying factor to the normal speed. e.g. -2x, -1x, -0.5x, 0.5x, 1x, 2x.</li>
400 | </ul>
401 | </td></tr>
402 | <tr><th align="left">Usage</th><td>
403 | <ul>
404 | <li>Negative value means rewind. e.g. -1x, -2x</li>
405 | <li>Positive value with value greater than 1x means fast forward. e.g. 1.5x, 2x, 4x</li>
406 | <li>Positive value with value less than 1x means slow motion play back. e.g. 0.5x, 0.25x, 0.125x</li>
407 | </ul>
408 | </td></tr>
409 | </table>
410 | 
411 | 
412 | ###2.6.2.10 Track
413 | 
414 | <table>
415 | <tr><th align="left">Extension</th><td>track
416 | </td></tr>
417 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/track</td></tr>
418 | <tr><th align="left">Description</th><td>Used to identify the name of the audio track in a media object.</td></tr>
419 | <tr><th align="left" nowrap>LRP Obligations</th><td>
420 | <ul>
421 | <li>Value MUST be a string.</li>
422 | </ul>
423 | </td></tr>
424 | <tr><th align="left">Usage</th><td></td></tr>
425 | </table>
426 | 
427 | ###2.6.2.11 User Agent
428 | 
429 | <table>
430 | <tr><th align="left">Extension</th><td>user-agent
431 | </td></tr>
432 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/user-agent</td></tr>
433 | <tr><th align="left">Description</th><td>Used to identify the User Agent string of the browser, if the video is launched in browser.</td></tr>
434 | <tr><th align="left" nowrap>LRP Obligations</th><td>
435 | <ul>
436 | <li>Value MUST be a string.</li>
437 | </ul>
438 | </td></tr>
439 | <tr><th align="left">Usage</th><td></td></tr>
440 | </table>
441 | 
442 | ###2.6.2.12 Volume
443 | 
444 | <table>
445 | <tr><th align="left">Extension</th><td>volume
446 | </td></tr>
447 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/volume</td></tr>
448 | <tr><th align="left">Description</th><td>Used to identify the loudness of sound specified for a media object.</td></tr>
449 | <tr><th align="left" nowrap>LRP Obligations</th><td>
450 | <ul>
451 | <li>Value MUST be a float value between 0 and 1. </li>
452 | </ul>
453 | </td></tr>
454 | <tr><th align="left">Usage</th><td>Minimum 0 = Mute. Maximum 1 = 100% Volume</td></tr>
455 | </table>
456 | 
457 | ###2.6.2.13 Length
458 | 
459 | <table>
460 | <tr><th align="left">Extension</th><td>length
461 | </td></tr>
462 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/length</td></tr>
463 | <tr><th align="left">Description</th><td>The actual length of the media in seconds.</td></tr>
464 | <tr><th align="left" nowrap>LRP Obligations</th><td>
465 | <ul>
466 | <li>Value MUST be a float value with maximum 3 decimals. </li>
467 | <li>It MUST be included in Video Profile statements with these verbs: initialized, completed, terminated and paused. </li>
468 | </ul>
469 | </td></tr>
470 | <tr><th align="left">Usage</th><td></td></tr>
471 | </table>
472 | 
473 | ###2.6.2.14 Completion Threshold
474 | 
475 | <table>
476 | <tr><th align="left">Extension</th><td>completion-threshold
477 | </td></tr>
478 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video/extensions/completion-threshold</td></tr>
479 | <tr><th align="left">Description</th><td>Completion Threshold specifies the percentage of media that should be consumed to trigger a completion.</td></tr>
480 | <tr><th align="left" nowrap>LRP Obligations</th><td>
481 | <ul>
482 | <li>Value MUST be between 0 and 1. </li>
483 | <li>Value MUST be a float value with maximum 3 decimals. </li>
484 | <li>If Completion Threshold is not included, it is assumed to be 1, i.e. 100%. </li>
485 | <li>If Completion Threshold is not 1, it MUST be included in Video Profile statements with these verbs: initialized, completed, terminated and paused. </li>
486 | 
487 | </ul>
488 | </td></tr>
489 | <tr><th align="left">Usage</th><td></td></tr>
490 | </table>
491 | 
492 | 
493 | ###2.6.2 Context Activities
494 | 
495 | ####2.6.2.1 Category
496 | 
497 | <table>
498 | <tr><th align="left">ID</th><td>https://w3id.org/xapi/video</td></tr>
499 | <tr><th align="left">Description</th><td>xAPI Video Profile statement</td></tr>
500 | <tr><th align="left" nowrap>LRP Obligations</th><td>Must.
501 | </td></tr>
502 | <tr><th align="left">Usage</th><td>Identifies a statement as conforming to the xAPI Video Profile</td></tr>
503 | </table>
504 | 
505 | ###2.7 Summary of Extensions Usage
506 | <table>
507 | <tr><th align="left" width="16%">Verbs</th><th width="42%">Required</th><th width="42%">Optional</th></tr>
508 | 
509 | 
510 | <tr>
511 | <th align="left">Initialized</th>
512 | <td>
513 | <b>Context Extensions</b>
514 | <ul>
515 | <li>Length</li>
516 | <li>Completion Threshold (if value < 1)</li>
517 | </ul>
518 | </td>
519 | 
520 | <td>
521 | <b>Context Extensions
522 | </b>
523 | <ul>
524 | <li>Session ID</li>
525 | <li>CC/Subtitle Enabled</li>
526 | <li>CC/Subtitle Language</li>
527 | <li>Frame Rate</li>
528 | <li>Full Screen</li>
529 | <li>Quality</li>
530 | <li>Screen Size</li>
531 | <li>Video Playback Size</li>
532 | <li>Speed</li>
533 | <li>Track</li>
534 | <li>User Agent</li>
535 | <li>Volume</li>
536 | <li>Completion Threshold (if value = 1)</li>
537 | </ul>
538 | </td>
539 | 
540 | </tr>
541 | 
542 | 
543 | 
544 | <tr>
545 | <th align="left">Played</th>
546 | <td>
547 | 
548 | <b>Result Extensions</b>
549 | <ul>
550 | <li>Time</li>
551 | </ul>
552 | </td>
553 | 
554 | <td>
555 | 
556 | <b>Context Extensions</b>
557 | <ul>
558 | <li>Session ID</li>
559 | </ul>
560 | <br>
561 | 
562 | </td>
563 | 
564 | </tr>
565 | 
566 | 
567 | 
568 | <tr>
569 | <th align="left">Paused</th>
570 | <td>
571 | <b>Context Extensions</b>
572 | <ul>
573 | <li>Length</li>
574 | <li>Completion Threshold (if value < 1)</li>
575 | </ul>
576 | <br>
577 | <b>Result Extensions</b>
578 | <ul>
579 | <li>Time</li>
580 | <li>Progress</li>
581 | <li>Played Segments</li>
582 | </ul>
583 | </td>
584 | 
585 | <td>
586 | <b>Context Extensions</b>
587 | <ul>
588 | <li>Session ID</li>
589 | <li>Completion Threshold (if value = 1)</li>
590 | </ul>
591 | <br>
592 | 
593 | </td>
594 | 
595 | </tr>
596 | 
597 | 
598 | 
599 | <tr>
600 | <th align="left">Seeked</th>
601 | <td>
602 | 
603 | <b>Result Extensions</b>
604 | <ul>
605 | <li>Time From</li>
606 | <li>Time To</li>
607 | </ul>
608 | </td>
609 | 
610 | <td>
611 | <b>Context Extensions</b>
612 | <ul>
613 | <li>Length</li>
614 | <li>Session ID</li>
615 | </ul>
616 | <br>
617 | 
618 | <b>Result Extensions</b>
619 | <ul>
620 | <li>Progress</li>
621 | <li>Played Segments</li>
622 | </ul>
623 | </td>
624 | </td>
625 | 
626 | </tr>
627 | 
628 | 
629 | <tr>
630 | <th align="left">Interacted</th>
631 | <td>
632 | 
633 | <b>Context Extensions</b>
634 | <ul>
635 | <li>Context Extensions for which the value has changed during interaction MUST be included</li>
636 | </ul>
637 | <br>
638 | <b>Result Extensions</b>
639 | <ul>
640 | <li>Time</li>
641 | </ul>
642 | 
643 | </td>
644 | 
645 | 
646 | <td>
647 | <b>Context Extensions
648 | </b>
649 | <ul>
650 | <li>Session ID</li>
651 | <li>CC/Subtitle Enabled</li>
652 | <li>CC/Subtitle Language</li>
653 | <li>Frame Rate</li>
654 | <li>Full Screen</li>
655 | <li>Quality</li>
656 | <li>Video Playback Size</li>
657 | <li>Speed</li>
658 | <li>Track</li>
659 | <li>Volume</li>
660 | </ul>
661 | </td>
662 | 
663 | </tr>
664 |   
665 | 
666 | <tr>
667 | <th align="left">Completed</th>
668 | <td>
669 | <b>Context Extensions</b>
670 | <ul>
671 | <li>Length</li>
672 | <li>Completion Threshold (if value < 1)</li>
673 | </ul>
674 | <br>
675 | 
676 | 
677 | <b>Result Extensions</b>
678 | <ul>
679 | <li>Time</li>
680 | <li>Progress</li>
681 | <li>Played Segments</li>
682 | </ul>
683 | <b>Others</b>
684 | <ul>
685 | <li>result.completion = true</li>
686 | <li>result.duration = (total time spent consuming the video under current registration)</total></li>
687 | </ul>
688 |   
689 | </td>
690 | 
691 | <td>
692 | <b>Context Extensions</b>
693 | <ul>
694 | <li>Session ID</li>
695 | <li>Completion Threshold (if value = 1)</li>
696 | </ul>
697 | <br>
698 | 
699 | </td>
700 | 
701 | </tr>
702 | 
703 | 
704 | <tr>
705 | <th align="left">Terminated</th>
706 | <td>
707 | <b>Context Extensions</b>
708 | <ul>
709 | <li>Length</li>
710 | <li>Completion Threshold (if value < 1)</li>
711 | </ul>
712 | <br>
713 | 
714 | <b>Result Extensions</b>
715 | <ul>
716 | <li>Time</li>
717 | <li>Progress</li>
718 | <li>Played Segments</li>
719 | </ul>
720 | 
721 |   
722 | </td>
723 | 
724 | <td>
725 | <b>Context Extensions</b>
726 | <ul>
727 | <li>Session ID</li>
728 | <li>Completion Threshold (if value = 1)</li>
729 | </ul>
730 | <br>
731 | 
732 | </td>
733 | 
734 | </tr>
735 |   
736 | </table>
737 | 
738 | *Session ID is optional. However, it SHOULD be added in all statements, unless there is a reason not to. 
739 | 
740 | 


--------------------------------------------------------------------------------