---
description: startPlayer().
---

# The τ Player API

## `startPlayer()`

* Dart API: [startPlayer()](https://github.com/Canardoux/tau/tree/6bd245d293bcf9a123677735835549585d32b2ee/doc/pages/tau-api/player/pages/flutter-sound/api/player/FlutterSoundPlayer/startPlayer.html).

You can use `startPlayer` to play a sound.

* `startPlayer()` has three optional parameters, depending on your sound source :
  * `fromUri:`  (if you want to play a file or a remote URI)
  * `fromDataBuffer:` (if you want to play from a data buffer)
  * `sampleRate` is mandatory if `codec` == `Codec.pcm16`. Not used for other codecs.

You must specify one or the three parameters : `fromUri`, `fromDataBuffer`, `fromStream`.

* You use the optional parameter`codec:` for specifying the audio and file format of the file. Please refer to the [Codec compatibility Table](https://github.com/Canardoux/tau/tree/6bd245d293bcf9a123677735835549585d32b2ee/doc/pages/tau-api/player/codec.md#actually-the-following-codecs-are-supported-by-flutter_sound) to know which codecs are currently supported.
* `whenFinished:()` : A lambda function for specifying what to do when the playback will be finished.

Very often, the `codec:` parameter is not useful. Flutter Sound will adapt itself depending on the real format of the file provided. But this parameter is necessary when Flutter Sound must do format conversion (for example to play opusOGG on iOS).

`startPlayer()` returns a Duration Future, which is the record duration.

Hint: [path\_provider](https://pub.dev/packages/path_provider) can be useful if you want to get access to some directories on your device.

_Example:_

[Dart](#dart)

[Javascript](#javascript)

```

        Directory tempDir = await getTemporaryDirectory();
        File fin = await File ('${tempDir.path}/flutter_sound-tmp.aac');
        Duration d = await myPlayer.startPlayer(fin.path, codec: Codec.aacADTS);

        _playerSubscription = myPlayer.onProgress.listen((e)
        {
                // ...
        });
```

```

        Lorem ipsum ...
```

\</div>

_Example:_

[Dart](#dart)

[Javascript](#javascript)

```

    final fileUri = "https://file-examples.com/wp-content/uploads/2017/11/file_example_MP3_700KB.mp3";

    Duration d = await myPlayer.startPlayer
    (
                fromURI: fileUri,
                codec: Codec.mp3,
                whenFinished: ()
                {
                         print( 'I hope you enjoyed listening to this song' );
                },
    );
```

```

        Lorem ipsum ...
```

\</div>
