Apache Cordova Media 插件使用教程

Apache Cordova Media 插件使用教程

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

Apache Cordova Media 插件的目录结构如下：

cordova-plugin-media/
├── src/
│   ├── android/
│   ├── ios/
│   ├── windows/
│   ├── browser/
├── www/
├── tests/
├── types/
├── .eslintrc.yml
├── .gitattributes
├── .gitignore
├── .npmignore
├── CONTRIBUTING.md
├── LICENSE
├── NOTICE
├── README.md
├── RELEASENOTES.md
├── package-lock.json
├── package.json
├── plugin.xml

目录介绍：

• src/: 包含各个平台的源代码。
  • android/: Android 平台的相关代码。
  • ios/: iOS 平台的相关代码。
  • windows/: Windows 平台的相关代码。
  • browser/: 浏览器平台的相关代码。
• www/: 包含插件的公共 JavaScript 代码。
• tests/: 包含插件的测试代码。
• types/: 包含 TypeScript 类型定义。
• .eslintrc.yml: ESLint 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证文件。
• NOTICE: 版权声明。
• README.md: 项目说明文档。
• RELEASENOTES.md: 发布说明。
• package-lock.json: npm 锁定文件。
• package.json: npm 配置文件。
• plugin.xml: 插件配置文件。

2. 项目的启动文件介绍

在 Apache Cordova Media 插件中，启动文件主要是 www/Media.js。这个文件定义了 Media 构造函数，提供了录音和播放音频文件的功能。

var media = new Media(src, mediaSuccess, [mediaError], [mediaStatus]);

参数介绍：

• src: 音频文件的 URL。
• mediaSuccess: 成功回调函数。
• mediaError: 错误回调函数（可选）。
• mediaStatus: 状态回调函数（可选）。

3. 项目的配置文件介绍

主要的配置文件是 plugin.xml。这个文件定义了插件的元数据、平台支持和文件映射。

配置文件内容示例：

<?xml version="1.0" encoding="UTF-8"?>
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
        id="cordova-plugin-media"
        version="6.0.0">
    <name>Media</name>
    <js-module name="Media" src="www/Media.js">
        <clobbers target="window.Media" />
    </js-module>
    <platform name="android">
        <config-file target="res/xml/config.xml" parent="/*">
            <feature name="Media">
                <param name="android-package" value="org.apache.cordova.media.AudioHandler"/>
            </feature>
        </config-file>
        <source-file src="src/android/AudioPlayer.java" target-dir="src/org/apache/cordova/media"/>
        <source-file src="src/android/AudioHandler.java" target-dir="src/org/apache/cordova/media"/>
    </platform>
    <platform name="ios">
        <config-file target="config.xml" parent="/*">
            <feature name="Media">
                <param name="ios-package" value="CDVSound"/>
            </feature>
        </config-file>
        <header-file src="src/ios/CDVSound.h"/>
        <source-file src="src/ios/CDVSound.m"/>
    </platform>
    <platform name="windows">
        <config-file target="config.xml" parent="/*">
            <feature name="Media">
                <param name="windows-package" value="MediaProxy"/>
            </feature>
        </config-file>
        <source-file src="src/windows