The audio profile of the xAPI was created to identify and standardize the common types of interactions that can be tracked in any audio player.
| Profile IRI | https://w3id.org/xapi/audio |
| See Also | https://github.com/johngriner91/xapi-authored-profiles |
| Author | xAPI Audio CoP |
| Concepts | 1 |
| Statement Templates | 7 |
| Patterns | 3 |
A recording of audio content.
| Type | ActivityType |
| IRI | https://w3id.org/xapi/audio/activity-type/audio |
| In Scheme | https://w3id.org/xapi/audio/v1.0 |
| Exact Match | http://activitystrea.ms/schema/1.0/audio |
The statement template and rules associated with audio content being initialized or started.
| IRI | https://w3id.org/xapi/audio/templates#initialized |
| Verb | http://adlnet.gov/expapi/verbs/initialized |
| Object Activity Type | https://w3id.org/xapi/audio/activity-type/audio |
$.id [included]$.timestamp [included]$.context.extensions['https://w3id.org/xapi/video/extensions/length'] [included]$.context.extensions['https://w3id.org/xapi/video/extensions/completion-threshold'] [recommended]$.context.extensions['https://w3id.org/xapi/video/extensions/volume'] [recommended]$.context.extensions['https://w3id.org/xapi/video/extensions/user-agent'] [recommended]$.context.extensions['https://w3id.org/xapi/video/extensions/speed'] [recommended]$.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]The statement template and rules associated with audio content being played.
| IRI | https://w3id.org/xapi/audio/templates#played |
| Verb | https://w3id.org/xapi/video/verbs/played |
| Object Activity Type | https://w3id.org/xapi/audio/activity-type/audio |
$.id [included]$.timestamp [included]$.result.extensions['https://w3id.org/xapi/video/extensions/time'] [included]$.result.extensions['https://w3id.org/xapi/video/extensions/played-segments'] [recommended]$.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]The statement template and rules associated with audio content being paused.
| IRI | https://w3id.org/xapi/audio/templates#paused |
| Verb | https://w3id.org/xapi/video/verbs/paused |
| Object Activity Type | https://w3id.org/xapi/audio/activity-type/audio |
$.id [included]$.timestamp [included]$.context.extensions['https://w3id.org/xapi/video/extensions/length'] [included]$.result.extensions['https://w3id.org/xapi/video/extensions/time'] [included]$.context.extensions['https://w3id.org/xapi/video/extensions/completion-threshold'] [recommended]$.result.extensions['https://w3id.org/xapi/video/extensions/played-segments'] [recommended]$.result.extensions['https://w3id.org/xapi/video/extensions/progress'] [recommended]$.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]The statement template and rules associated with the audio content seekbar being moved from and to a specific position.
| IRI | https://w3id.org/xapi/audio/templates#seeked |
| Verb | https://w3id.org/xapi/video/verbs/seeked |
| Object Activity Type | https://w3id.org/xapi/audio/activity-type/audio |
$.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]The statement template and rules associated with audio content being completed.
| IRI | https://w3id.org/xapi/audio/templates#completed |
| Verb | http://adlnet.gov/expapi/verbs/completed |
| Object Activity Type | https://w3id.org/xapi/audio/activity-type/audio |
$.id [included]$.timestamp [included]$.duration [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]$.context.extensions['https://w3id.org/xapi/video/extensions/completion-threshold'] [recommended]$.result.extensions['https://w3id.org/xapi/video/extensions/played-segments'] [recommended]$.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]The statement template and rules associated with a terminating the player.
| IRI | https://w3id.org/xapi/audio/templates#terminated |
| Verb | http://adlnet.gov/expapi/verbs/terminated |
| Object Activity Type | https://w3id.org/xapi/audio/activity-type/audio |
$.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]$.context.extensions['https://w3id.org/xapi/video/extensions/completion-threshold'] [recommended]$.result.extensions['https://w3id.org/xapi/video/extensions/played-segments'] [recommended]$.context.extensions['https://w3id.org/xapi/video/extensions/session-id'] [recommended]Volume Change Interaction
| IRI | https://w3id.org/xapi/audio/templates#volumechange |
| Verb | http://adlnet.gov/expapi/verbs/interacted |
| Object Activity Type | https://w3id.org/xapi/audio/activity-type/audio |
$.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]The general pattern and sequence of Statement templates using the Audio Profile.
| IRI | https://w3id.org/xapi/audio/patterns#generalpattern |
| Sequence | https://w3id.org/xapi/audio/templates#initializedhttps://w3id.org/xapi/audio/patterns#optionalmiddlestatementshttps://w3id.org/xapi/audio/templates#terminated |
All of the Audio Profile statement templates.
| IRI | https://w3id.org/xapi/audio/patterns#all-activities-pattern |
| Alternates | https://w3id.org/xapi/audio/templates#playedhttps://w3id.org/xapi/audio/templates#pausedhttps://w3id.org/xapi/audio/templates#seekedhttps://w3id.org/xapi/audio/templates#volumechangehttps://w3id.org/xapi/audio/templates#completed |
A combined pattern of zero or more Audio Profile standard statement templates that can be used with the general pattern.
| IRI | https://w3id.org/xapi/audio/patterns#optionalmiddlestatements |
| Zero Or More | https://w3id.org/xapi/audio/patterns#all-activities-pattern |