vibration 1.2.1

Vibration #

Build Status

A plugin for handling Vibration API on iOS and Android devices. API docs.

Getting Started #

  1. Add vibration to the dependencies section of pubspec.yaml.

     dependencies:
       vibration: 1.2.1
    
  2. Import package:

     import 'package:vibration/vibration.dart';
    

Methods #

hasVibrator #

Check if the target device has vibration capabilities.

if (Vibration.hasVibrator()) {
    Vibration.vibrate();
}

hasAmplitudeControl #

Check if the target device has the ability to control the vibration amplitude, introduced in Android 8.0 Oreo - false for all earlier API levels.

if (Vibration.hasAmplitudeControl()) {
    Vibration.vibrate(amplitude: 128);
}

vibrate #

With specific duration (for example, 1 second): #

Vibration.vibrate(duration: 1000);

Default duration is 500ms.

With specific duration and specific amplitude (if supported): #

Vibration.vibrate(duration: 1000, amplitude: 128);

With pattern (wait 500ms, vibrate 1s, wait 500ms, vibrate 2s): #

Vibration.vibrate(pattern: [500, 1000, 500, 2000]);

With pattern (wait 500ms, vibrate 1s, wait 500ms, vibrate 2s) at varying intensities (1 - min, 255 - max): #

Vibration.vibrate(pattern: [500, 1000, 500, 2000], intensities: [1, 255]);

cancel #

Stop ongoing vibration.

Vibration.cancel();

Android #

The VIBRATE permission is required in AndroidManifest.xml.

<uses-permission android:name="android.permission.VIBRATE"/>

Supports vibration with duration and pattern. On Android 8 (Oreo) and above, uses the VibrationEffect class. For the rest of the usage instructions, see Vibrator class documentation.

iOS #

Only supports singular vibrations with 500ms duration.

1.2.1 #

  • Maintenance release

1.2.0 #

  • Add support for amplitude control under Android 8.0 and later (by @pmundt)

1.1.0 #

1.0.2 #

  • Update vibration.podspec

1.0.1 #

  • Implemented cancel method for iOS

1.0.0 #

  • Initial Release

example/README.md

Vibration Example #

Demonstrates how to use the vibration plugin.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  vibration: ^1.2.1

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:vibration/vibration.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
94
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
97
Learn more about scoring.

We analyzed this package on Aug 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19
  • Flutter: 1.7.8+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Format lib/vibration.dart.

Run flutter format to format lib/vibration.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
flutter_test 0.0.0
Transitive dependencies
async 2.2.0 2.3.0
boolean_selector 1.0.4 1.0.5
charcode 1.1.2
collection 1.14.11 1.14.12
matcher 0.12.5
meta 1.1.6 1.1.7
path 1.6.2 1.6.4
pedantic 1.7.0 1.8.0+1
quiver 2.0.3 2.0.5
sky_engine 0.0.99
source_span 1.5.5
stack_trace 1.9.3
stream_channel 2.0.0
string_scanner 1.0.4 1.0.5
term_glyph 1.1.0
test_api 0.2.5 0.2.6
typed_data 1.1.6
vector_math 2.0.8