To be used throughout the program.
More...
#include <src/gui/backend/backend/zrythm.h>
|
| static utils::Utf8String | get_version (bool with_v) |
| | Returns the version string.
|
| static bool | is_release (bool official) |
| | Returns whether the current Zrythm version is a release version.
|
| static void | fetch_latest_release_ver_async (networking::URL::GetContentsAsyncCallback callback) |
|
static bool | is_latest_release (const char *remote_latest_release) |
| | Returns whether the given release string is the latest release.
|
| static void | get_version_with_capabilities (char *buf, bool include_system_info) |
| | Returns the version and the capabilities.
|
|
static utils::Utf8String | get_system_info () |
| | Returns system info (mainly used for bug reports).
|
To be used throughout the program.
Everything here should be global and function regardless of the project.
Definition at line 39 of file zrythm.h.
◆ fetch_latest_release_ver_async()
| void Zrythm::fetch_latest_release_ver_async |
( |
networking::URL::GetContentsAsyncCallback | callback | ) |
|
|
static |
- Parameters
-
| callback | A GAsyncReadyCallback to call when the request is satisfied. |
| callback_data | Data to pass to callback. |
◆ get_version()
| utils::Utf8String Zrythm::get_version |
( |
bool | with_v | ) |
|
|
static |
Returns the version string.
- Parameters
-
| with_v | Include a starting "v". |
◆ get_version_with_capabilities()
| void Zrythm::get_version_with_capabilities |
( |
char * | buf, |
|
|
bool | include_system_info ) |
|
static |
Returns the version and the capabilities.
- Parameters
-
| buf | Buffer to write the string to. |
| include_system_info | Whether to include additional system info (for bug reports). |
◆ getVersion()
| QString Zrythm::getVersion |
( |
| ) |
const |
|
inline |
◆ init_user_dirs_and_files()
| void Zrythm::init_user_dirs_and_files |
( |
| ) |
|
Initializes/creates the default dirs/files in the user directory.
- Exceptions
-
◆ is_release()
| bool Zrythm::is_release |
( |
bool | official | ) |
|
|
static |
Returns whether the current Zrythm version is a release version.
- Note
- This only does regex checking.
◆ pre_init()
| void Zrythm::pre_init |
( |
std::optional< fs::path > | exe_path, |
|
|
bool | have_ui, |
|
|
bool | optimized_dsp ) |
Called before init().
TODO: check if can be merged into init().
- Parameters
-
| have_ui | Whether Zrythm is instantiated with a UI (false if headless). |
| testing | Whether this is a unit test. |
◆ benchmarking_
| bool Zrythm::benchmarking_ = false |
Whether currently running under the benchmarker.
Definition at line 204 of file zrythm.h.
◆ break_on_error_
| bool Zrythm::break_on_error_ = false |
Whether to abort() on an error log message.
Definition at line 154 of file zrythm.h.
◆ chord_preset_pack_manager_
Chord preset pack manager.
Definition at line 191 of file zrythm.h.
◆ create_project_path_
| fs::path Zrythm::create_project_path_ |
Path to create a project in, including its title.
Definition at line 134 of file zrythm.h.
◆ creating_project_
| bool Zrythm::creating_project_ = false |
Whether creating a new project, either from a template or blank.
Definition at line 131 of file zrythm.h.
◆ debug_
| bool Zrythm::debug_ = false |
In debug mode or not (determined by GSetting).
Definition at line 151 of file zrythm.h.
◆ exe_path_
| fs::path Zrythm::exe_path_ |
◆ generating_project_
| bool Zrythm::generating_project_ = false |
Whether this is a dummy instance used when generating projects.
Definition at line 158 of file zrythm.h.
◆ have_ui_
| bool Zrythm::have_ui_ = false |
1 if Zrythm has a UI, 0 if headless (eg, when unit-testing).
Definition at line 162 of file zrythm.h.
◆ lsp_dsp_context_
LSP DSP context for the main thread.
Definition at line 199 of file zrythm.h.
◆ open_filename_
| fs::path Zrythm::open_filename_ |
Filename to open passed through the command line.
Used only when a filename is passed, eg, zrytm myproject.zpj
Definition at line 141 of file zrythm.h.
◆ open_newer_backup_
| bool Zrythm::open_newer_backup_ = false |
Whether to open a newer backup if found.
This is only used during tests where there is no UI to choose.
Definition at line 175 of file zrythm.h.
◆ opening_template_
| bool Zrythm::opening_template_ = false |
Whether the open file is a template to be used to create a new project from.
Definition at line 128 of file zrythm.h.
◆ pipewire_pid_
Process ID for pipewire (used in tests).
Definition at line 188 of file zrythm.h.
◆ recording_manager_
Recording manager.
Definition at line 194 of file zrythm.h.
◆ settings_
| std::unique_ptr<Settings> Zrythm::settings_ |
Application settings.
Definition at line 124 of file zrythm.h.
◆ symap_
String interner for internal things.
Definition at line 146 of file zrythm.h.
◆ undo_stack_len_
| int Zrythm::undo_stack_len_ = 0 |
Undo stack length, used during tests.
Definition at line 168 of file zrythm.h.
◆ use_optimized_dsp_
| bool Zrythm::use_optimized_dsp_ = false |
Whether to use optimized DSP when available.
Definition at line 165 of file zrythm.h.
◆ use_pipewire_in_tests_
| bool Zrythm::use_pipewire_in_tests_ = false |
Whether to use pipewire in tests.
If this is false, the dummy engine will be used.
Some tests do sample rate changes so it's more convenient to use the dummy engine instead.
Definition at line 185 of file zrythm.h.
◆ version
| QML_ELEMENT QString Zrythm::version |
|
read |
The documentation for this class was generated from the following file:
