Class JobContext

The job and environment context as seen by the agent, accessible by the entrypoint function.

Index

Constructors

Accessors

agent inferenceExecutor info job proc room sessionDirectory workerId

Methods

_onSessionEnd addParticipantEntrypoint addShutdownCallback connect initRecording makeSessionReport shutdown waitForParticipant

Constructors

constructor

new JobContext(proc, info, room, onConnect, onShutdown, inferenceExecutor): JobContext
Parameters
- proc: JobProcess
- info: RunningJobInfo
- room: Room
- onConnect: (() => void)
  - - (): void
    - Returns void
- onShutdown: ((s) => void)
  - - (s): void
    - Parameters
      s: string
      Returns void
- inferenceExecutor: InferenceExecutor
Returns JobContext
- Defined in job.ts:114

Accessors

agent

get agent(): undefined | LocalParticipant
Returns undefined | LocalParticipant
The agent's participant if connected to the room, otherwise undefined
- Defined in job.ts:156

inferenceExecutor

get inferenceExecutor(): InferenceExecutor
Returns InferenceExecutor
The global inference executor
- Defined in job.ts:161

info

get info(): RunningJobInfo
Returns RunningJobInfo
- Defined in job.ts:151

job

get job(): Job
Returns Job
- Defined in job.ts:138

proc

get proc(): JobProcess
Returns JobProcess
- Defined in job.ts:134

room

get room(): Room
Returns Room
The room the agent was called into
- Defined in job.ts:147

sessionDirectory

get sessionDirectory(): string
Returns string
The session directory for storing recordings and session data.
- Defined in job.ts:168

workerId

get workerId(): string
Returns string
- Defined in job.ts:142

Methods

_onSessionEnd

_onSessionEnd(): Promise<void>
Returns Promise<void>
- Defined in job.ts:286

addParticipantEntrypoint

addParticipantEntrypoint(callback): void
Adds a promise to be awaited whenever a new participant joins the room.
Parameters
- callback: ((job, p) => Promise<void>)
  - - (job, p): Promise<void>
    - Parameters
      job: JobContext
      p: RemoteParticipant
      Returns Promise<void>
Returns void
Throws
FunctionExistsError if an entrypoint already exists
- Defined in job.ts:366

addShutdownCallback

addShutdownCallback(callback): void
Adds a promise to be awaited when shutdown is called.
Parameters
- callback: (() => Promise<void>)
  - - (): Promise<void>
    - Returns Promise<void>
Returns void
- Defined in job.ts:173

connect

connect(e2ee?, autoSubscribe?, rtcConfig?): Promise<void>
Connects the agent to the room.
Parameters
- Optional e2ee: E2EEOptions
- autoSubscribe: AutoSubscribe = AutoSubscribe.SUBSCRIBE_ALL
- Optional rtcConfig: RtcConfiguration
Returns Promise<void>
Remarks
It is recommended to run this command as early in the function as possible, as executing it later may cause noticeable delay between user and agent joins.

See
@livekit/rtc-node for more information about the parameters.
- Defined in job.ts:223

initRecording

initRecording(): Promise<void>
Returns Promise<void>
- Defined in job.ts:374

makeSessionReport

makeSessionReport(session?): SessionReport
Parameters
- Optional session: AgentSession<unknown>
Returns SessionReport
- Defined in job.ts:259

shutdown

shutdown(reason?): void
Gracefully shuts down the job, and runs all shutdown promises.
Parameters
- reason: string = ''
  Optional reason for shutdown
Returns void
- Defined in job.ts:342

waitForParticipant

waitForParticipant(identity?): Promise<RemoteParticipant>
Parameters
- Optional identity: string
Returns Promise<RemoteParticipant>
- Defined in job.ts:177