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

    Class CreateSampleResponseGenerated

    Response for SampleService.CreateSample.

    from message audiotool.sample.v1.CreateSampleResponse

    Hierarchy

    Index

    Constructors

    Properties

    sample?: sample.Sample

    The created sample.

    from field: audiotool.sample.v1.Sample sample = 1;

    uploadEndpoint?: SampleUploadEndpoint

    The upload endpoint.

    The sample will not be visible in List requests until the upload is finished and processed. The client must call the UploadSampleFinished RPC to signal the server that the upload is finished.

    If the upload doesn't happen within a certain time frame the server will delete the sample and the endpoint will be invalid.

    The accepted data formats are:

    • mp3
    • wav
    • flac
    • ogg

    from field: audiotool.sample.v1.SampleUploadEndpoint upload_endpoint = 2;

    fields: FieldList = ...
    runtime: ProtoRuntime = proto3
    typeName: "audiotool.sample.v1.CreateSampleResponse"

    Methods

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

    • 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