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

    Type Alias AudiotoolAPI

    Some services generated from the protobuf definitions at https://developer.audiotool.com/explore-protobufs.

    These are APIs of backend services of various parts of the audiotool infrastructure other than the document services. They let you make calls such as:

    • create a project
    • get user information

    Etc. See API for an overview.

    type AudiotoolAPI = {
        audioGraphService: RetryingClient<typeof AudiographService>;
        authorizedFetch: NeverThrowingFetch;
        fetch: NeverThrowingFetch;
        presets: PresetUtil;
        projectRoleService: RetryingClient<typeof ProjectRoleService>;
        projectService: RetryingClient<typeof ProjectService>;
        sampleService: RetryingClient<typeof SampleService>;
        userService: RetryingClient<typeof UserService>;
    }
    Index

    Properties

    audioGraphService authorizedFetch fetch presets projectRoleService projectService sampleService userService

    Properties

    audioGraphService: RetryingClient<typeof AudiographService>

    Manage audio "graphs", i.e. plots of audio samples, as used in the sample browser.

    authorizedFetch: NeverThrowingFetch

    Same as window.fetch, but

    • never throws, instead returns an error
    • includes headers & settings for authorization
    fetch: NeverThrowingFetch

    Same as window.fetch, but never throws, instead returns an error.

    presets: PresetUtil
    projectRoleService: RetryingClient<typeof ProjectRoleService>

    Add collaborators to your projects.

    projectService: RetryingClient<typeof ProjectService>

    Lookup, create and delete projects.

    sampleService: RetryingClient<typeof SampleService>

    Lookup and upload samples.

    userService: RetryingClient<typeof UserService>

    Lookup users.

    Settings

    Member Visibility

    On This Page

    Properties