Cordova/cordova plugin media

تُمكّن هذه الإضافة من تسجيل وتشغيل الملفات الصوتية على الجهاز.

ملاحظة: لا يلتزم التنفيذ الحالي لهذه الإضافة بمواصفات W3C فيما يخص التقاط الوسائط، ويتم توفيره لأجل الملاءمة والاتساق فحسب. سوف يلتزم التنفيذ المستقبلي لهذه الإضافة بأحدث مواصفات W3C، وذلك قد يؤدي إلى إهمال الواجهات البرمجية الحالية.

تعرّف هذه الإضافة مُنشئًا (Constructor) عامًا هو Media. رغم أنَّه موجود في النطاق العام (global scope)، إلا أنه لن يكون متوفرًا إلا بعد إطلاق الحدث deviceready.

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(Media);
}‎

التثبيت

يمكن تثبيت هذه الإضافة عبر الأمر التالي:

cordova plugin add cordova-plugin-media‎

المنصات المدعومة

• أندرويد
• iOS
• ويندوز
• Browser

Media

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

المعاملات المُمرَّرة إلى هذه الدالة هي:

• src: عنوان URI يتضمن المحتوى الصوتي. (DOMString)
• mediaSuccess: (اختياري) دالة رد النداء (callback) الذي سيُنفذ بعد انتهاء الكائن Media الحالي من عملية التشغيل أو التسجيل أو الإيقاف.
• mediaError: (اختياري) دالة رد النداء التي سيُنفَّذ عند حدوث خطأ.
• mediaStatus: (اختياري) دالة رد النداء الذي سيُنفذ ليُشير إلى تغييرات الحالة.

ملاحظة: المعامل src يمكن أن يكون مسارًا من النوع cdvfile.

var my_media = new Media('cdvfile://localhost/temporary/recording.mp3', ...);‎

الثوابت

الثوابت التالية هي المعاملات الوحيدة المقبولة لرد النداء mediaStatus:

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

التوابع

التوابع التالية هي التوابع المرتبطة بكائنات Media:

• media.getCurrentAmplitude: يُعيد هذا التابع السعة (amplitude) الحالية في الملف الصوتي.
• media.getCurrentPosition: يُعيد هذا التابع الموضع الحالي في الملف الصوتي.
• media.getDuration: يُعيد هذا التابع مدة الملف الصوتي.
• media.play: يبدأ أو يستأنف تشغيل الملف الصوتي.
• media.pause: يوقف مؤقتًا (Pause) تشغيل الملف الصوتي.
• media.pauseRecord: يوقف مؤقتًا تسجيل الملف الصوتي.
• media.release: يحرر موارد الصوت لنظام التشغيل الأساسي (underlying OS).
• media.resumeRecord: يستأنف تسجيل الملف الصوتي.
• media.seekTo: ينقل موضع التشغيل في الملف الصوتي.
• media.setVolume: يضبط مستوى الصوت.
• media.startRecord: يبدأ تسجيل الملف الصوتي.
• media.stopRecord: يوقف تسجيل الملف الصوتي.
• media.stop: يوقف تشغيل الملف الصوتي.

معاملات إضافية للقراءة فقط

• position: الموضع داخل مقطوعة الصوت، ويُحدد بعدد الثواني.
  • لا يتم تحديثه تلقائيًّا أثناء تشغيل الصوت؛ إن أردت تحديثه، فاستدع التابع getCurrentPosition.
• duration: مدة المقطع الصوتي (media) بالثانية.

media.getCurrentAmplitude

يُعيد هذا التابع السعة الحالية (amplitude) في الملف الصوتي.

media.getCurrentAmplitude(mediaSuccess, [mediaError]);‎

المنصات المدعومة هي:

• أندرويد
• iOS

المعاملات المُمرَّرة إلى هذا التابع هي:

• mediaSuccess: رد النداء (callback) الذي ستُمرّر إليه السعة الحالية (0.0 - 1.0).
• mediaError: (اختياري) رد النداء الذي سيُنفّذ في حالة حدوث خطأ.

إليك المثال التالي الذي يشرح كيفية استعمال التابع getCurrentAmplitude:

// قارئ الصوت
//
var my_media = new Media(src, onSuccess, onError);
// تسجيل الصوت
my_media.startRecord();
mediaTimer = setInterval(function () {
    // الحصول على سعة الوسيط
    my_media.getCurrentAmplitude(
        // رد نداء النجاح
        function (amp) {
            console.log(amp + "%");
        },
        // رد نداء الخطأ
        function (e) {
            console.log("Error getting amp=" + e);
        }
    );
}, 1000);‎

media.getCurrentPosition

يُعيد هذا التابع الموضع الحالي في الملف الصوتي. كما يُحدِّث المعامل position الخاص بالكائن Media.

media.getCurrentPosition(mediaSuccess, [mediaError]);‎

المعاملات المُمرَّرة إلى هذا التابع هي:

• mediaSuccess: رد النداء الذي سيُمرّر إليه الموضع الحالي بالثواني.
• mediaError: (اختياري) رد النداء الذي سيُنفّذ في حالة حدوث خطأ.

اطلع على المثال التالي الذي يشرح كيفية استعمال التابع getCurrentPosition:

// قارئ الصوت
//
var my_media = new Media(src, onSuccess, onError);
// تحديث موضع الوسيط كل ثانية
var mediaTimer = setInterval(function () {
    // الحصول على موضع الوسيط
    my_media.getCurrentPosition(
        // رد نداء النجاح
        function (position) {
            if (position > -1) {
                console.log((position) + " sec");
            }
        },
        // رد نداء الخطأ
        function (e) {
            console.log("Error getting pos=" + e);
        }
    );
}, 1000);‎

media.getDuration

يُعيد هذا التابع مدة الملف الصوتي بالثواني. إذا كانت المدة غير معروفة، فسيُعيد التابع القيمة ‎-1.

media.getDuration();‎

مثال عن استعمال التابع getDuration:

// قارئ الصوت
//
var my_media = new Media(src, onSuccess, onError);
// الحصول على المدة
var counter = 0;
var timerDur = setInterval(function() {
    counter = counter + 100;
    if (counter > 2000) {
        clearInterval(timerDur);
    }
    var dur = my_media.getDuration();
    if (dur > 0) {
        clearInterval(timerDur);
        document.getElementById('audio_duration').innerHTML = (dur) + " sec";
    }
}, 100);‎

media.pause

يوقف هذا التابع تشغيل الملف الصوتي مؤقتًا.

media.pause();‎

مثال سريع حول استعمال التابع pause:

// تشغيل الصوت
//
function playAudio(url) {
    // url تشغيل الملف الصوت الموجود عند العنوان 
    var my_media = new Media(url,
        // رد نداء النجاح
        function () { console.log("playAudio():Audio Success"); },
        // رد نداء الخطأ
        function (err) { console.log("playAudio():Audio Error: " + err); }
    );
    // تشغيل الصوت
    my_media.play();
    // إيقاف مؤقت بعد 10 ثواني
    setTimeout(function () {
        my_media.pause();
    }, 10000);
}‎

media.pauseRecord

يوقف هذا التابع مؤقتًا تسجيل (recording) الملف الصوتي.

media.pauseRecord();‎

المنصات المدعومة هي:

• iOS

مثال سريع حول استعمال التابع pauseRecord:

// تسجيل الصوت
//
function recordAudio() {
    var src = "myrecording.mp3";
    var mediaRec = new Media(src,
        // رد نداء النجاح
        function() {
            console.log("recordAudio():Audio Success");
        },
        // رد نداء الخطأ
        function(err) {
            console.log("recordAudio():Audio Error: "+ err.code);
        });
    // تسجيل الصوت
    mediaRec.startRecord();
    // إيقاف التسجيل مؤقتا بعد 5 ثواني
    setTimeout(function() {
        mediaRec.pauseRecord();
    }, 5000);
}‎

media.play

يبدأ هذا التابع أو يستأنف تشغيل الملف الصوتي.

media.play();‎

مثال سريع حول استعمال التابع play:

// تشغيل الصوت
//
function playAudio(url) {
    // url تشغيل الملف الصوتي الموجود عند العنوان 
    var my_media = new Media(url,
        // رد نداء النجاح
        function () {
            console.log("playAudio():Audio Success");
        },
        // رد نداء الخطأ
        function (err) {
            console.log("playAudio():Audio Error: " + err);
        }
    );
    // تشغيل الصوت
    my_media.play();
}‎

ملاحظات خاصة بمنصة iOS

• numberOfLoops: مرّر هذا الخيار إلى التابع play لتحديد عدد مرات تشغيل الملف الصوتي، على سبيل المثال:

var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3")
myMedia.play({ numberOfLoops: 2 })‎

• playAudioWhenScreenIsLocked: مرِّر هذا الخيار إلى التابع play لتحديد ما إذا كنت تريد السماح بتشغيل الوسيط عندما تكون الشاشة مقفولة (locked). إذا عُيِّن هذا الخيار إلى القيمة true (القيمة الافتراضية)، سيتم تجاهل حالة زر كتم الصوت. على سبيل المثال:

var myMedia = new Media("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3");
myMedia.play({ playAudioWhenScreenIsLocked : true });
myMedia.setVolume('1.0');‎

ملاحظة: للسماح بتشغيل الوسيط أو الصوت الخلفي أثناء قفل الشاشة، عليك إضافة audio إلى UIBackgroundModes في الملف info.plist. راجع توثيق Apple لهذا الخصوص. لاحظ أيضًا أنّ عليك بدء تشغيل الصوت قبل الانتقال إلى الخلفية.

• ترتيب البحث عن الملفات: عند الاكتفاء بتقديم اسم ملف أو مسار بسيطٍ، فستبحث منصة iOS في المجلد www عن ذلك الملف، ثم في مجلد التطبيق documents/tmp:

var myMedia = new Media("audio/beer.mp3")
myMedia.play()  // www/audio/beer.mp3 تبحث في البداية عن الملف في 
                // <application>/documents/tmp/audio/beer.mp3‎ ثم في

media.release

يُحرّر (Releases) هذا التابع الموارد الصوتية لنظام التشغيل. هذا الأمر مهم بشكل خاص لنظام أندرويد، نظرًا لوجود عدد محدود من نُسخ OpenCore المخصصة لتشغيل الوسائط. يجب أن تستدعي التطبيقاتُ الدالةَ release لكل موارد Media التي لم تعد تحتاجها.

media.release();‎

إليك المثال التالي:

// تشغيل الصوت
//
var my_media = new Media(src, onSuccess, onError);
my_media.play();
my_media.stop();
my_media.release();‎

media.resumeRecord

يستأنف هذا التابع تسجيل الملف الصوتي.

media.resumeRecord();‎

المنصات المدعومة هي:

• iOS

مثال سريع حول التابع resumeRecord:

// تسجيل الصوت
//
function recordAudio() {
    var src = "myrecording.mp3";
    var mediaRec = new Media(src,
        // رد نداء النجاح
        function() {
            console.log("recordAudio():Audio Success");
        },
        //رد نداء الخطأ 
        function(err) {
            console.log("recordAudio():Audio Error: "+ err.code);
        });
    // تسجيل الصوت
    mediaRec.startRecord();
    // ايقاف التسجيل مؤقتا بعد 5 ثواني
    setTimeout(function() {
        mediaRec.pauseRecord();
    }, 5000);
    // استئناف التسجيل بعد 10 ثواني
    setTimeout(function() {
        mediaRec.resumeRecord();
    }, 10000);
}‎

media.seekTo

يضبط هذا التابع موضع التشغيل الحالي في الملف الصوتي.

media.seekTo(milliseconds);‎

المعاملات المُمرَّرة إلى هذا التابع هي:

• milliseconds: يحدد هذا المعامل موضع التشغيل في الملف الصوت، يُحسب بالميلي ثانية.

مثال سريع حول استعمال التابع seekTo:

// قارئ الصوت
//
var my_media = new Media(src, onSuccess, onError);
    my_media.play();
// انتقل إلى الموضع الموجود بعد 10 ثواني من البداية بعد 5 ثواني من الآن
setTimeout(function() {
    my_media.seekTo(10000);
}, 5000);‎

media.setVolume

يضبط هذا التابع مستوى الصوت الخاص بالملف الصوتي.

media.setVolume(volume);‎

المعاملات المُمرَّرة إلى هذا التابع هي:

• volume: يمثل هذا المعامل مستوى الصوت. يجب أن تكون القيمة ضمن النطاق 0.0 - 1.0.

المنصات المدعومة هي:

• أندرويد
• iOS

مثال سريع حول استعمال التابع setVolume:

// تشغيل الصوت
//
function playAudio(url) {
    // url تشغيل الملف الصوتي الموجود عند العنوان
    var my_media = new Media(url,
        // رد نداء النجاح
        function() {
            console.log("playAudio():Audio Success");
        },
        // رد نداء الخطأ
        function(err) {
            console.log("playAudio():Audio Error: "+err);
    });
    // تشغيل الصوت
    my_media.play();
    // كتم الصوت بعد ثانيتين
    setTimeout(function() {
        my_media.setVolume('0.0');
    }, 2000);
    // ضيط الصوت عند القيمة 1.0 بعد 5 ثواني
    setTimeout(function() {
        my_media.setVolume('1.0');
    }, 5000);
}‎

media.startRecord

يبدأ هذا التابع تسجيل الملف الصوتي.

media.startRecord();‎

المنصات المدعومة هي:

• أندرويد
• iOS
• ويندوز

مثال سريع حول استعمال التابع startRecord:

// تسجيل الصوت
//
function recordAudio() {
    var src = "myrecording.mp3";
    var mediaRec = new Media(src,
        // رد نداء النجاح
        function() {
            console.log("recordAudio():Audio Success");
        },
        // رد نداء الخطأ
        function(err) {
            console.log("recordAudio():Audio Error: "+ err.code);
        });
    // تسجيل الصوت
    mediaRec.startRecord();
}‎

ملاحظات خاصة بمنصة أندرويد

• تُسجل أجهزة أندرويد الصوت في ملفٍ بتنسيق AAC ADTS. ويجب أن ينتهي الملف المحدد بالامتداد aac..
• يتم وصل عناصر التحكم في مستوى الصوت في الجهاز بمستوى الصوت في الوسائط قيد التشغيل. وبمجرد استدعاء الدالة release()‎ على آخر كائن Media مُنشأ، تعود عناصر التحكم في الصوت إلى سلوكها الافتراضي. يحدث هذا أيضًا عند التنقل بين الصفحات، حيث يؤدي ذلك إلى تحرير جميع كائنات الوسائط.

ملاحظات خاصة بمنصة iOS

• لا يسجل نظام iOS إلا الملفات من النوع ‎.wav و ‎،.m4a وسيعيد خطأً إن لم يكن امتداد اسم الملف صحيحًا.
• إذا لم يتم توفير المسار الكامل، سيُوضع التسجيل في مجلد التطبيق documents/tmp. يمكن الوصول إلى ذلك التسجيل عبر الواجهة البرمجية File باستخدام LocalFileSystem.TEMPORARY. يجب أن تكون المجلدات الفرعية المحددة في وقت التسجيل موجودًا سلفًا.
• يمكن تسجيل الملفات وتشغيلها باستخدام مستندات URI:

var myMedia = new Media("documents://beer.mp3")‎

منذ الإصدار العاشر من منصة iOS، أصبح من الإلزامي تقديم وصف للاستخدام في الملف info.plist إن كنت تريد الوصول إلى البيانات الحساسة. عندما يستأذن النظام المستخدم للوصول إلى تلك المعلومات، سيُعرَض وصف الاستخدام ذاك كجزء من مربع حوار الاستئذان، ولكن إذا لم توفر وصف الاستخدام، فسيتعطل التطبيق قبل عرض مربع الحوار. كما سترفض Apple التطبيقات التي تحاول الوصول إلى البيانات الخاصة دون أن تقدم وصفًا للاستخدام.

تتطلب هذه الإضافة أوصاف الاستخدام التالية:

• NSMicrophoneUsageDescription: يحدد سبب وصول التطبيق إلى ميكروفون المستخدم.

لإضافة هذه المُدخلة إلى الملف info.plist، يمكنك استخدام الوسم edit-config في الملف config.xml على النحو التالي:

<edit-config target="NSMicrophoneUsageDescription" file="*-Info.plist" mode="merge">
    <string>need microphone access to record sounds</string>
</edit-config>‎

ملاحظات خاصة بمنصة ويندوز

• يمكن لأجهزة ويندوز استخدام التنسيقات MP3 و M4A و WMA لأجل الصوتيات المسجلة. ولكن غالبًا لن يكون بمقدورك استخدام التنسيق MP3 لتسجيل الصوت على أجهزة Windows Phone 8.1، لأن مرمز (encoder) ‏MP3 غير مشحون في منصة Windows Phone.
• إذا لم يتم توفير المسار الكامل، سيُوضع التسجيل في المجلد AppData/temp. يمكن الوصول إلى ذلك التسجيل عبر الواجهة البرمجية File باستخدام LocalFileSystem.TEMPORARY أو روابط ms-appdata:///temp/<filename>.
• يجب أن تكون كل المجلدات الفرعية المحددة في وقت التسجيل موجودًا بالفعل.

media.stop

يوقف هذا التابع تشغيل الملف الصوتي.

media.stop();‎

إليك مثال عن استعمال التابع stop:

// تشغيل الصوت
//
function playAudio(url) {
    // url تشغيل الملف الصوتي الموجود عند العنوان
    var my_media = new Media(url,
        // رد نداء النجاح
        function() {
            console.log("playAudio():Audio Success");
        },
        // رد نداء الخطأ
        function(err) {
            console.log("playAudio():Audio Error: "+err);
        }
    );
    // تشغيل الصوت
    my_media.play();
    // إيقاف التشغيل مؤقتا بعد 10 ثواني
    setTimeout(function() {
        my_media.stop();
    }, 10000);
}‎

media.stopRecord

يوقف هذا التابع تسجيل الملف الصوتي.

media.stopRecord();‎

المنصات المدعومة هي:

• أندرويد
• iOS
• ويندوز

مثال سريع حول استعمال التابع stopRecord:

// تسجيل الصوت
//
function recordAudio() {
    var src = "myrecording.mp3";
    var mediaRec = new Media(src,
        // رد نداء النجاح
        function() {
            console.log("recordAudio():Audio Success");
        },
        // رد نداء الخطأ
        function(err) {
            console.log("recordAudio():Audio Error: "+ err.code);
        }
    );
    // تسجيل الصوت
    mediaRec.startRecord();
    // إيقاف التسجيل بعد 10 ثواني
    setTimeout(function() {
        mediaRec.stopRecord();
    }, 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-plugin-media في توثيق كوردوفا الرسمي.