{"id":28500681,"url":"https://github.com/kaltura/playkit-js-dash","last_synced_at":"2025-07-31T17:08:09.687Z","repository":{"id":23935716,"uuid":"83971573","full_name":"kaltura/playkit-js-dash","owner":"kaltura","description":"Shaka Player Adapter for the PlayKit JS Player","archived":false,"fork":false,"pushed_at":"2025-05-22T12:07:57.000Z","size":2211,"stargazers_count":9,"open_issues_count":27,"forks_count":3,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-06-08T15:07:31.951Z","etag":null,"topics":["dash","es6","flow-typed","kaltura","playkit","playkit-js","playkit-js-player","shaka-player"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kaltura.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-03-05T13:22:31.000Z","updated_at":"2025-05-22T12:08:00.000Z","dependencies_parsed_at":"2024-05-22T16:39:39.577Z","dependency_job_id":"0311d56e-a709-4fe0-b817-82643878bd43","html_url":"https://github.com/kaltura/playkit-js-dash","commit_stats":{"total_commits":320,"total_committers":18,"mean_commits":17.77777777777778,"dds":0.8,"last_synced_commit":"99957befd87ce2660bf4258a565a431c5eb3b018"},"previous_names":[],"tags_count":105,"template":false,"template_full_name":null,"purl":"pkg:github/kaltura/playkit-js-dash","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaltura%2Fplaykit-js-dash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaltura%2Fplaykit-js-dash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaltura%2Fplaykit-js-dash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaltura%2Fplaykit-js-dash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kaltura","download_url":"https://codeload.github.com/kaltura/playkit-js-dash/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaltura%2Fplaykit-js-dash/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263540134,"owners_count":23477454,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dash","es6","flow-typed","kaltura","playkit","playkit-js","playkit-js-player","shaka-player"],"created_at":"2025-06-08T15:07:31.874Z","updated_at":"2025-07-07T22:08:54.294Z","avatar_url":"https://github.com/kaltura.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PlayKit JS DASH - [Shaka Player] Adapter for the [PlayKit JS Player]\n\n[![Build Status](https://github.com/kaltura/playkit-js-dash/actions/workflows/run_canary_full_flow.yaml/badge.svg)](https://github.com/kaltura/playkit-js-dash/actions/workflows/run_canary_full_flow.yaml)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![](https://img.shields.io/npm/v/@playkit-js/playkit-js-dash/latest.svg)](https://www.npmjs.com/package/@playkit-js/playkit-js-dash)\n[![](https://img.shields.io/npm/v/@playkit-js/playkit-js-dash/canary.svg)](https://www.npmjs.com/package/@playkit-js/playkit-js-dash/v/canary)\n\nPlayKit JS DASH adapter integrates [Shaka Player] with the [PlayKit JS Player].\n\nPlayKit JS DASH is written in [ECMAScript6], statically analysed using [Flow] and transpiled in ECMAScript5 using [Babel].\n\n[shaka player]: https://github.com/google/shaka-player\n[shaka player api docs]: https://shaka-player-demo.appspot.com/docs/api/index.html\n[flow]: https://flow.org/\n[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials\n[babel]: https://babeljs.io\n\n## Getting Started\n\n### Prerequisites\n\nThe adapter requires [PlayKit JS Player] to be loaded first.\n\nThe adapter uses the [Shaka Player] javascript library.\n\n[playkit js player]: https://github.com/kaltura/playkit-js\n\n### Installing\n\nFirst, clone and run [yarn] to install dependencies:\n\n[yarn]: https://yarnpkg.com/lang/en/\n\n```\ngit clone https://github.com/kaltura/playkit-js-dash.git\ncd playkit-js-dash\nyarn install\n```\n\n### Building\n\nThen, build the player\n\n```javascript\nyarn run build\n```\n\n### Embed the library in your test page\n\nFinally, add the bundle as a script tag in your page, and initialize the player\n\n```html\n\u003cscript type=\"text/javascript\" src=\"/PATH/TO/FILE/playkit.js\"\u003e\u003c/script\u003e\n\u003cscript type=\"text/javascript\" src=\"/PATH/TO/FILE/playkit-dash.js\"\u003e\u003c/script\u003e\n\u003cdiv id=\"player-placeholder\" style=\"height:360px; width:640px\"\u003e\n  \u003cscript type=\"text/javascript\"\u003e\n    var playerContainer = document.querySelector(\"#player-placeholder\");\n    var config = {...};\n    var player = playkit.core.loadPlayer(config);\n    playerContainer.appendChild(player.getView());\n    player.play();\n  \u003c/script\u003e\n\u003c/div\u003e\n```\n\n## Configuration\n\n[Shaka Player] configuration options, documented @[Shaka Player API docs], can be passed via the [PlayKit JS Player] config.\n\nThe configuration is exposed via the playback section:\n\n```javascript\n{\n  playback: {\n    options: {\n      html5: {\n        dash: {\n          // Shaka Player configuration options here\n        }\n      }\n    }\n  }\n}\n```\n\n## Running the tests\n\nTests can be run locally via [Karma], which will run on Chrome, Firefox and Safari\n\n[karma]: https://karma-runner.github.io/1.0/index.html\n\n```\nyarn run test\n```\n\nYou can test individual browsers:\n\n```\nyarn run test:chrome\nyarn run test:firefox\nyarn run test:safari\n```\n\n### And coding style tests\n\nWe use ESLint [recommended set](http://eslint.org/docs/rules/) with some additions for enforcing [Flow] types and other rules.\n\nSee [ESLint config](.eslintrc.json) for full configuration.\n\nWe also use [.editorconfig](.editorconfig) to maintain consistent coding styles and settings, please make sure you comply with the styling.\n\n## Compatibility\n\nTBD\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kaltura/playkit-js-dash/tags).\n\n## License\n\nThis project is licensed under the AGPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaltura%2Fplaykit-js-dash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaltura%2Fplaykit-js-dash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaltura%2Fplaykit-js-dash/lists"}