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

    Variable ProjectServiceConst Generated

    ProjectService: {
        methods: {
            createProject: {
                I: typeof CreateProjectRequest;
                kind: Unary;
                name: "CreateProject";
                O: typeof CreateProjectResponse;
            };
            deleteProject: {
                I: typeof DeleteProjectRequest;
                kind: Unary;
                name: "DeleteProject";
                O: typeof DeleteProjectResponse;
            };
            getLatestVersionBundle: {
                I: typeof GetLatestVersionBundleRequest;
                kind: Unary;
                name: "GetLatestVersionBundle";
                O: typeof GetLatestVersionBundleResponse;
            };
            getProject: {
                I: typeof GetProjectRequest;
                kind: Unary;
                name: "GetProject";
                O: typeof GetProjectResponse;
            };
            listProjects: {
                I: typeof ListProjectsRequest;
                kind: Unary;
                name: "ListProjects";
                O: typeof ListProjectsResponse;
            };
            listSessions: {
                I: typeof ListSessionsRequest;
                kind: Unary;
                name: "ListSessions";
                O: typeof ListSessionsResponse;
            };
            openSession: {
                I: typeof OpenSessionRequest;
                kind: Unary;
                name: "OpenSession";
                O: typeof OpenSessionResponse;
            };
            reconvertLegacyProject: {
                I: typeof ReconvertLegacyProjectRequest;
                kind: Unary;
                name: "ReconvertLegacyProject";
                O: typeof ReconvertLegacyProjectResponse;
            };
            syncTrack: {
                I: typeof SyncTrackRequest;
                kind: Unary;
                name: "SyncTrack";
                O: typeof Operation;
            };
            updateProject: {
                I: typeof UpdateProjectRequest;
                kind: Unary;
                name: "UpdateProject";
                O: typeof UpdateProjectResponse;
            };
        };
        typeName: "audiotool.project.v1.ProjectService";
    } = ...

    The ProjectService provides methods to manage studio projects.

    from service audiotool.project.v1.ProjectService

    Type declaration

    • Readonlymethods: {
          createProject: {
              I: typeof CreateProjectRequest;
              kind: Unary;
              name: "CreateProject";
              O: typeof CreateProjectResponse;
          };
          deleteProject: {
              I: typeof DeleteProjectRequest;
              kind: Unary;
              name: "DeleteProject";
              O: typeof DeleteProjectResponse;
          };
          getLatestVersionBundle: {
              I: typeof GetLatestVersionBundleRequest;
              kind: Unary;
              name: "GetLatestVersionBundle";
              O: typeof GetLatestVersionBundleResponse;
          };
          getProject: {
              I: typeof GetProjectRequest;
              kind: Unary;
              name: "GetProject";
              O: typeof GetProjectResponse;
          };
          listProjects: {
              I: typeof ListProjectsRequest;
              kind: Unary;
              name: "ListProjects";
              O: typeof ListProjectsResponse;
          };
          listSessions: {
              I: typeof ListSessionsRequest;
              kind: Unary;
              name: "ListSessions";
              O: typeof ListSessionsResponse;
          };
          openSession: {
              I: typeof OpenSessionRequest;
              kind: Unary;
              name: "OpenSession";
              O: typeof OpenSessionResponse;
          };
          reconvertLegacyProject: {
              I: typeof ReconvertLegacyProjectRequest;
              kind: Unary;
              name: "ReconvertLegacyProject";
              O: typeof ReconvertLegacyProjectResponse;
          };
          syncTrack: {
              I: typeof SyncTrackRequest;
              kind: Unary;
              name: "SyncTrack";
              O: typeof Operation;
          };
          updateProject: {
              I: typeof UpdateProjectRequest;
              kind: Unary;
              name: "UpdateProject";
              O: typeof UpdateProjectResponse;
          };
      }
      • Readonly GeneratedcreateProject: {
            I: typeof CreateProjectRequest;
            kind: Unary;
            name: "CreateProject";
            O: typeof CreateProjectResponse;
        }

        Create a project.

        from rpc audiotool.project.v1.ProjectService.CreateProject

      • Readonly GenerateddeleteProject: {
            I: typeof DeleteProjectRequest;
            kind: Unary;
            name: "DeleteProject";
            O: typeof DeleteProjectResponse;
        }

        Delete a project.

        from rpc audiotool.project.v1.ProjectService.DeleteProject

      • Readonly GeneratedgetLatestVersionBundle: {
            I: typeof GetLatestVersionBundleRequest;
            kind: Unary;
            name: "GetLatestVersionBundle";
            O: typeof GetLatestVersionBundleResponse;
        }

        Get Latest Version Bundle

        This returns the latest bundle version required for session to allow potential quicker pre-loading

        from rpc audiotool.project.v1.ProjectService.GetLatestVersionBundle

      • Readonly GeneratedgetProject: {
            I: typeof GetProjectRequest;
            kind: Unary;
            name: "GetProject";
            O: typeof GetProjectResponse;
        }

        Get a project.

        from rpc audiotool.project.v1.ProjectService.GetProject

      • Readonly GeneratedlistProjects: {
            I: typeof ListProjectsRequest;
            kind: Unary;
            name: "ListProjects";
            O: typeof ListProjectsResponse;
        }

        List the projects.option

        from rpc audiotool.project.v1.ProjectService.ListProjects

      • Readonly GeneratedlistSessions: {
            I: typeof ListSessionsRequest;
            kind: Unary;
            name: "ListSessions";
            O: typeof ListSessionsResponse;
        }

        List sessions.

        This gives all the sessions where a user can join and are active at the request time.

        from rpc audiotool.project.v1.ProjectService.ListSessions

      • Readonly GeneratedopenSession: {
            I: typeof OpenSessionRequest;
            kind: Unary;
            name: "OpenSession";
            O: typeof OpenSessionResponse;
        }

        Open a session. This will create a new session if one does not exist.

        This is used to allow multiple users to work on a project at the same time and opens the Document.

        from rpc audiotool.project.v1.ProjectService.OpenSession

      • Readonly GeneratedreconvertLegacyProject: {
            I: typeof ReconvertLegacyProjectRequest;
            kind: Unary;
            name: "ReconvertLegacyProject";
            O: typeof ReconvertLegacyProjectResponse;
        }

        ReconvertLegacyProject reconverts a legacy project from the old audiotool platform.

        This RPC will kick out all clients connected to the project and is only available for projects with a legacy_project_name set.

        from rpc audiotool.project.v1.ProjectService.ReconvertLegacyProject

      • Readonly GeneratedsyncTrack: {
            I: typeof SyncTrackRequest;
            kind: Unary;
            name: "SyncTrack";
            O: typeof Operation;
        }

        SyncTrack a will create or update a track.

        The project will be used as leading source for the track. This RPC kicks off a process where user can listen to via the events api.

        Another optimistic approach is to trigger GetTrack with the returned track_name.

        from rpc audiotool.project.v1.ProjectService.SyncTrack

      • Readonly GeneratedupdateProject: {
            I: typeof UpdateProjectRequest;
            kind: Unary;
            name: "UpdateProject";
            O: typeof UpdateProjectResponse;
        }

        Update a project.

        from rpc audiotool.project.v1.ProjectService.UpdateProject

    • ReadonlytypeName: "audiotool.project.v1.ProjectService"