Process::ExternalFileRef Struct Reference

One external file referenced by a document. More...

Detailed Description

One external file referenced by a document.

Public Attributes
QString	path
score::FileKind	kind {score::FileKind::Unknown}
FileUsage	usage {FileUsage::Input}
bool	directory {}
	The reference designates a folder, not a file.
bool	rewritable {true}
QString	owner
	Human-readable name of the object holding the reference.
std::optional< MediaRange >	usedRange
std::vector< QString >	companions

Member Data Documentation

companions

std::vector<QString> Process::ExternalFileRef::companions

Files this one names relative to its own folder, and is useless without: the samples of a Hydrogen drumkit.xml or of a KORG .kmp.

Paths are relative to the folder of path. A reference with companions is collected together with them into a folder of its own, so that their layout relative to it – which is how the file finds them – survives.

path

QString Process::ExternalFileRef::path

Exactly as stored in the model: absolute, document-relative, "<PROJECT>:..." or "<LIBRARY>:...".

rewritable

bool Process::ExternalFileRef::rewritable {true}

score knows how to rewrite this reference. False for things like plug-in binaries, which are reported so the user can install them by hand.

usedRange

std::optional<MediaRange> Process::ExternalFileRef::usedRange

The part of the file this reference actually reads.

Left unset when the whole file is used, or when the process cannot bound the region with confidence – a time-stretched clip whose mapping depends on a tempo curve, for instance. Trimming only ever touches references that set it, so "unsure" always means "leave the file alone".

---

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

• ExternalFiles.hpp