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

    Class RegionMetadataGenerated

    A region on a timeline track.

    from message audiotool.document.v1.metadata.v1.RegionMetadata

    Hierarchy

    Index

    Constructors

    Properties

    colorIndex: number = 0

    The color index of the region. The meaning of this value is determined by the UI. See [entity.region.v1.Region.color_index].

    from field: uint32 color_index = 7;

    displayName: string = ""

    A user-assigned name for the region. Empty if none was set.

    from field: string display_name = 8;

    durationTicks: number = 0

    Length of the region on the timeline, in ticks. See [entity.region.v1.Region.duration_ticks].

    from field: uint32 duration_ticks = 5;

    entityId: string = ""

    The entity id of the region in the document.

    from field: string entity_id = 1;

    entityType: string = ""

    The fully-qualified entity type name, e.g. "audiotool.document.v1.entity.timeline.v1.note.NoteRegion".

    from field: string entity_type = 2;

    isEnabled: boolean = false

    If false, the audio engine does not play this region.

    from field: bool is_enabled = 9;

    loopDurationTicks: number = 0

    Loop length inside the region, in ticks. Equal to duration_ticks when the region is not looped. See [entity.region.v1.Region.loop_duration_ticks].

    from field: uint32 loop_duration_ticks = 6;

    positionTicks: number = 0

    Start of the region on the timeline, in ticks. See [entity.region.v1.Region.position_ticks].

    from field: uint32 position_ticks = 4;

    trackEntityId: string = ""

    The timeline track this region belongs to.

    from field: string track_entity_id = 3;

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

    Methods

    • Create a deep copy.

      Returns RegionMetadata

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

    • 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