OpenShot Library | libopenshot 1.1.1
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 <cstdint>
18#include <iostream>
19#include <vector>
20
21#include "PlayerBase.h"
22#include "Qt/PlayerPrivate.h"
23#include "RendererBase.h"
24
25class QWidget;
26
27namespace openshot
28{
29 using AudioDeviceList = std::vector<std::pair<std::string, std::string>>;
30
36 {
38 bool threads_started;
40
41 public:
43 explicit QtPlayer();
44 explicit QtPlayer(openshot::RendererBase *rb);
45
47 virtual ~QtPlayer();
48
50 void CloseAudioDevice();
51
53 std::string GetError();
54
56 double GetDefaultSampleRate();
57
60
63
65 void Play();
66
68 void Loading();
69
72
74 void Pause();
75
77 int64_t Position();
78
80 void Seek(int64_t new_frame);
81
83 void Seek(int64_t new_frame, bool start_preroll);
84
86 void SetSource(const std::string &source);
87
89 void SetTimelineSource(const std::string &json);
90
94 void SetQWidget(uintptr_t qwidget_address);
95
97 void SetQWidget(QWidget *widget);
98
100 uintptr_t GetRendererQObject();
101
103 float Speed();
104
106 void Speed(float new_speed);
107
109 void Stop();
110
112 void Reader(openshot::ReaderBase *new_reader);
113
116
118 float Volume();
119
121 void Volume(float new_volume);
122 };
123}
124
125#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:33
This class is used to playback a video from a reader.
Definition: QtPlayer.h:36
void Loading()
Display a loading animation.
Definition: QtPlayer.cpp:145
uintptr_t GetRendererQObject()
Get the Renderer pointer address (for Python to cast back into a VideoRenderer)
Definition: QtPlayer.cpp:246
void Seek(int64_t new_frame)
Seek to a specific frame in the player.
Definition: QtPlayer.cpp:167
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
void SetQWidget(uintptr_t qwidget_address)
Definition: QtPlayer.cpp:235
AudioDeviceInfo GetCurrentAudioDevice()
Get current audio device or last attempted.
Definition: QtPlayer.cpp:81
friend struct AudioPlaybackThreadTestAccess
Definition: QtPlayer.h:39
int64_t Position()
Get the current frame number being played.
Definition: QtPlayer.cpp:162
QtPlayer()
Default constructor.
Definition: QtPlayer.cpp:29
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:268
virtual ~QtPlayer()
Default destructor.
Definition: QtPlayer.cpp:42
float Speed()
Get the Playback speed.
Definition: QtPlayer.cpp:253
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:151
void Pause()
Pause the video.
Definition: QtPlayer.cpp:156
openshot::ReaderBase * Reader()
Get the current reader, such as a FFmpegReader.
Definition: QtPlayer.cpp:230
void SetTimelineSource(const std::string &json)
Set the source JSON of an openshot::Timelime.
Definition: QtPlayer.cpp:86
void Stop()
Stop the video player and clear the cached frames.
Definition: QtPlayer.cpp:187
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:32
This namespace is the default namespace for all code in the openshot library.
Definition: AnimatedCurve.h:24
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