Export settings to be passed to the exporter to use. More...

#include <src/engine/session/exporter.h>

Collaboration diagram for zrythm::engine::session::Exporter::Settings:

Public Member Functions
void	set_bounce_defaults (Format format, const fs::path &filepath, const utils::Utf8String &bounce_name)
	Sets the defaults for bouncing.
std::pair< double, double >	get_export_time_range () const
	Calculate and return the export time range positions in ticks.
void	print () const

Data Fields
Format	format_ = Format::WAV
utils::Utf8String	artist_
utils::Utf8String	title_
utils::Utf8String	genre_
BitDepth	depth_ = BitDepth::BIT_DEPTH_16
	Bit depth (16/24/64).
TimeRange	time_range_ = TimeRange::Song
Mode	mode_ = Mode::Full
	Export mode.
bool	disable_after_bounce_ = false
	Disable exported track (or mute region) after bounce.
bool	bounce_with_parents_ = false
	Bounce with parent tracks (direct outs).
BounceStep	bounce_step_ = BounceStep::PostFader
	Bounce step (pre inserts, pre fader, post fader).
double	custom_start_
	Positions in ticks in case of custom time range.
double	custom_end_
bool	lanes_as_tracks_ = false
	Export track lanes as separate MIDI tracks.
bool	dither_ = false
	Dither or not.
fs::path	file_uri_
	Absolute path for export file.
int	num_files_ = 1
	Number of files being simultaneously exported, for progress calculation.

Detailed Description

Export settings to be passed to the exporter to use.

Definition at line 115 of file exporter.h.

Member Function Documentation

◆ set_bounce_defaults()

void zrythm::engine::session::Exporter::Settings::set_bounce_defaults	(	Format	format,
		const fs::path &	filepath,
		const utils::Utf8String &	bounce_name )

Sets the defaults for bouncing.

Note: ExportSettings.mode must already be set at this point.

Parameters

filepath	Path to bounce to. If empty, this will generate a temporary filepath.
bounce_name	Name used for the file if filepath is NULL.

Field Documentation

◆ artist_

utils::Utf8String zrythm::engine::session::Exporter::Settings::artist_

Definition at line 142 of file exporter.h.

◆ bounce_step_

BounceStep zrythm::engine::session::Exporter::Settings::bounce_step_ = BounceStep::PostFader

Bounce step (pre inserts, pre fader, post fader).

Only valid if bounce_with_parents_ is false.

Definition at line 165 of file exporter.h.

◆ bounce_with_parents_

bool zrythm::engine::session::Exporter::Settings::bounce_with_parents_ = false

Bounce with parent tracks (direct outs).

Definition at line 158 of file exporter.h.

◆ custom_end_

double zrythm::engine::session::Exporter::Settings::custom_end_

Definition at line 169 of file exporter.h.

◆ custom_start_

double zrythm::engine::session::Exporter::Settings::custom_start_

Positions in ticks in case of custom time range.

Definition at line 168 of file exporter.h.

◆ depth_

BitDepth zrythm::engine::session::Exporter::Settings::depth_ = BitDepth::BIT_DEPTH_16

Bit depth (16/24/64).

Definition at line 146 of file exporter.h.

◆ disable_after_bounce_

bool zrythm::engine::session::Exporter::Settings::disable_after_bounce_ = false

Disable exported track (or mute region) after bounce.

Definition at line 155 of file exporter.h.

◆ dither_

bool zrythm::engine::session::Exporter::Settings::dither_ = false

Dither or not.

Definition at line 177 of file exporter.h.

◆ file_uri_

fs::path zrythm::engine::session::Exporter::Settings::file_uri_

Absolute path for export file.

Definition at line 182 of file exporter.h.

◆ format_

Format zrythm::engine::session::Exporter::Settings::format_ = Format::WAV

Definition at line 141 of file exporter.h.

◆ genre_

utils::Utf8String zrythm::engine::session::Exporter::Settings::genre_

Definition at line 144 of file exporter.h.

◆ lanes_as_tracks_

bool zrythm::engine::session::Exporter::Settings::lanes_as_tracks_ = false

Export track lanes as separate MIDI tracks.

Definition at line 172 of file exporter.h.

◆ mode_

Mode zrythm::engine::session::Exporter::Settings::mode_ = Mode::Full

Export mode.

Definition at line 150 of file exporter.h.

◆ num_files_

int zrythm::engine::session::Exporter::Settings::num_files_ = 1

Number of files being simultaneously exported, for progress calculation.

Definition at line 186 of file exporter.h.

◆ time_range_

TimeRange zrythm::engine::session::Exporter::Settings::time_range_ = TimeRange::Song

Definition at line 147 of file exporter.h.

◆ title_

utils::Utf8String zrythm::engine::session::Exporter::Settings::title_

Definition at line 143 of file exporter.h.

The documentation for this class was generated from the following file:

src/engine/session/exporter.h

Public Member Functions

Data Fields