Skip to content

Commit

Permalink
Docs: Fix engine configuration details in Clappr player integration e…
Browse files Browse the repository at this point in the history
…xample (#407)

* Fix config example for Clappr in API docs

* Rename downloadSource param in API docs
  • Loading branch information
DimaDemchenko authored Aug 14, 2024
1 parent 438afc3 commit d090eb0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
8 changes: 3 additions & 5 deletions api_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,11 +252,9 @@ For more examples with npm packages, you may check our [React demo](https://gith
import { HlsJsP2PEngine } from "p2p-media-loader-hlsjs";
const engine = new HlsJsP2PEngine({
p2p: {
core: {
swarmId: "Optional custom swarm ID for stream",
// Other P2P engine config parameters go here
},
core: {
swarmId: "Optional custom swarm ID for stream",
// Other P2P engine config parameters go here
},
});
Expand Down
2 changes: 1 addition & 1 deletion packages/p2p-media-loader-core/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ export type CoreEventMap = {
* Invoked after a chunk of data from a segment has been successfully downloaded.
*
* @param bytesLength - The size of the downloaded chunk in bytes.
* @param type - The source of the download.
* @param downloadSource - The source of the download.
* @param peerId - The peer ID of the peer that the event is about, if applicable.
*/
onChunkDownloaded: (
Expand Down

0 comments on commit d090eb0

Please sign in to comment.