Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TEGRAXD/resonance
A Flutter Package For Volume and Vibration Controller
https://github.com/TEGRAXD/resonance
android collaborate flutter plugin pubdev
Last synced: 1 day ago
JSON representation
A Flutter Package For Volume and Vibration Controller
- Host: GitHub
- URL: https://github.com/TEGRAXD/resonance
- Owner: TEGRAXD
- License: other
- Created: 2022-02-05T00:25:44.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-04T06:26:38.000Z (over 1 year ago)
- Last Synced: 2024-11-06T11:24:08.558Z (7 days ago)
- Topics: android, collaborate, flutter, plugin, pubdev
- Language: Dart
- Homepage: https://pub.dev/packages/resonance
- Size: 179 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Resonance 
Resonance is volume and vibration controller plugin. This plugin based on the Android volume and vibration controller. The plugin let you control volume without user interaction and allow customable vibration pattern.
## Download
Get the latest plugin directly from [Pub][1].
## Features
### Volume Control
- Get current volume level
- Get max volume level
- Set volume level
- Set max volume level
- Set mute volume level
- Showing volume UI (Android only)
- Volume stream types (music, notification, alarm, etc.)
- Listenable volume level change
### Vibration
- Create Vibration
- Create Pattern Vibration
- Cancel Pattern Vibration
## Usage
- Get current volume level
```dart
var crntVol = await Resonance.volumeGetCurrentLevel(streamType: StreamType.alarm);
print(crntVol);
```
- Set volume level
```dart
var crntVol = await Resonance.volumeSetLevel(0.5, showVolumeUI: true);
print(crntVol);
```
- Add volume listener
```dart
double _volumeLevel = 0;
@override
void initState() {
// Add listener
Resonance().addVolumeListener((volume) {
setState(() {
_volumeLevel = volume;
});
});
super.initState();
}
@override
void dispose() {
// Remove listener
Resonance().removeVolumeListener();
super.dispose();
}
```
- Create one-shot vibration by certain duration
```dart
await Resonance.vibrate(duration: const Duration(milliseconds: 1000));
```
- Create pattern vibration
```dart
await Resonance.vibratePattern(
[0, 400, 1000, 600, 1000, 800],
amplitude: 255, // Default: null
repeat: false, // Default: false
);
```
- Cancel active pattern vibration
```dart
await Resonance.vibrationCancel();
```
## Status
Version 1.0.3 is released
## Note
Only work for Android.
## API
Return | Method | Description
--------------- | --- | ---
Future\ | volumeGetCurrentLevel(StreamType streamType) | Returns device's current volume level.
Future\ | volumeGetMaxLevel(StreamType streamType) | Returns device's maximum volume level.
Future\ | volumeSetLevel(double volumeValue, StreamType streamType, bool showVolumeUI) | Set device's volume level to given volumeValue parameter and returns current volume level.
Future\ | volumeSetMaxLevel(StreamType streamType, bool showVolumeUI) | Set device's volume level to maximum and returns current volume level.
Future\ | volumeSetMuteLevel(StreamType streamType, bool showVolumeUI) | Set device's volume level to minimum or muted and returns current volume level.
StreamSubscription\ | addVolumeListener(Function(double volume) function) | Add volume change listener to handle given callback.
void | removeVolumeListener() | Cancel listener from broadcast stream
Future\ | vibrate(Duration? duration) | Create vibration by certain duration, default duration is 400ms and returns boolean status.
Future\ | vibratePattern(List\ pattern, int? amplitude, bool repeat,) | Create vibration by given custom pattern, amplitude, and repeat.
Future\ | vibrationCancel() | Cancel any active repeated vibration and returns boolean status.
## Developer
```
Tegar Bangun Suganda
```
[@canaryv8][2] (Twitter)\
[@suganda8][3] (Github)
## License
```
resonance
MIT License
Copyright (c) 2022 Tegar Bangun Suganda (OVERMIND)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
[1]: https://pub.dev/packages/resonance
[2]: https://twitter.com/canaryv8
[3]: https://github.com/suganda8