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

    Class PresetGenerated

    Preset is a resource representing a single Preset.

    from message audiotool.preset.v1.Preset

    Hierarchy

    Index

    Constructors

    Properties

    createTime?: Timestamp

    Output only. Timestamp when this Preset was created.

    from field: google.protobuf.Timestamp create_time = 8;

    dataUrl: string = ""

    URL pointing to the serialized preset data. This is a serialized proto.Any blob produced by the document-service.

    from field: string data_url = 13;

    description: string = ""

    The description of the Preset.

    from field: string description = 3;

    deviceType: PresetDeviceType = PresetDeviceType.UNSPECIFIED

    The type of devices used.

    This contains the list of devices used in the data blob.

    from field: audiotool.preset.v1.PresetDeviceType device_type = 12;

    displayName: string = ""

    The display name of the Preset.

    from field: string display_name = 2;

    favoritedByUser: boolean = false

    Whether the authed user liked the Preset.

    This is only exposed if the user is authenticated. The user can like a Preset via Favorite API.

    from field: bool favorited_by_user = 5;

    name: string = ""

    The Preset name.

    from field: string name = 1;

    numFavorites: number = 0

    The number of favorites of the Preset.

    from field: int32 num_favorites = 6;

    numUsages: number = 0

    The number of usages of the Preset in a track. If a Preset is used in a track, the usage will be increased. On the other hand the number will not be decreased if the a preset is removed or changed in a track.

    from field: int32 num_usages = 7;

    ownerName: string = ""

    The owner of the Preset in the format of users/{user}.

    from field: string owner_name = 4;

    tags: string[] = []

    The tags of the Preset.

    from field: repeated string tags = 11;

    updateTime?: Timestamp

    Output only. Timestamp when this Preset was last updated.

    The underlying audio can't be changed. Only some metadata (of this message) can be changed.

    from field: google.protobuf.Timestamp update_time = 9;

    usage: PresetUsage = PresetUsage.UNSPECIFIED

    The usage of the Preset.

    from field: audiotool.preset.v1.PresetUsage usage = 10;

    fields: FieldList = ...
    runtime: ProtoRuntime = proto3
    typeName: "audiotool.preset.v1.Preset"

    Methods

    • Create a deep copy.

      Returns Preset

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

    • 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