components/audio_modem/audio_player.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_AUDIO_MODEM_AUDIO_PLAYER_H_
   6 #define COMPONENTS_AUDIO_MODEM_AUDIO_PLAYER_H_
   7
   8 #include <vector>
   9
  10 #include "base/macros.h"
  11 #include "base/memory/ref_counted.h"
  12
  13 namespace media {
  14 class AudioBusRefCounted;
  15 }
  16
  17 namespace audio_modem {
  18
  19 // The AudioPlayerImpl class will play a set of samples till it is told to stop.
  20 class AudioPlayer {
  21  public:
  22   // Initializes the object. Do not use this object before calling this method.
  23   virtual void Initialize() = 0;
  24
  25   // Play the given samples. These samples will keep on being played in a loop
  26   // till we explicitly tell the player to stop playing. If we are already
  27   // playing, this call will be ignored.
  28   virtual void Play(
  29       const scoped_refptr<media::AudioBusRefCounted>& samples) = 0;
  30
  31   // Stop playing. If we're already stopped, this call will be ignored.
  32   virtual void Stop() = 0;
  33
  34   // Cleans up and deletes this object. Do not use object after this call.
  35   virtual void Finalize() = 0;
  36
  37  protected:
  38   virtual ~AudioPlayer() {}
  39 };
  40
  41 }  // namespace audio_modem
  42
  43 #endif  // COMPONENTS_AUDIO_MODEM_AUDIO_PLAYER_H_