OpenShot Library | libopenshot  0.3.2
QtPlayer.h
Go to the documentation of this file.
1 
10 // Copyright (c) 2008-2019 OpenShot Studios, LLC
11 //
12 // SPDX-License-Identifier: LGPL-3.0-or-later
13 
14 #ifndef OPENSHOT_QT_PLAYER_H
15 #define OPENSHOT_QT_PLAYER_H
16 
17 #include <iostream>
18 #include <vector>
19 
20 #include "PlayerBase.h"
21 #include "Qt/PlayerPrivate.h"
22 #include "RendererBase.h"
23 
24 namespace openshot
25 {
26  using AudioDeviceList = std::vector<std::pair<std::string, std::string>>;
27 
33  {
35  bool threads_started;
36 
37  public:
39  explicit QtPlayer();
40  explicit QtPlayer(openshot::RendererBase *rb);
41 
43  virtual ~QtPlayer();
44 
46  void CloseAudioDevice();
47 
49  std::string GetError();
50 
52  double GetDefaultSampleRate();
53 
56 
59 
61  void Play();
62 
64  void Loading();
65 
68 
70  void Pause();
71 
73  int64_t Position();
74 
76  void Seek(int64_t new_frame);
77 
79  void SetSource(const std::string &source);
80 
82  void SetTimelineSource(const std::string &json);
83 
87  void SetQWidget(int64_t qwidget_address);
88 
90  int64_t GetRendererQObject();
91 
93  float Speed();
94 
96  void Speed(float new_speed);
97 
99  void Stop();
100 
102  void Reader(openshot::ReaderBase *new_reader);
103 
106 
108  float Volume();
109 
111  void Volume(float new_volume);
112  };
113 }
114 
115 #endif
std::vector< std::pair< std::string, std::string > > AudioDeviceList
Header file for PlayerBase class.
Source file for PlayerPrivate class.
Header file for RendererBase class.
This is the base class of all Players in libopenshot.
Definition: PlayerBase.h:42
The private part of QtPlayer class, which contains an audio thread and video thread,...
Definition: PlayerPrivate.h:31
This class is used to playback a video from a reader.
Definition: QtPlayer.h:33
void Loading()
Display a loading animation.
Definition: QtPlayer.cpp:144
void Seek(int64_t new_frame)
Seek to a specific frame in the player.
Definition: QtPlayer.cpp:166
void SetSource(const std::string &source)
Set the source URL/path of this player (which will create an internal Reader)
Definition: QtPlayer.cpp:99
AudioDeviceList GetAudioDeviceNames()
Get Audio Devices from JUCE.
Definition: QtPlayer.cpp:75
AudioDeviceInfo GetCurrentAudioDevice()
Get current audio device or last attempted.
Definition: QtPlayer.cpp:81
int64_t Position()
Get the current frame number being played.
Definition: QtPlayer.cpp:161
QtPlayer()
Default constructor.
Definition: QtPlayer.cpp:29
void SetQWidget(int64_t qwidget_address)
Definition: QtPlayer.cpp:215
std::string GetError()
Get Error (if any)
Definition: QtPlayer.cpp:57
void CloseAudioDevice()
Close audio device.
Definition: QtPlayer.cpp:50
float Volume()
Get the Volume.
Definition: QtPlayer.cpp:241
virtual ~QtPlayer()
Default destructor.
Definition: QtPlayer.cpp:42
float Speed()
Get the Playback speed.
Definition: QtPlayer.cpp:226
void Play()
Play the video.
Definition: QtPlayer.cpp:131
double GetDefaultSampleRate()
Return the default audio sample rate (from the system)
Definition: QtPlayer.cpp:66
openshot::PlaybackMode Mode()
Get the current mode.
Definition: QtPlayer.cpp:150
void Pause()
Pause the video.
Definition: QtPlayer.cpp:155
openshot::ReaderBase * Reader()
Get the current reader, such as a FFmpegReader.
Definition: QtPlayer.cpp:210
void SetTimelineSource(const std::string &json)
Set the source JSON of an openshot::Timelime.
Definition: QtPlayer.cpp:86
int64_t GetRendererQObject()
Get the Renderer pointer address (for Python to cast back into a QObject)
Definition: QtPlayer.cpp:221
void Stop()
Stop the video player and clear the cached frames.
Definition: QtPlayer.cpp:181
This abstract class is the base class, used by all readers in libopenshot.
Definition: ReaderBase.h:76
This is the base class of all Renderers in libopenshot.
Definition: RendererBase.h:31
This namespace is the default namespace for all code in the openshot library.
Definition: Compressor.h:29
std::vector< std::pair< std::string, std::string > > AudioDeviceList
Definition: AudioDevices.h:42
PlaybackMode
This enumeration determines the mode of the video player (i.e. playing, paused, etc....
Definition: PlayerBase.h:27
This struct hold information about Audio Devices.
Definition: AudioDevices.h:27