Cordova 插件媒体

2024年8月29日 | 阅读 8 分钟

Cordova 插件 Media 为您的 Cordova 应用程序添加了新功能。使用此插件，用户可以轻松地在设备上录制和播放音频文件。此插件定义了一个全局 media 构造函数。如果它在全局范围内，尽管如此，在 deviceready 事件之后才可以使用此插件。

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() 
{
   console.log(navigator.device.capture);
}

应该注意的是，当前对 media 的实现并未遵循 W3C 的媒体捕获规范。在未来的实现中，它将遵循最新的 W3C 规范。我们也可以通过此实现弃用当前的 API。

此插件受各种平台的支持，例如 Windows, Android, iOS, 浏览器。

安装

如果要在您的应用程序中添加此插件，首先您必须通过在命令提示符下键入以下命令来安装它。

媒体

现在，要在您的应用程序中使用该插件，请键入以下命令

参数

在这里，我们定义了参数，如下所示

src：此参数包含音频的 URI。
mediaSuccess（可选）：它是一个作为参数传递的函数。我们可以将其定义为回调函数，当媒体对象完成操作（即 播放、录制和停止）时，将执行该函数。
mediaError（可选）：它是一个作为参数传递的函数。我们可以将其定义为回调函数，当发生错误时将执行该函数。 mediaError 接受一个整数错误代码。
mediaStatus（可选）：它是一个作为参数传递的函数。我们可以将其定义为回调函数，该函数将执行以指示状态的变化。

常量

在这里，我们列出了作为唯一参数传递的常量，以指示状态的变化。

Media.MEDIA_NONE = 0;
Media.MEDIA_STARTING = 1;
Media.MEDIA_RUNNING = 2;
Media.MEDIA_PAUSED = 3;
Media.MEDIA_STOPPED = 4;

方法

getCurrentAmplitude：如果需要了解音频文件中的当前振幅，可以使用 media.getCurrentAmplitude 方法。
getCurrentPosition：在音频文件中，为了返回当前位置，我们可以使用 media.getCurrentPosition 方法。
getDuration：为了返回音频文件的持续时间，我们可以使用 media.getDuration 方法。
play：为了开始或恢复播放音频文件，我们可以使用 media.play 方法。
pause：为了暂停音频文件，我们可以使用 media.pause 方法。
pauseRecord：在音频文件中，使用此方法暂停录制。
release：此方法用于释放特定操作系统的音频资源。
resumeRecord：在音频文件中，使用此方法恢复录制。
seekTo：通过使用此方法，我们可以移动到音频文件中的某个位置。
setVolume：为了在音频文件中设置音频，我们可以使用此方法。
startRecord：为了开始在音频文件中录制，使用此方法。
stopRecord：为了停止在音频文件中录制，使用此方法。
stop：使用此方法停止音频文件。
setRate：通过使用此方法，我们可以将播放速率设置为音频文件。

现在，让我们讨论媒体插件中的其他只读参数

position：它指的是音频播放中以秒为单位的位置。
此参数在播放音频文件期间不会自动更新。为此，我们必须调用 getCurrentPosition。
duration：它指的是以秒为单位的媒体持续时间。

media.getCurrentAmplitude

如果需要了解音频文件中的当前振幅，可以使用 media.getCurrentAmplitude 方法。如果我们谈论此方法的兼容性，则各种平台（例如 Android 和 iOS）都支持它。

语法

参数

mediaSuccess：它通常指的是将音频文件的当前振幅作为参数传递的回调函数。振幅的范围是 0 - 1.0。
mediaError（可选）：它也指的是作为参数传递的回调函数。当发生任何事件时，将执行此方法。

var plugin_media = new Media(src, onSuccess, onError);
// This code record an audio
plugin_media.startRecord();
mediaTimer = setInterval(function ()
 {
    // to return the media amplitude
    plugin_media.getCurrentAmplitude(
        // for successful callback
        function (amp) {
            console.log(amp + "%");
        },
        // for error callback
        function (e) {
            console.log("An error occurred amp=" + e);
        }
    );
}, 2000);

media.getCurrentPosition

此方法使用户可以轻松地返回音频文件中的 当前位置。

语法

参数

mediaSuccess：它通常指的是将音频文件的当前位置（以秒为单位）作为参数传递的回调函数。

media.Error（可选）：它也指的是作为参数传递的回调函数。当发生任何事件时，将执行此方法。

示例

var plugin_media = new Media(src, onSuccess, onError);
// This code update the position of media every second
var p_mediaTimer = setInterval(function () 
{
    // return the  media position
     plugin_media.getCurrentPosition(
        // for successful callback
        function (position) {
            if (position > -1) {
                console.log((position) + " sec");
            }		
        },
        // for error callback
        function (e) {
            console.log("An error occurred pos=" + e);
        }
    );
}, 2000);

media.getDuration

为了返回音频文件的持续时间，我们可以使用 media.getDuration 方法。

语法

示例

var plugin_media = new Media(src, onSuccess, onError);
// Return the duration of an audio file
var counter = 0;
var timerDura = setInterval(function() {
    counter = counter + 100;
    if (counter > 2000) {
        clearInterval(timerDura);
    }
    var dura = plugin_media.getDuration();
    if (dura > 0) {
        clearInterval(timerDura);
        document.getElementById('audio_duration').innerHTML = (dur) + " sec";
    }
}, 100);

media.pause

为了暂停音频文件，我们可以使用 media.pause 方法。

语法

示例

function Audioplaying(url) {
    // To Play audio file at url
    var plugin_media = new Media(url,
        // for successful callback
        function () { console.log("Audioplaying():Successful Audio"); },
        // for error callback
        function (err) { console.log("Audioplaying():Audio Error: " + err); }
    );
    // To Play the audio
    plugin_media.play();
    // To pause recording after 20 seconds
    setTimeout(function () {
        plugin_media.pause();
    }, 20000);
}

media.pauseRecord

在音频文件中，我们可以使用 media.pauseRecord 方法暂停录制。如果我们谈论此方法的兼容性，它受 iOS 平台的支持。

语法

示例

function Audiorecording() {
    var src = "recording.mp3";
    var recordmedia = new Media(src,
      // for successful callback
        function() {
            console.log("Audiorecording():Successful Audio");
        },
      // for error callback
        function(err) {
            console.log("Audiorecording():Error Audio: "+ err.code);
        });
    // for audio recording
    recordmedia.startRecord();
    // To pause the audio recording after 4 seconds
    setTimeout(function() {
        recordmedia.pauseRecord();
    }, 4000);
}

media.play

为了开始或恢复播放音频文件，我们可以使用 media.play 方法。

示例

function Audioplay(url) {
    // For playing the audio file at url
    var plugin_media = new Media(url,
        // for success callback
        function () {
            console.log("Audioplay():Successful Audio");
        },
        // for error callback
        function (err) {
            console.log("Audioplay(): Error Audio: " + err);
        }
    );
    // for audio play
    plugin_media.play();
}

media.release

media.release 方法用于释放特定操作系统的音频资源。具体来说，对于 Android 平台，当用于媒体播放的 OpenCore 实例数量有限时，这一点很重要。为了释放不再需要的任何媒体资源，应用程序应调用 release 方法。

语法

示例

var plugin_media = new Media(src, onSuccess, onError);
plugin_media.play();
plugin_media.stop();
plugin_media.release();

media.resumeRecord

在音频文件中，我们可以使用 media.resumeRecord 方法恢复录制。 iOS 平台支持此方法。

示例

function Audiorecord() {
    var src = "recording.mp3";
    var mediaRec = new Media(src,
        // for successful callback
        function() {
            console.log("Audiorecord(): Successful Audio");
        },
        // for error callback
        function(err) {
            console.log("Audiorecord():Error Audio: "+ err.code);
        });
    // for audio recording
    mediaRec.startRecord();
   // to pause audio recording after 4 seconds
    setTimeout(function() {
        mediaRec.pauseRecord();
    }, 4000);
    // To resume audio recording after 20 seconds
    setTimeout(function() {
        mediaRec.resumeRecord();
    }, 20000);
}

media.seekTo

通过使用 media.seekTo 方法，我们可以在音频文件中设置当前位置。

语法

参数

milliseconds：在音频文件中，此参数以毫秒为单位设置音频播放位置。

示例

var plugin_media = new Media(src, onSuccess, onError);
    plugin_media.play();
// It seekTo to 20 seconds after 10 seconds
setTimeout(function() {
    plugin_media.seekTo(20000);
}, 10000);

media.setVolume

为了在音频文件中设置音频，我们可以使用 media.setVolume 方法。如果我们谈论此方法的兼容性，则各种平台（例如 Android 和 iOS）都支持它。

语法

参数

volume：此参数设置音频播放的音量。该值的范围必须在 0.0 – 1.0 之间。

示例

function Audioplay(url) {
    // To play an audio file at url
    var plugin_media = new Media(url,
        // for successful callback
        function() {
            console.log("Audioplay():Successful Audio");
        },
        // for error callback
        function(err) {
            console.log("Audioplay():Error Audio: "+err);
    });
    // To play an audio
    plugin_media.play();
    // To mute the volume after 4 seconds
    setTimeout(function() {
        plugin_media.setVolume('0.0');
    }, 4000);
    // To set the volume to 2.0 after 10 seconds
    setTimeout(function() {
        plugin_media.setVolume('2.0');
    }, 10000);
}

media.startRecord

为了开始在音频文件中录制，使用 media.startRecord 方法。各种平台（例如 Android、Windows 和 iOS）都支持此方法。

语法

示例

function Audiorecord() {
    var src = "recording.mp3";
    var mediaRec = new Media(src,
        // for successful callback
        function() {
            console.log("Audiorecord():Successful Audio");
        },
        // for error callback
        function(err) {
            console.log("Audiorecord():Error Audio: "+ err.code);
        });
    // For recording an  audio
    mediaRec.startRecord();
}

media.stop

要停止音频文件，请使用 media.stop 方法。

语法

示例

function Audioplay(url) {
    // To play an audio file at url
    var plugin_media = new Media(url,
        // for successful callback
        function() {
            console.log("Audioplay():Successful Audio");
        },
        // for error callback
        function(err) {
            console.log("Audioplay():Error Audio: "+err);
        }
    );
    // To play an audio
    plugin_media.play();
    // To pause after 20 seconds
    setTimeout(function() {
        plugin_media.stop();
    }, 20000);
}

media.stopRecord

为了停止在音频文件中录制，使用 media.stopRecord 方法。 Windows、Android 和 iOS 平台支持此方法。

语法

示例

function Audiorecord() {
    var src = "recording.mp3";
    var mediaRec = new Media(src,
        // for successful callback
        function() {
            console.log("Audiorecord():Successful Audio");
        },
        // for error callback
        function(err) {
            console.log("Audiorecord():Error Audio: "+ err.code);
        }
    );
    // To record an audio
    mediaRec.startRecord();
    // To stop the audio recording after 20 seconds
    setTimeout(function() {
        mediaRec.stopRecord();
    }, 20000);
}

media.setRate

通过使用 media.setRate 方法，我们可以将播放速率设置为音频文件。它受 iOS 平台支持。

语法

参数

rate：此参数设置播放音频文件的播放速率。

示例

var plugin_media = new Media(src, onSuccess, onError);
    plugin_media.play();
// To set the playback rate to 4.0x after 20 seconds
setTimeout(function() {
    plugin_media.setRate(4.0);
}, 10000);

MediaError

我们可以将 MediaError 定义为当发生任何事件时将返回到 mediaError 回调函数的对象。

性质

code：它定义了一些预定义的错误代码。

message：此消息显示错误的详细信息。

常量

MediaError.MEDIA_ERR_ABORTED = 1
MediaError.MEDIA_ERR_NETWORK = 2
MediaError.MEDIA_ERR_DECODE = 3
MediaError.MEDIA_ERR_NONE_SUPPORTED = 4

下一个主题Cordova 插件屏幕方向

← 上一个下一个 →

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Apache Cordova

Cordova 插件 API