license: > Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

title: notification.beep


The device will play a beep sound.

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

Supported Platforms

  • Android
  • BlackBerry WebWorks (OS 5.0 and higher)
  • iPhone
  • Windows Phone 7 ( Mango )
  • Bada 1.2 & 2.x
  • Tizen

Quick Example

// Beep twice!

Full Example

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

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

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

    // Cordova is ready
    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.

iPhone Quirks

  • Ignores the beep count argument.
  • There is no native beep API for iPhone.
    • Cordova implements beep by playing an audio file via the media API.
    • The user must provide a file with the desired beep tone.
    • This file must be less than 30 seconds long, located in the www/ root, and must be named beep.wav.

Windows Phone 7 Quirks

  • WP7 Cordova lib includes a generic beep file that is used.

Tizen Quirks

  • Tizen implements beep by playing an audio file via the media API.
  • This beep file must be short, named beep.wav and has to be located in a ‘sounds’ sub-directory of the application root disctory.