Main topic

title: "τ API" description: "The τ API." summary: "τ is composed with 4 modules." permalink: tau_api_main.html tags: api,getting_started keywords: API

The Main modules

τ is composed with 4 modules :

  • FlutterSoundPlayer, wich deal with everything about playbacks
  • FlutterSoundRecorder, which deal with everything about recording
  • FlutterSoundHelper, which offers some convenients tools
  • FlutterSoundUI, which offer some Widget ready to be used out of the box

To use Flutter Sound you just do :

import 'package:flutter_sound/flutter_sound.dart';

This will import all the necessaries dart interfaces.

Playback

  1. Instance one ore more players. A good place to do that is in your init() function. It is also possible to instanciate the players "on the fly", when needed.
FlutterSoundPlayer myPlayer = FlutterSoundPlayer();
  1. Open it. You cannot do anything on a close Player. An audio-session is then created.
myPlayer.openAudioSession().then( (){ ...} );
  1. Use the various verbs implemented by the players.
  • startPlayer()
  • startPlayerFromStream()
  • startPlayerFromBuffer()
  • setVolume()
  • FlutterSoundPlayer.stopPlayer()
  • ...
  1. Close your players. This is important to close every player open for freeing the resources taken by the audio session. A good place to do that is in the dispose() procedure.
myPlayer.closeAudioSession();

Recording

  1. Instance your recorder. A good place to do that is in your init() function.
FlutterSoundRecorder myRecorder = FlutterSoundRecorder();
  1. Open it. You cannot do anything on a close Recorder. An audio-session is then created.
myRecorder.openAudioSession().then( (){ ...} );
  1. Use the various verbs implemented by the players.
  • startRecorder()
  • pauseRecorder()
  • resumeRecorder()
  • stopRecorder()
  • ...
  1. Close your recorder. This is important to close it for freeing the resources taken by the audio session. A good place to do that is in the dispose() procedure.
myRecorder.closeAudioSession();

Libraries

public/tau Main
public/tau_codec Main
Flutter Sound Input nodes
public/tau_node Main
Flutter Sound nodes
public/tau_player Main
THE Flutter Sound Player
public/tau_recorder Main
THE Flutter Sound Recorder