The device plays a beep sound.

  • times: The number of times to repeat the beep. (Number)

Supported Platforms

  • Android
  • BlackBerry OS 5 - 7 (not supported for BlackBerry 10)
  • iOS
  • Tizen
  • Windows Phone 7 and 8

Quick Example

// Beep twice!

Full Example

<!DOCTYPE html>
    <title>Notification Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Wait for device API libraries to load
    document.addEventListener("deviceready", onDeviceReady, false);

    // device APIs are available
    function onDeviceReady() {
        // Empty

    // Show a custom alert
    function showAlert() {
            'You are the winner!',  // message
            'Game Over',            // title
            'Done'                  // buttonName

    // Beep three times
    function playBeep() {

    // Vibrate for 2 seconds
    function vibrate() {

    <p><a href="#" onclick="showAlert(); return false;">Show Alert</a></p>
    <p><a href="#" onclick="playBeep(); return false;">Play Beep</a></p>
    <p><a href="#" onclick="vibrate(); return false;">Vibrate</a></p>

Android Quirks

  • Android plays the default Notification ringtone specified under the Settings/Sound & Display panel.

iOS Quirks

  • Ignores the beep count argument.
  • The iPhone does not feature a native beep API.
    • Cordova implements beeps by playing an audio file via the media API.
    • The app must provide a file with the desired beep tone.
    • This file must be less than 30 seconds long, located in the www root directory, and must be named beep.wav.

Windows Phone 7 and 8 Quirks

  • Relies on a generic beep file from the Cordova distribution.

Tizen Quirks

  • Tizen implements beeps by playing an audio file via the media API.
  • The beep file must be short, must be located in a sounds sub-directory of the application's root directory, and must be named beep.wav.