A request sent by the server to spawn a new agent job.

Remarks

For most applications, this is best left to the default, which simply accepts the job and handles the logic inside the entrypoint function. This class is useful for vetting which requests should fill idle processes and which should be outright rejected.

Accessors

  • get id(): string
  • Returns string

    The ID of the job, set by the LiveKit server

Methods

  • Accepts the job, launching it on an idle child process.

    Parameters

    • name: string = ''
    • identity: string = ''
    • metadata: string = ''

    Returns Promise<void>