# Pdf Player

Please refer to the github readme document.

{% embed url="<https://github.com/project-sunbird/sunbird-pdf-player/tree/master#readme>" %}

* ### System Requirements <a href="#system-requirements" id="system-requirements"></a>

  To install Pdf player, ensure that your laptop or desktop has the following minimum system requirements:<br>

  * Operating System: Windows 7 and above, or 4.2 Mac OS X 10.0 and above/Linux
  * RAM: >1.5GB
  * CPU: 2 cores, >2 GHz<br>

  ### Configuration

  Player need some config that needs to be pass to the player as input , below listed out sample player config and mock player input config data<br>

  * Please check sample player config in below link\
    <https://github.com/project-sunbird/sunbird-pdf-player/tree/master#player-config><br>
  * Please check in below link for mock player input config data\
    <https://github.com/project-sunbird/sunbird-pdf-player/blob/master/src/app/data.ts><br>

  ### Sample code for references

  * **Web component** \
    Refer sample code for Web component  [here](https://github.com/project-sunbird/sunbird-pdf-player/blob/master/web-component/index.html)<br>
  * **Angular** \
    Refer sample code for Angular  [here](https://github.com/project-sunbird/sunbird-pdf-player)<br>

  ### How to set up

  * **As a  Web component** \
    For set up as web  component in plain javascript projects please follow the  [link](https://github.com/project-sunbird/sunbird-pdf-player/tree/release-5.2.0#use-as-web-components)<br>
  * **As a  Web component in angular app**\
    For set up as web  component in angular  projects please follow the  [link](https://github.com/project-sunbird/sunbird-pdf-player/tree/release-5.2.0#use-as-web-component--in-the-angular-app)<br>
  * **As a  Web component in mobile app**\
    For set up as web  component in mobile app  projects please follow the  [link](https://github.com/project-sunbird/sunbird-pdf-player/tree/release-5.2.0#use-as-web-component-in-mobile-app)<br>
  * **As a  Angular library in angular app**\
    For set up as angular library in angular  projects please follow the  [link](https://github.com/project-sunbird/sunbird-pdf-player/tree/release-5.2.0#use-as-angular-library-in-angular-app)<br>
  * **As a  Angular library in mobile app**\
    For set up as angular library in  mobile app projects please follow the  [link](https://github.com/project-sunbird/sunbird-pdf-player/tree/release-5.2.0#use-as-angular-library-in-mobile-app)<br>
  * **As a  Web component in react app**\
    For set up as web component in react app  projects please follow the  [link](https://github.com/Sunbird-Knowlg/knowlg-portal/tree/release-5.3.0/react-app#readme)<br>
  * **As a  Web component in flutter app**\
    For set up as web component in flutter app  projects please follow the  [link](https://github.com/Sunbird-Knowlg/knowlg-portal/tree/release-5.3.0/flutter_app#readme)<br>
  * **As a  Web component in react native app**\
    For set up as web component in react native app  projects please follow the  [link](https://github.com/Sunbird-Knowlg/knowlg-portal/tree/release-5.3.0/reactNative#readme)

  <br>

  ### External Dependencies

  #### [Sunbird Telemetry](https://telemetry.sunbird.org/)

  Sunbird Telemetry is a specification to instrument all the key events. Using this specification reference applications & services will generate telemetry events.

  #### <br>