main.md

title	description	summary	permalink	tags	keywords
τ API	The τ API.	τ is composed with 4 modules.	tau_api_main.html	api getting_started	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();

2. Open it. You cannot do anything on a close Player. An audio-session is then created.

myPlayer.openAudioSession().then( (){ ...} );

3. Use the various verbs implemented by the players.

• startPlayer()
• startPlayerFromStream()
• startPlayerFromBuffer()
• setVolume()
• FlutterSoundPlayer.stopPlayer()
• ...

4. 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();

2. Open it. You cannot do anything on a close Recorder. An audio-session is then created.

myRecorder.openAudioSession().then( (){ ...} );

3. Use the various verbs implemented by the players.

• startRecorder()
• pauseRecorder()
• resumeRecorder()
• stopRecorder()
• ...

4. 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();