@audiotool/nexus - v0.0.19
    Preparing search index...

    Class ConfigMetadataGenerated

    Global project configuration. Mirrors entity.config.v1.Config.

    Timeline time is measured in ticks. There are 3840 ticks per quarter note, so a 4/4 bar is 15360 ticks. Convert a position to bars with position_ticks / (3840 * 4 * signature_numerator / signature_denominator).

    from message audiotool.document.v1.metadata.v1.ConfigMetadata

    Hierarchy

    Index

    Constructors

    Properties

    baseFrequencyHz: number = 0

    Base frequency in hertz (A4). Mirrors entity.config.v1.Config.base_frequency_hz.

    from field: float base_frequency_hz = 3;

    defaultGroove?: PointerMetadata

    Default groove pointer. Mirrors entity.config.v1.Config.default_groove.

    from field: audiotool.document.v1.metadata.v1.PointerMetadata default_groove = 7;

    durationTicks: number = 0

    Length of the arrangement in ticks. Mirrors entity.config.v1.Config.duration_ticks.

    from field: int32 duration_ticks = 6;

    entityId: string = ""

    The entity id of the config entity in the document.

    from field: string entity_id = 1;

    signatureDenominator: number = 0

    Time-signature denominator. Mirrors entity.config.v1.Config.signature_denominator.

    from field: uint32 signature_denominator = 5;

    signatureNumerator: number = 0

    Time-signature numerator. Mirrors entity.config.v1.Config.signature_numerator.

    from field: uint32 signature_numerator = 4;

    tempoBpm: number = 0

    Global tempo in beats per minute. Mirrors entity.config.v1.Config.tempo_bpm.

    from field: float tempo_bpm = 2;

    fields: FieldList = ...
    runtime: ProtoRuntime = proto3
    typeName: "audiotool.document.v1.metadata.v1.ConfigMetadata"

    Methods

    • Create a deep copy.

      Returns ConfigMetadata

    • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

      Parameters

      Returns boolean

    • 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.

      Parameters

      Returns this

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

      Returns MessageType<ConfigMetadata>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

    • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns JsonValue

    • Override 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.

      Returns JsonValue

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string