flutter_resonance_audio 0.0.1+1

flutter_resonance_audio #

Resonance Audio plugin for Flutter.

Currently for Android only. Please help me for supporting iOS.

Usage #

To use this plugin, add flutter_resonance_audio as a dependency in your pubspec.yaml file.

Example #

import 'package:flutter/material.dart';
import 'package:flutter_resonance_audio/flutter_resonance_audio.dart';

final audioEngine = FlutterResonanceAudio();

void main() async {
  await audioEngine.init();

  runApp(MaterialApp(
    home: Scaffold(
      body: Center(
      child: RaisedButton(
        onPressed: _playSound,
        child: Text('Play sound'),
        ),
      ),
    ),
  ));
}

_playSound() async {
  int sourceId = await audioEngine.createSoundObject('assets/sound.ogg');
  audioEngine.playSound(sourceId);
}

API #

This library mirrors GvrAudioEngine API (except init).

Return type (Future)MethodDescription
intcreateSoundObject(String filename)Returns a new sound object handle.
intcreateSoundfield(String filename)Returns a new Ambisonic soundfield handle.
intcreateStereoSound(String filename)Returns a new non-spatialized stereo sound.
voidenableRoom(boolean enable)Turns on/off the room reverberation effects.
voidenableSpeakerStereoMode(boolean enable)Enables the stereo speaker mode.
booleanisSoundPlaying(int sourceId)Checks if a sound is playing.
booleanisSourceIdValid(int sourceId)Checks if a
voidpause()Pauses the GVR Audio system.
voidpauseSound(int sourceId)Pauses the playback of a sound.
voidplaySound(int sourceId, boolean loopingEnabled)Starts the playback of a sound.
booleanpreloadSoundFile(String filename)Preloads a sound file.
voidresume()Resumes the GVR Audio system.
voidresumeSound(int sourceId)Resumes the playback of a sound.
voidsetHeadPosition(float x, float y, float z)Sets the head position.
voidsetHeadRotation(float x, float y, float z, float w)Sets the head rotation.
voidsetRoomProperties(float sizeX, float sizeY, float sizeZ, int wallMaterial, int ceilingMaterial, int floorMaterial)Sets the room properties describing the dimensions and surface materials of a given room.
voidsetRoomReverbAdjustments(float gain, float timeAdjust, float brightnessAdjust)Adjusts the properties of the current reverb, allowing changes to the reverb's gain, duration and low/high frequency balance.
voidsetSoundObjectDistanceRolloffModel(int soundObjectId, int rolloffModel, float minDistance, float maxDistance)Sets the given sound object source's distance attenuation method with minimum and maximum distances.
voidsetSoundObjectPosition(int soundObjectId, float x, float y, float z)Repositions an existing sound object.
voidsetSoundVolume(int sourceId, float volume)Changes the volume of an existing sound.
voidsetSoundfieldRotation(int soundfieldId, float x, float y, float z, float w)Sets the rotation of an existing Ambisonic soundfield.
voidstopSound(int sourceId)Stops the playback of a sound and destroys the corresponding Sound Object or Soundfield.
voidunloadSoundFile(String filename)Unloads a sound file from the sample cache.
voidupdate()The update method must be called from the main thread at a regular rate.

0.0.1 #

  • Initial release. Android only.

example/README.md

flutter_resonance_audio_example #

Demonstrates how to use the flutter_resonance_audio 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:
  flutter_resonance_audio: ^0.0.1+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:flutter_resonance_audio/flutter_resonance_audio.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
21
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
54
Learn more about scoring.

We analyzed this package on Jul 15, 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.3

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test

Admin