About
The xAPI module sends learning activity data from Kaltura to a Learning Record Store (LRS) that supports xAPI (Tin Can). To see which xAPI events Kaltura sends, refer to the xAPI Analytics Guide.
Configure
1. Go to your Configuration Management page, and click on the Xapi module. You can also navigate directly using a link: https://{your_site_URL}/admin/config/tab/xapi.
The 'Xapi' page displays.
2. Configure the following:
enabled - Set to 'Yes' to enable the module.
endpoint - Enter the xAPI (Tin Can) endpoint provided by your LRS.
usePersonalOAuthToken - Set to Yes to authenticate using an OAuth 2.0 bearer token.
key - Enter the xAPI app key from your LRS.
secret - Enter the xAPI app secret from your LRS.
sendAccountInfoInsteadOfEmail - Choose how users are identified in xAPI events:
- 'No' – Sends the user’s email address. If the email isn’t available, the user ID and site are sent instead.
- 'Yes' – Sends only the user ID and site.
videoEndPercent - Sets when a video is counted as finished. If the viewer reaches this percentage or more, the video is marked as complete. Default: 100
videoEndSeconds - Sets when a video is counted as finished based on time remaining. If the viewer reaches this many seconds or less before the end, the video is marked as complete. Default: 0
beaconInterval - Controls how often playback progress is reported:
- Quarters – Sends updates at 0%, 25%, 50%, 75%, and 100%.
- One percent – Sends updates every 1% of the video, with a minimum and maximum interval of 1–30 seconds.
Player V2 supports quarters only.
3. Click Save.
