TracktionEngine
Public Attributes | List of all members
tracktion::engine::Edit::Options Struct Reference

Determines how the Edit will be created. More...

Public Attributes

Engineengine
 The Engine to use. More...
 
juce::ValueTree editState
 The Edit state. More...
 
ProjectItemID editProjectItemID
 The editProjectItemID, must be valid. More...
 
EditRole role = forEditing
 An optional role to open the Edit with. More...
 
LoadContextloadContext = nullptr
 An optional context to be monitor for loading status. More...
 
int numUndoLevelsToStore = Edit::getDefaultNumUndoLevels()
 The number of undo levels to use. More...
 
std::function< juce::File()> editFileRetriever = {}
 An optional editFileRetriever to use. More...
 
std::function< juce::File(const juce::String &)> filePathResolver = {}
 An optional filePathResolver to use. More...
 

Detailed Description

Determines how the Edit will be created.

Member Data Documentation

◆ engine

Engine& tracktion::engine::Edit::Options::engine

The Engine to use.

◆ editState

juce::ValueTree tracktion::engine::Edit::Options::editState

The Edit state.

See also
createEmptyEdit

◆ editProjectItemID

ProjectItemID tracktion::engine::Edit::Options::editProjectItemID

The editProjectItemID, must be valid.

◆ role

EditRole tracktion::engine::Edit::Options::role = forEditing

An optional role to open the Edit with.

◆ loadContext

LoadContext* tracktion::engine::Edit::Options::loadContext = nullptr

An optional context to be monitor for loading status.

◆ numUndoLevelsToStore

int tracktion::engine::Edit::Options::numUndoLevelsToStore = Edit::getDefaultNumUndoLevels()

The number of undo levels to use.

◆ editFileRetriever

std::function<juce::File()> tracktion::engine::Edit::Options::editFileRetriever = {}

An optional editFileRetriever to use.

◆ filePathResolver

std::function<juce::File (const juce::String&)> tracktion::engine::Edit::Options::filePathResolver = {}

An optional filePathResolver to use.


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