Variable SampleServiceConst Generated

Type declaration

• Readonlymethods: {
      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;
      };
      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 UploadSampleFinishedResponse;
      };
  }

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

    A sample can be deleted if it is not used by a project (document-service) and if the user has the correct permissions.

    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 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 UploadSampleFinishedResponse;
    }

    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"