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

    Class DeviceMetadataGenerated

    A desktop device of the document: any entity with a desktop position.

    from message audiotool.document.v1.metadata.v1.DeviceMetadata

    Hierarchy

    Index

    Constructors

    Properties

    displayName: string = ""

    The user-visible name of the device. Empty if the entity has none.

    from field: string display_name = 3;

    entityId: string = ""

    The entity id of the device in the document.

    from field: string entity_id = 1;

    entityType: string = ""

    The fully-qualified entity type name, e.g. "audiotool.document.v1.entity.heisenberg.v1.Heisenberg".

    from field: string entity_type = 2;

    pluginPath: string = ""

    The VST3 plugin this device hosts, e.g. "OTT:OTT". Mirrors entity.generic_vst3_plugin_beta.v1.GenericVst3PluginBeta.plugin_path.

    Empty for every device that does not host a third-party VST3 plugin, including entity.spitfire_labs_vst3_plugin.v1.SpitfireLabsVst3Plugin, which always hosts the same plugin.

    from field: string plugin_path = 7;

    positionX: number = 0

    The x position of the device on the desktop.

    from field: int32 position_x = 5;

    positionY: number = 0

    The y position of the device on the desktop.

    from field: int32 position_y = 6;

    presetName: string = ""

    The preset backend name (usually presets/{uuid}) the device settings are based on. Empty if no preset is loaded or the device has no preset support.

    from field: string preset_name = 4;

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

    Methods

    • Create a deep copy.

      Returns DeviceMetadata

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

    • 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