play method

Future<Duration?> play({ TWhenFinished? whenFinished, TonSkip? onSkipForward, TonSkip? onSkipBackward, TonPaused? onPaused, bool defaultPauseResume = true, bool removeUIWhenStopped = true, })

Used 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 parametercodec: for specifying the audio and file format of the file. Please refer to the Codec compatibility Table 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.

The fromUri parameter, if specified, can be one of three posibilities :

• The URL of a remote file
• The path of a local file
• The name of a temporary file (without any slash '/')

Hint: path_provider can be useful if you want to get access to some directories on your device.

Example:

        Duration d = await myPlayer.startPlayer(fromURI: 'foo', codec: Codec.aacADTS); // Play a temporary file

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

Example:

    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: ()
                {
                         logger.d( 'I hope you enjoyed listening to this song' );
                },
    );

Implementation

//
/// - `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](/guides_codec.html) 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.
///
/// The `fromUri` parameter, if specified, can be one of three posibilities :
/// - The URL of a remote file
/// - The path of a local file
/// - The name of a temporary file (without any slash '/')
///
/// 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
///         Duration d = await myPlayer.startPlayer(fromURI: 'foo', codec: Codec.aacADTS); // Play a temporary file
///
///         _playerSubscription = myPlayer.onProgress.listen((e)
///         {
///                 // ...
///         });
/// }
/// ```
///
/// *Example:*
/// ```dart
///     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: ()
///                 {
///                          logger.d( 'I hope you enjoyed listening to this song' );
///                 },
///     );
/// ```
Future<Duration?> play({
  TWhenFinished? whenFinished,

  //Parameters for _play from track
  TonSkip? onSkipForward,
  TonSkip? onSkipBackward,
  TonPaused? onPaused,
  bool defaultPauseResume = true,
  bool removeUIWhenStopped = true,
}) async {
  Duration? r;
  await _lock.synchronized(() async {
    r = await _play(
      whenFinished: whenFinished,
      onSkipForward: onSkipForward,
      defaultPauseResume: defaultPauseResume,
      onPaused: onPaused,
      onSkipBackward: onSkipBackward,
      removeUIWhenStopped: removeUIWhenStopped,
    );
  });
  return r;
}