Embedded Player interaction API documentation
Adobe Learning Manager provides a library, which can be integrated into an app. This library provides various APIs to listen to events and trigger actions in the embedded player.
Using the APIs provided, you can play, pause, and perform other actions on the player.
Load the library
The library is available at this location.
To load the library, follow the steps below:
- Load the js file in the consumer application.
- On loading the library, window.cpPlayerLib will be populated.
The default values are:
- window.cpPlayerLib.env = https://learningmanager.adobe.com/app/player;
- window.cpPlayerLib.sourceOrigin = “https://cpcontents.adobe.com”;
Methods available
The cpPlayerLib library consists of the following functions:
startPlayer
Method Name | startPlayer |
Description | Loads a player in the app. |
Parameters |
|
Returns | Returns a promise. On resolution of the promise, a playerObj will be passed. |
Exception | The promise will result in an exception. |
Sample code | cpPlayerLib.startPlayer(loId, accountId, userId, accessToken, domRefId, onModuleLoaded).then((playerObj) => {//playerObj has the apis to interact with the player}) > |
getAllPlayers
Method name | getAllPlayers |
Description | Returns all player objects on the current page. |
Parameters | None |
Sample Code | cpPlayerLib.getAllPlayers() |
getPlayer
Method name | getPlayer |
Description | Returns a player object with the specified Learning Object id. |
Parameters |
|
Sample Code | cpPlayerLib.getPlayer(loId) |
navigateToModule
Method name | navigateToModule |
Description | Navigate to the next module. |
Parameters |
|
Sample Code | playerObj.navigateToModule(moduleID) |
next
Method name | next |
Description | Navigate to the next module. |
Parameters |
|
Sample Code | playerObj.next() |
previous
Method name | previous |
Description | Navigate to the previous module. |
Parameters |
|
Sample Code | playerObj.previous() |
toggleTOC
Method name | toggleTOC |
Description | Toggle the TOC panel on the player. |
Parameters |
|
Sample Code | playerObj.toggleTOC() |
toggleNotes
Method name | toggleNotes |
Description | Toggle the notes panel on the player. |
Parameters |
|
Sample Code | playerObj.toggleNotes() |
toggleClosedCaption
Method name | toggleClosedCaption |
Description | Toggle the display of closed captions on the player. |
Parameters |
|
Sample Code | playerObj.toggleClosedCaption() |
changeLanguage
Method name | changeLanguage |
Description | Change the content language on the player. |
Parameters |
|
Sample Code | playerObj.changeLanguage("es") |
closePlayer
Method name | closePlayer |
Description | Close the player and remove the player from the page. |
Parameters |
|
Sample Code | playerObj.closePlayer() |
togglePlayPause
Method name | togglePlayPause |
Description | Toggle between playing and pausing the content on the player. |
Parameters |
|
Sample Code | playerObj.togglePlayPause() |
setVolume
Method name | setVolume |
Description | Set the volume of the player. The value must be between 0 to 1. |
Parameters |
|
Sample Code | playerObj.setVolume(0.5) |
setPlayBackSpeed
Method name | setPlayBackSpeed |
Description | Set the speed of the playback in the player. |
Parameters |
|
Sample Code | playerObj.setPlayBackSpeed(1.25) |
seek
Method name | seek |
Description | Jump to any time on the video. |
Parameters |
|
Sample Code | playerObj.seek(50) |
forward
Method name | forward |
Description | Jump forward in the video by 10 seconds. |
Parameters |
|
Sample Code | playerObj.forward() |
backward
Method name | backward |
Description | Jump backward in the video by 10 seconds. |
Parameters |
|
Sample Code | playerObj.backward() |
navigateToPage
Method name | navigateToPage |
Description | Jump to the specified page on the PPT/PDF. |
Parameters |
|
Sample Code | playerObj.navigateToPage (5) |
nextPage
Method name | nextPage |
Description | Jump to the next page on the PPT/PDF. |
Parameters |
|
Sample Code | playerObj.nextPage() |
previousPage
Method name | previousPage |
Description | Jump to the previous page on the PPT/PDF. |
Parameters |
|
Sample Code | playerObj.previousPage() |
zoomIn
Method name | zoomIn |
Description | Zoom in on the content on a PPT/PDF. |
Parameters |
|
Sample Code | playerObj.zoomIn() |
zoomOut
Method name | zoomOut |
Description | Zoom out on the content on a PPT/PDF. |
Parameters |
|
Sample Code | playerObj.zoomOut() |
downloadJobAid
Method name | downloadJobAid |
Description | Download a Job Aid from a course. |
Parameters |
|
Sample Code | playerObj.downloadJobAid() |
toggleJobAidPullout
Method name | toggleJobAidPullout |
Description | Whether or not you want to download a job aid. |
Parameters |
|
Sample Code | playerObj.toggleJobAidPullout() |
fullScreen
Method name | fullScreen |
Description | Set player to full screen Mode. |
Parameters |
|
Sample Code | playerObj.fullScreen() |
List of events
onPlayerEvents(callBack)
On registering the callback function will be invoked on all player events. The event names are as follows:
- PLAY (Video/ Audio/ CP)
- PAUSE (Video/ Audio/ CP)
- TIMEUPDATE (Video/ Audio/ CP)
- PAGECHANGE (PPT/ PDF)
- NOTEADDED (All contents)
- LAUNCHED (All contents)
- STARTED (All contents)
- COMPLETED (All contents)
- PASSED (All contents)
- FAILED (All contents)
onStreamingEvents(callBack)
On registering the callback function will be invoked on all player statements that are sent for tracking user activity.
Learning Manager
- Learning Manager User Guide
- Introduction
- New features summary
- New features summary July 2024
- New features March 2024
- New features November 2023
- Release Notes
- System requirements
- ALM reference site package for AEM Sites
- Adobe Learning Manager App for Microsoft Teams
- Learning Manager compliance to GDPR
- Accessibility in Learning Manager
- Support for custom domain
- Recommendations in Adobe Learning Manager
- Transition from Adobe FTP Manager
- Supported languages in Adobe Learning Manager
- API deprecations and changes in Adobe Learning Manager
- Whitelabeling in Adobe Learning Manager
- Embedded Player interaction API documentation
- Get Started
- Administrator
- User log in
- Add users and create user groups
- Add classroom locations
- Create course instances and learning paths
- Content marketplace
- Reports
- Learning Paths
- Learning Plans
- Manage Learning Manager orders and billing
- Job Aids
- Certifications
- Catalogs
- Add users in bulk
- Impersonate a Learner and Manager
- Multiple SSO Logins
- Set up interface language through SAML
- Peer accounts
- Create and modify skills and levels
- AI-based recommendation of courses
- Import skills
- Gamification
- Customize learner homepage
- Badges
- Color themes
- Learner transcripts
- Waitlist & attendance management
- Fluidic player
- Announcements
- Email templates
- Adobe Connect integration
- Settings
- Notifications
- iPad & Android tablet users
- Purge users
- Tags
- Learning Manager Content Catalog
- Custom roles
- Catalog labels
- xAPI in Learning Manager
- Monitoring and moderating Social Learning as an admin
- Enable full control of shared catalog
- Map skill with skill domains
- Native extensibility
- Multiple enrollment
- Non-logged in experience for learners
- Learning Programs
- Product Terminology
- Integration Admin
- Migration manual
- Learning Manager Connectors
- Non-logged-in APIs
- Webhooks
- Credly
- Learning Tools Interoperability
- Integrate Learning Manager with AEM
- Install Salesforce package in Learning Manager
- Install Microsoft Teams connector
- Application developer manual
- Learning Manager App for Salesforce
- Settings
- Manage custom roles via CSV files
- Authors
- Instructor
- Learner
- Log in
- Profile Settings
- Catalogs
- My Learning
- Fluidic player
- Learning Programs
- Certifications
- Job Aids
- Multi item cart in ALM
- Badges
- Skills & Levels
- Gamification
- User notifications
- Announcements
- Waitlist & attendance management
- AI-powered search in Adobe Learning Manager
- Learning Manager app for Salesforce
- Adobe Connect integration
- Learner App for mobiles and tablets
- Social Learning in Learning Manager
- Adobe Learning Manager desktop application
- Learner home page
- Share to Social Learning
- System requirements | Adobe Learning Manager desktop application
- Manager
- Frequently Asked Questions
- Knowledge Base
- Unable to log in to Learning Manager
- Learning Summary does not display current data
- Unable to upload a CSV
- Generate a HAR file
- L1 feedback auto popup does not appear
- Unable to view certain courses under catalog while creating a Certification
- Unable to view certain course under catalog while creating a Learning Program
- Issues in retiring a Learning Program
- Unable to assign a badge
- Session expires in Learning Manager
- Unable to search a course
- Troubleshoot migration issues
- Troubleshoot Learning Manager app issues
- Users get auto deleted in Learning Manager
- Publishing issues in the EU domain
- Unable to register as external user
- Okta Active Directory integration with Adobe Learning Manager
- Unable to view learners in a course
- Unable to view calendar
- Module is not marked complete after completing a course
- Unable to achieve a skill after completing a course
- Radio buttons are missing
- Unable to view file submissions in Learning Manager