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

    Class CableMetadataGenerated

    A connection entity of the document.

    from message audiotool.document.v1.metadata.v1.CableMetadata

    Hierarchy

    Index

    Constructors

    Properties

    colorIndex: number = 0

    The cable color index. 0 if the entity type has no color (mixer connections) or no color was set.

    from field: uint32 color_index = 5;

    entityId: string = ""

    The entity id of the connection in the document.

    from field: string entity_id = 1;

    entityType: string = ""

    The fully-qualified entity type name, e.g. "audiotool.document.v1.entity.desktop_audio_cable.v1.DesktopAudioCable".

    from field: string entity_type = 2;

    The source of the connection.

    Maps to from_socket (desktop cables), from (mixer side-chain cables), aux_send (mixer aux routes), or child_strip (mixer strip groupings).

    from field: audiotool.document.v1.metadata.v1.PointerMetadata from = 3;

    gain: number = 0

    The aux route gain. 0 if the entity type is not [entity.mixer.v1.MixerAuxRoute].

    from field: float gain = 6;

    The destination of the connection.

    Maps to to_socket (desktop cables), to (mixer side-chain cables), aux_receive (mixer aux routes), or group_strip (mixer strip groupings).

    from field: audiotool.document.v1.metadata.v1.PointerMetadata to = 4;

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

    Methods

    • Create a deep copy.

      Returns CableMetadata

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

    • 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