Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/navideck/volumedeck_sdk_flutter
Flutter version of Volumedeck
https://github.com/navideck/volumedeck_sdk_flutter
Last synced: 6 days ago
JSON representation
Flutter version of Volumedeck
- Host: GitHub
- URL: https://github.com/navideck/volumedeck_sdk_flutter
- Owner: Navideck
- License: mit
- Created: 2023-01-18T08:01:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T11:17:31.000Z (11 months ago)
- Last Synced: 2024-11-09T10:14:57.624Z (2 months ago)
- Language: Dart
- Homepage: https://pub.dev/packages/volumedeck_flutter
- Size: 421 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Volumedeck Flutter
[](https://pub.dev/packages/volumedeck_flutter)
## Overview
Volumedeck provides automatic volume adjustment based on GPS speed, improving the media-listening experience for users in vehicles and public transport.
## Key Features
- Speed-Sensitive Volume Adjustment: Automatically adjusts audio volume based on the vehicle's speed for consistent audio levels.
- Enhanced Safety and Focus: Eliminates the need for manual volume adjustments, enhancing driver safety and passenger convenience.
- Efficient and Reliable: Real-time speed-based volume control for smooth and uninterrupted listening experiences.
- Easy Integration: User-friendly API and comprehensive documentation for straightforward implementation.
- Versatile Applications: Enhances navigation, music streaming, and audio content delivery apps for various vehicles and public transport.
- Seamless integration with hardware volume keys for unified volume control in tandem with Volumedeck adjustments.
- Easy integration with UniversalVolume for unified volume control.
- Does not require internet connectivity
## Getting Started
### Setup Volumedeck
First configure your [Android](https://github.com/Navideck/Volumedeck-Android#running-in-background) and [IOS](https://github.com/Navideck/Volumedeck-iOS#step-3-configure-your-plist) project for the necessary permissions.
## Usage
### Initialize Volumedeck
```dart
Volumedeck.initialize(
runInBackground: true,
autoStart: true // Set to false if you don't want to start Volumedeck on initialization
locationServicesStatusChange: (bool status) {
// Get location on/off status updates
},
onLocationUpdate: (speed, volume) {
// Updates of speed and volume changes
},
onStart: () {
// Volumedeck started successfully
},
onStop: () {
// Volumedeck stopped, either from stop method or from android notification
},
);
```
### Start Volumedeck
You don't need to explicitly call start() since by default Volumedeck will autoStart when initialized.
```dart
await Volumedeck.start();
```
### Stop Volumedeck
```dart
Volumedeck.stop();
```
## API reference
You can find the API reference [here](https://pub.dev/documentation/volumedeck_flutter/latest/).
## Free to Use
Volumedeck SDK is freely available for use in both personal and commercial projects, offering full functionality without time limitations. However, when using the free version, a watermark will be displayed during runtime. It is strictly prohibited to hide, remove, or alter the watermark from the free version of Volumedeck SDK.
### Activation Key and Watermark Removal
To remove the watermark from your app, an activation key is available for purchase. The watermark-free version of Volumedeck SDK can be obtained through this activation key.
You need to set a different activation key for each platform.
To inquire about purchasing an activation key or for any other questions related to licensing and usage, please reach out to us at [email protected]. We are here to assist you with the process and provide the necessary information.
## Contact
For any inquiries, questions, or support, please don't hesitate to contact our team at [email protected]. Thank you for choosing Volumedeck Flutter Plugin!