UNPKG

@project-sunbird/content-player-interface

Version:

It acts as an interface to access the content-player method

github.com/project-sunbird/sunbird-content-player

28 lines (13 loc) • 938 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# Content-Player-Interface Which provides an interface to [sunbird-content-player](https://www.npmjs.com/package/@project-sunbird/content-player) ## Setup Download content-player-interface as NPM > Run npm i @project-sunbird/content-player-interface ## Methods ```PI.getConfig()``` : Which return the content-player configurations. ```PI.EkstepRendererAPI```: Which return the content-player API methods. ```PI.getcontentMetadata(contentId, cb)```: Which return the metadata of the content. ```PI.exit()```: Which is used to exit the player (Useful in mobile, While playing contents in mobile if user wants to exit the player from mobile). ```PI.getTelemetryService```: Which returns the telemetry instance object, To generate an telemetry events. ```PI.isMobile```: Which return the Boolean, Which say's whether content/game is playing in mobile or web environment. ```PI.gotoEndPage``` Which shows the content endpage.