goldendict-ng/audioplayerinterface.hh
Igor Kushnir 278e05cbf3 Run a single external audio player process at a time
External and internal audio players work similarly now. Fixes #950.

* inherit a new ExternalAudioPlayer class from AudioPlayerInterface;
* use an existing ExternalViewer class to implement ExternalAudioPlayer;
* take (const char *, int) instead of std::vector<char> in
  ExternalViewer constructor to fit into AudioPlayerInterface;
* extend ExternalViewer API to let ExternalAudioPlayer stop superseded
  audio player processes;
* make AudioPlayerInterface::play() return an error message string to
  allow reporting immediate failures from derived classes;
* Document AudioPlayerInterface API;
* Document AudioPlayerFactory::player();
* use the common audio interface exclusively in ArticleView.
2018-03-24 21:34:06 +02:00

31 lines
943 B
C++

/* This file is (c) 2018 Igor Kushnir <igorkuo@gmail.com>
* Part of GoldenDict. Licensed under GPLv3 or later, see the LICENSE file */
#ifndef AUDIOPLAYERINTERFACE_HH_INCLUDED
#define AUDIOPLAYERINTERFACE_HH_INCLUDED
#include <QScopedPointer>
#include <QString>
#include <QObject>
class AudioPlayerInterface : public QObject
{
Q_OBJECT
public:
/// Stops current playback if any, copies the audio buffer at [data, data + size),
/// then plays this buffer. It is safe to invalidate \p data after this function call.
/// Returns an error message in case of immediate failure; an empty string
/// in case of success.
virtual QString play( const char * data, int size ) = 0;
/// Stops current playback if any.
virtual void stop() = 0;
signals:
/// Notifies of asynchronous errors.
void error( QString message );
};
typedef QScopedPointer< AudioPlayerInterface > AudioPlayerPtr;
#endif // AUDIOPLAYERINTERFACE_HH_INCLUDED