[BUG]: onProgress stream never completes, not sure if intended

Flutter sound onProgress stream never completes. Looking at the source, it seem to have been intended this way.

However I believe semantically speaking it should complete. It would allow things like this:

  Stream<RecordingDisposition> record(String path) {
    assert(_recorder.isStopped);
    return Stream.fromFuture(_doRecord(path))
        .switchMap((_) => _recorder.onProgress!)
        .doOnDone(() => _closeRecorderSession());
  }

  Future<void> _doRecord(String path) async {
    await _openRecorderSession();
    await _recorder.setSubscriptionDuration(const Duration(milliseconds: 100));
    await _recorder.startRecorder(
      toFile: path,
      codec: kIsWeb ? Codec.opusWebM : Codec.aacADTS,
    );
  }

It also has potential for unnecessary active subscriptions and might be the source of other bugs.

[cedvdb]

How about returning a stream from the startRecord/startPlaying instead ? Or is that too much breaking change ?

  Stream<PlaybackDisposition> startPlayer({
   String? fromURI,
   Uint8List? fromDataBuffer,
   Codec codec = Codec.aacADTS,
   int sampleRate = 16000, // Used only with codec == Codec.pcm16
   int numChannels = 1, // Used only with codec == Codec.pcm16
   TWhenFinished? whenFinished,
 }) {
   _progressController = StreamController();
   _lock.synchronized(() async {
     await _startPlayer(
       fromURI: fromURI,
       fromDataBuffer: fromDataBuffer,
       codec: codec,
       sampleRate: sampleRate,
       numChannels: numChannels,
       whenFinished: whenFinished,
     );
   });
   return _progressController!.stream.asBroadcastStream();
 }

I’m not sure what the lock is, if I understood correctly it’s to be sure the callback is executed only once at a time, if that’s the case then the way the progress is initialized is not entirely correct. his.

usage

_player.play().listen(
    (progress) => print(progress), 
    onDone: (duration) => _playNextTrack(), 
    onError: (e) => _displayError(e)
 );

[AR553]

Any update on this issue? Can we alternatively check if the player has completed playing the audio?