Skip to content

Home

Jump to bottom
Demjhon Silver edited this page Nov 3, 2023 · 1 revision

Mirax Player

Mirax Player is an open-source video player library for popular front-end frameworks such as React, Vue, Angular, and Svelte. This versatile player allows you to easily embed videos from a variety of platforms including Facebook, TikTok, YouTube/Shorts, Twitter, Vimeo, and Dailymotion into your web applications.

Logo

Mirax Player

Overview

Mirax Player simplifies the process of embedding videos from different platforms within your web applications, making it a powerful tool for developers. You can use it to display videos from various sources without the need to write platform-specific integration code.

Features

Mirax Player comes with several features that make it a valuable addition to your web development toolkit:

  • Platform Agnostic: Mirax Player allows you to embed videos from multiple platforms, including Facebook, TikTok, YouTube/Shorts, Twitter, Vimeo, and Dailymotion. This means you can create a unified video player experience for your users regardless of where the videos are hosted.

  • Dynamic Video Embedding: You can dynamically embed videos by providing the URL of the video you want to display. This makes it easy to integrate videos into your web applications, and you can embed as many videos as needed.

  • Responsive Design: Mirax Player is designed to be responsive, ensuring that your videos look great on a variety of screen sizes and devices.

  • Customization: Customize the player's appearance and behavior to suit your application's needs. You can control aspects such as video playback controls, autoplay, and more.

Installation

You can easily install Mirax Player using package managers like npm or yarn. To get started, follow these steps:

# Using npm
npm install mirax-player
# Using yarn

yarn add mirax-player

Usage

To use Mirax Player in your React, Vue, Angular, or Svelte application, you'll need to import and configure the player as per the instructions in the documentation.

Here's a basic example of how you might use Mirax Player in a React application:

import { useEffect } from 'react';
import { embed } from 'mirax-player';

export const ExampleComponent = () => {
  useEffect(() => {
    embed([
      {
        width: 640,
        height: 360,
        autoplay: true,
        fullscreen: false,
        controls: true,
        videoUrl: 'https://www.youtube.com/watch?v=oEXFMGK7IC0',
        videoClass: 'embed-youtube-one-clip' 
      }
    ])
  });
  return (
    <>
      <div className="embed-youtube-one-clip"></div>
    </>
  );
};

Contributing

If you'd like to contribute to Mirax Player, feel free to open issues, submit pull requests, or get in touch with the project's maintainers through the GitHub repository. Your contributions are welcome and appreciated. License

Mirax Player is distributed under the MIT License. Please review the LICENSE file in the repository for more details. Support

If you encounter any issues or have questions about using Mirax Player, you can reach out to the community and the project maintainers through the GitHub repository's Issues section.

Mirax Player is a powerful and versatile video player library that can enhance your web applications by providing an easy way to embed videos from various platforms. Make sure to check the official documentation for more information and examples on how to use it effectively in your projects.

Clone this wiki locally