Chimee 开源项目使用教程

Chimee 开源项目使用教程

chimeea video player framework aims to bring wonderful experience on browser项目地址:https://gitcode.com/gh_mirrors/chi/chimee

1. 项目的目录结构及介绍

Chimee 项目的目录结构如下：

chimee/
├── docs/
├── examples/
├── lib/
├── src/
├── test/
├── .babelrc
├── .editorconfig
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── package.json
└── webpack.config.js

目录介绍

• docs/: 存放项目文档。
• examples/: 存放示例代码。
• lib/: 编译后的文件。
• src/: 源代码文件。
• test/: 测试文件。
• .babelrc: Babel 配置文件。
• .editorconfig: 编辑器配置文件。
• .eslintignore: ESLint 忽略配置。
• .eslintrc: ESLint 配置文件。
• .gitignore: Git 忽略配置。
• .npmignore: npm 忽略配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 更新日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证。
• README.md: 项目说明。
• package.json: 项目依赖和脚本。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

Chimee 项目的启动文件主要是 src/index.js。这个文件是项目的入口文件，负责初始化和导出主要功能。

// src/index.js
import Chimee from './Chimee';
import ChimeeKernelFlv from 'chimee-kernel-flv';
import ChimeeKernelHls from 'chimee-kernel-hls';
import ChimeePluginControlbar from 'chimee-plugin-controlbar';
import ChimeePluginLog from 'chimee-plugin-log';

export {
  Chimee,
  ChimeeKernelFlv,
  ChimeeKernelHls,
  ChimeePluginControlbar,
  ChimeePluginLog
};

启动文件介绍

• Chimee: 主播放器类。
• ChimeeKernelFlv: FLV 解码器。
• ChimeeKernelHls: HLS 解码器。
• ChimeePluginControlbar: 控制栏插件。
• ChimeePluginLog: 日志插件。

3. 项目的配置文件介绍

Chimee 项目的配置文件主要包括 package.json 和 webpack.config.js。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "chimee",
  "version": "1.3.0",
  "description": "A web video player",
  "main": "lib/index.js",
  "scripts": {
    "build": "webpack",
    "test": "npm run lint && npm run test-unit",
    "lint": "eslint src test",
    "test-unit": "mocha --compilers js:babel-core/register --require babel-polyfill test/**/*.spec.js"
  },
  "dependencies": {
    "chimee-kernel-flv": "^0.1.0",
    "chimee-kernel-hls": "^0.1.0",
    "chimee-plugin-controlbar": "^0.1.0",
    "chimee-plugin-log": "^0.1.0"
  },
  "devDependencies": {
    "babel-core": "^6.26.0",
    "babel-loader": "^7.1.2",
    "babel-polyfill": "^6.26.0",
    "babel-preset-env": "^1.6.1",
    "eslint": "^4.10.0",
    "mocha": "^4.0.1",
    "webpack": "^3.8.1"
  }
}

webpack.config.js

`webpack.

chimeea video player framework aims to bring wonderful experience on browser项目地址:https://gitcode.com/gh_mirrors/chi/chimee