Variable SampleServiceConst Generated

Type declaration

• Readonlymethods: {
      cancelSampleUpload: {
          I: typeof CancelSampleUploadRequest;
          kind: Unary;
          name: "CancelSampleUpload";
          O: typeof CancelSampleUploadResponse;
      };
      createSample: {
          I: typeof CreateSampleRequest;
          kind: Unary;
          name: "CreateSample";
          O: typeof CreateSampleResponse;
      };
      deleteSample: {
          I: typeof DeleteSampleRequest;
          kind: Unary;
          name: "DeleteSample";
          O: typeof DeleteSampleResponse;
      };
      getSample: {
          I: typeof GetSampleRequest;
          kind: Unary;
          name: "GetSample";
          O: typeof GetSampleResponse;
      };
      listen: {
          I: typeof ListenRequest;
          kind: ServerStreaming;
          name: "Listen";
          O: typeof ListenResponse;
      };
      listSampleProcesses: {
          I: typeof ListSampleProcessesRequest;
          kind: Unary;
          name: "ListSampleProcesses";
          O: typeof ListSampleProcessesResponse;
      };
      listSamples: {
          I: typeof ListSamplesRequest;
          kind: Unary;
          name: "ListSamples";
          O: typeof ListSamplesResponse;
      };
      updateSample: {
          I: typeof UpdateSampleRequest;
          kind: Unary;
          name: "UpdateSample";
          O: typeof UpdateSampleResponse;
      };
      uploadSampleFinished: {
          I: typeof UploadSampleFinishedRequest;
          kind: Unary;
          name: "UploadSampleFinished";
          O: typeof Operation;
      };
  }

  • Readonly GeneratedcancelSampleUpload: {
        I: typeof CancelSampleUploadRequest;
        kind: Unary;
        name: "CancelSampleUpload";
        O: typeof CancelSampleUploadResponse;
    }

    Cancels a sample upload.

    from rpc audiotool.sample.v1.SampleService.CancelSampleUpload

  • Readonly GeneratedcreateSample: {
        I: typeof CreateSampleRequest;
        kind: Unary;
        name: "CreateSample";
        O: typeof CreateSampleResponse;
    }

    Create a sample.

    from rpc audiotool.sample.v1.SampleService.CreateSample

  • Readonly GenerateddeleteSample: {
        I: typeof DeleteSampleRequest;
        kind: Unary;
        name: "DeleteSample";
        O: typeof DeleteSampleResponse;
    }

    Deletes a sample.

    Always succeeds for the sample owner. If the sample is not used by any project (document-service), the resource is fully removed. If it is still in use, it is taken down instead: the resource is kept so existing references stay valid, usage is forced to SAMPLE_USAGE_UNLISTED, all audio and waveform URL fields are cleared, and takedown_reason is set to SAMPLE_TAKEDOWN_REASON_BY_USER. The response tells both cases apart.

    from rpc audiotool.sample.v1.SampleService.DeleteSample

  • Readonly GeneratedgetSample: {
        I: typeof GetSampleRequest;
        kind: Unary;
        name: "GetSample";
        O: typeof GetSampleResponse;
    }

    Gets a sample.

    from rpc audiotool.sample.v1.SampleService.GetSample

  • Readonly Generatedlisten: {
        I: typeof ListenRequest;
        kind: ServerStreaming;
        name: "Listen";
        O: typeof ListenResponse;
    }

    Listen for samples.

    This is a server streaming RPC. The client sends a request and gets a stream of responses. This can be used when a sample is created and announced as being uploaded in a collaborative session, the other clients can listen for the sample and start processing it as soon as it is ready.

    The server will have a history which lasts for a certain time frame and size and sends out historical events to the client. This makes it easy to retrieve non-racy events.

    from rpc audiotool.sample.v1.SampleService.Listen

  • Readonly GeneratedlistSampleProcesses: {
        I: typeof ListSampleProcessesRequest;
        kind: Unary;
        name: "ListSampleProcesses";
        O: typeof ListSampleProcessesResponse;
    }

    Lists the sample processes containung uploads and conversions.

    There is a rate-limit for each user. Uses will receive an error if they exceed the limit.

    from rpc audiotool.sample.v1.SampleService.ListSampleProcesses

  • Readonly GeneratedlistSamples: {
        I: typeof ListSamplesRequest;
        kind: Unary;
        name: "ListSamples";
        O: typeof ListSamplesResponse;
    }

    Lists the samples.

    from rpc audiotool.sample.v1.SampleService.ListSamples

  • Readonly GeneratedupdateSample: {
        I: typeof UpdateSampleRequest;
        kind: Unary;
        name: "UpdateSample";
        O: typeof UpdateSampleResponse;
    }

    Updates a sample.

    from rpc audiotool.sample.v1.SampleService.UpdateSample

  • Readonly GenerateduploadSampleFinished: {
        I: typeof UploadSampleFinishedRequest;
        kind: Unary;
        name: "UploadSampleFinished";
        O: typeof Operation;
    }

    UploadSampleFinished is called from the client when the upload of a sample is finished so the server can start processing the Data. An URL for the upload will be returned by CreateSample.

    from rpc audiotool.sample.v1.SampleService.UploadSampleFinished

• ReadonlytypeName: "audiotool.sample.v1.SampleService"