Sound and Vibration Feedback

Mobile WebWearable Web

Dependencies

  • Tizen 3.0 and Higher for Mobile
  • Tizen 3.0 and Higher for Wearable

Content

Related Info

You can handle feedback patterns (media or vibration) that can be played as a reaction to specified actions.

This feature is supported in mobile and wearable applications only.

The main features of the Feedback API include:

Each feedback pattern can have separate media files of sound and vibration type. For example, when receiving a new email message, a predefined sound and vibration feedback pattern can be played.

Prerequisites

From Tizen 5.0 onwards, it is possible to make your application visible in the Tizen Store only for devices that support the feedback vibration feature. To do so, you must specify the following feature in the config.xml file of the application:

 <widget>
    <feature name="http://tizen.org/feature/feedback.vibration"/>
 </widget>

Additionally, you can also verify if the feedback vibration feature is supported using the tizen.systeminfo.getCapability() method, and accordingly enable or disable the code that needs the API:

try {
    /* Checks whether a device supports feedback vibration feature */
    var vibration_feature = tizen.systeminfo.getCapability('http://tizen.org/feature/feedback.vibration');
    console.log('Feedback vibration = ' + vibration_feature);
} catch (error) {
    console.log('Error name: ' + error.name + ', message: ' + error.message);
}

Checking the Pattern

You can check whether a feedback type (sound or vibration) is supported for a specified pattern. To get information about the supported specified system predefined pattern type pairs, use the isPatternSupported() method of the FeedbackManager interface (in mobile and wearable applications):

var pattern = 'BT_CONNECTED', type = 'TYPE_SOUND';
var isSupported = tizen.feedback.isPatternSupported(pattern, type);
var isSupportedStr = '';
if (!isSupported) {
    isSupportedStr = ' not';
}
console.log('pattern ' + pattern + ' is' + isSupportedStr + ' supported');

Setting the Media Pattern

The available predefined system patterns are defined in the FeedbackPattern enumeration (in mobile and wearable applications).

To start and stop playing various types of predefined reactions:

  1. To set a specified type of reaction for an event, use the play() method of the FeedbackManager interface (in mobile and wearable applications):

    try {
        tizen.feedback.play('CHARGERCONN');
    } catch (err) {
        console.log(err.name + ': ' + err.message);
    }
    
  2. To stop reacting to predefined actions, use the stop() method of the FeedbackManager interface:

    tizen.feedback.stop();