munchyroll
v1.0.10
Published
A html5 video player
Downloads
12
Maintainers
algobreighReadme
MUNCHYROLL 🎥🍩
MUNCHYROLL is a custom video player built with the power of modern JavaScript and TypeScript. It's designed to support a wide range of video formats, including adaptive streaming with HLS (HTTP Live Streaming). Whether you need to stream .m3u8, .ts, or .mp4 files, MUNCHYROLL has you covered.
🚀 Features
Customizable Controls: Easily configure buttons and control positions, including custom controls.
Plugin Support: Extend the player's functionality with plugins.
HLS Support: Stream
.m3u8,.ts, and.mp4files seamlessly with HLS.js.Cross-browser Compatibility: Fallbacks for browsers like Safari, which natively support HLS.
🛠 Installation
Install MUNCHYROLL and its dependencies:
npm install munchyroll- cdn
<script
src="https://cdn.jsdelivr.net/npm/[email protected] /umd/munchyroll.umd.js"
defer></script>📦 Usage
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Munchyroll Player Demo</title>
<style></style>
<script
src="https://cdn.jsdelivr.net/npm/[email protected] /umd/munchyroll.umd.js"
defer></script>
<script defer>
document.addEventListener("DOMContentLoaded", function () {
munchyrolljs({
src: "https://stream.mux.com/ddBx5002F02xe7ftFvTFkYBxEdQ2inQ2o029CMqu9A4IcY/high.mp4",
controls: {
timeDisplay: true,
captionsButton: true,
pipButton: true,
playButton: true,
seekForwardButton: true,
seekBackwardButton: true,
muteButton: true,
volumeRange: true,
playbackRateButton: true,
fullscreenButton: true,
},
attr: {
height: "70%",
width: "100%",
autoplay: false,
loop: false,
muted: false,
//poster: "https://via.placeholder.com/800x450?text=Munchyroll+Player",
},
});
});
</script>
</head>
<body>
<munchyrolljs></munchyrolljs>
</body>
</html>
📝 API
munchyrolljs(options: VideoOptions)
- options: An object to configure the video player.
- src: The source URL of the video.
- attr: An object containing video attributes like width, height, autoplay, etc.
- controls: An object to configure player controls. Includes support for custom controls.
- plugins: An array of functions to extend the player's functionality.
VideoOptions
interface VideoOptions {
src: string;
attr: {
autoplay?: boolean;
loop?: boolean;
muted?: boolean;
poster?: string;
preload?: "auto" | "metadata" | "none";
width: string;
height: string;
playsInline?: boolean;
};
controls?: {
playButton?: boolean;
seekForwardButton?: boolean;
seekBackwardButton?: boolean;
muteButton?: boolean;
volumeRange?: boolean;
timeDisplay?: boolean;
captionsButton?: boolean;
playbackRateButton?: boolean;
pipButton?: boolean;
fullscreenButton?: boolean;
customControls?: ControlOption[];
};
plugins?: (() => void)[];
}📖 License
MUNCHYROLL is licensed under the MIT License.
MIT License
---
Copyright (c) 2024 notunderctx
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions: