GeneratedOptionaldata: PartialMessage<DocumentMetadata>GeneratedcablesAll connection entities of the document.
Includes:
At the point in time (commit_index) of the metadata.
from field: repeated audiotool.document.v1.metadata.v1.CableMetadata cables = 6;
GeneratedcommitThe commit index this summary was computed at.
from field: uint64 commit_index = 2;
Optional GeneratedconfigThe document config entity. At most one exists; empty if none was created yet.
Includes:
At the point in time (commit_index) of the metadata.
from field: audiotool.document.v1.metadata.v1.ConfigMetadata config = 3;
GenerateddevicesAll desktop devices of the document (entities with a desktop position), including their loaded preset if there is one.
Includes:
Does not include:
cables)samples)timeline)config)At the point in time (commit_index) of the metadata.
from field: repeated audiotool.document.v1.metadata.v1.DeviceMetadata devices = 5;
GeneratedentityThe total number of entities in the document.
from field: uint64 entity_count = 7;
GeneratedentityEntity counts keyed by the fully-qualified entity type name, e.g. "audiotool.document.v1.entity.timeline.v1.note.Note".
Every entity of the document is counted, including types not broken out above (regions, tracks, notes, automation events, ...), so derived statistics can be computed without fetching the entities.
At the point in time (commit_index) of the metadata.
from field: map<string, uint64> entity_type_counts = 8;
GeneratedprojectThe project this summary belongs to, in the form projects/{uuid}.
from field: string project_name = 1;
GeneratedsamplesAll sample entities of the document.
Includes:
At the point in time (commit_index) of the metadata.
from field: repeated audiotool.document.v1.metadata.v1.SampleMetadata samples = 4;
Optional GeneratedtimelineThe arrangement of the document: timeline tracks and regions.
Large arrangements may be truncated by the server so the response stays
small. When truncated, tracks and regions are a prefix of the full
arrangement; entity_type_counts still reflects the untruncated document.
Transport settings (tempo, time signature, duration) live on config.
At the point in time (commit_index) of the metadata.
from field: audiotool.document.v1.metadata.v1.TimelineMetadata timeline = 9;
Static ReadonlyfieldsStatic ReadonlyruntimeStatic ReadonlytypeCreate a deep copy.
Compare with a message of the same type. Note that this function disregards extensions and unknown fields.
Parse from binary data, merging fields.
Repeated fields are appended. Map entries are added, overwriting existing keys.
If a message field is already present, it will be merged with the new data.
Optionaloptions: Partial<BinaryReadOptions>Parse a message from a JSON value.
Optionaloptions: Partial<JsonReadOptions>Parse a message from a JSON string.
Optionaloptions: Partial<JsonReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
Serialize the message to binary data.
Optionaloptions: Partial<BinaryWriteOptions>Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().
Optionaloptions: Partial<JsonWriteOptions>ProtectedtoOverride for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).
Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.
This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.
Serialize the message to a JSON string.
Optionaloptions: Partial<JsonWriteStringOptions>StaticequalsStaticfromOptionaloptions: Partial<BinaryReadOptions>StaticfromOptionaloptions: Partial<JsonReadOptions>StaticfromOptionaloptions: Partial<JsonReadOptions>
Lightweight summary of a document state at a specific commit index.
Intended for reuse across services that need to characterize a project (config, samples, devices, cables, presets, arrangement, entity-type counts) without fetching the full entity payload.
from message audiotool.document.v1.metadata.v1.DocumentMetadata