agent

Oct 17, 2025

Changes in this version

+ const AgentNameAttributeKey

+ type Config struct

+ EnableUserDataRecording bool

Sep 5, 2025

Changes in this version

type WorkerRegistration

+ AgentID string

Jun 5, 2025

Changes in this version

type WorkerRegistration

+ ClientIP string

+ func MakeWorkerRegistration() WorkerRegistration

Mar 2, 2025

Changes in this version

+ const ParticipantAgentTopic

Oct 19, 2024

Changes in this version

+ const AssignJobTimeout

+ const RegisterTimeout

+ var ErrJobNotFound = psrpc.NewErrorf(psrpc.NotFound, "no running job for given jobID")

+ var ErrUnimplementedWrorkerSignal = errors.New("unimplemented worker signal")

+ var ErrUnknownJobType = errors.New("unknown job type")

+ var ErrUnknownWorkerSignal = errors.New("unknown worker signal")

+ func DispatchWorkerSignal(req *livekit.WorkerMessage, h WorkerSignalHandler) error

type SignalConn

+ SetReadDeadline func(time.Time) error

+ type UnimplementedWorkerSignalHandler struct

+ func (UnimplementedWorkerSignalHandler) HandleAvailability(*livekit.AvailabilityResponse) error

+ func (UnimplementedWorkerSignalHandler) HandleMigrateJob(*livekit.MigrateJobRequest) error

+ func (UnimplementedWorkerSignalHandler) HandlePing(*livekit.WorkerPing) error

+ func (UnimplementedWorkerSignalHandler) HandleRegister(*livekit.RegisterWorkerRequest) error

+ func (UnimplementedWorkerSignalHandler) HandleSimulateJob(*livekit.SimulateJobRequest) error

+ func (UnimplementedWorkerSignalHandler) HandleUpdateJob(*livekit.UpdateJobStatus) error

+ func (UnimplementedWorkerSignalHandler) HandleUpdateWorker(*livekit.UpdateWorkerStatus) error

type Worker

+ func (w *Worker) GetJobState(jobID livekit.JobID) (*livekit.JobState, error)

+ func (w *Worker) HandleAvailability(res *livekit.AvailabilityResponse) error

+ func (w *Worker) HandleMigrateJob(req *livekit.MigrateJobRequest) error

+ func (w *Worker) HandleSimulateJob(simulate *livekit.SimulateJobRequest) error

+ func (w *Worker) HandleUpdateJob(update *livekit.UpdateJobStatus) error

+ func (w *Worker) HandleUpdateWorker(update *livekit.UpdateWorkerStatus) error

+ func (w *Worker) RunningJobCount() int

+ func (w *Worker) UpdateJobStatus(update *livekit.UpdateJobStatus) (*livekit.JobState, error)

+ type WorkerPingHandler struct

+ func (h WorkerPingHandler) HandlePing(ping *livekit.WorkerPing) error

+ type WorkerRegisterer struct

+ func NewWorkerRegisterer(conn SignalConn, serverInfo *livekit.ServerInfo, ...) *WorkerRegisterer

+ func (h *WorkerRegisterer) Deadline() time.Time

+ func (h *WorkerRegisterer) HandleRegister(req *livekit.RegisterWorkerRequest) error

+ func (h *WorkerRegisterer) Registered() bool

+ func (h *WorkerRegisterer) Registration() WorkerRegistration

+ type WorkerRegistration struct

+ AgentName string

+ ID string

+ JobType livekit.JobType

+ Namespace string

+ Permissions *livekit.ParticipantPermission

+ Protocol WorkerProtocolVersion

+ Version string

+ type WorkerSignalHandler interface

+ HandleAvailability func(*livekit.AvailabilityResponse) error

+ HandleMigrateJob func(*livekit.MigrateJobRequest) error

+ HandlePing func(*livekit.WorkerPing) error

+ HandleRegister func(*livekit.RegisterWorkerRequest) error

+ HandleSimulateJob func(*livekit.SimulateJobRequest) error

+ HandleUpdateJob func(*livekit.UpdateJobStatus) error

+ HandleUpdateWorker func(*livekit.UpdateWorkerStatus) error

Aug 11, 2024

Changes in this version

+ var ErrDuplicateJobAssignment = errors.New("duplicate job assignment")

+ func GetAgentTopic(agentName, namespace string) string

+ func JobStatusIsEnded(s livekit.JobStatus) bool

type Client

+ TerminateJob func(ctx context.Context, jobID string, reason rpc.JobTerminateReason) (*livekit.JobState, error)

+ type JobRequest struct

+ AgentName string

+ DispatchId string

+ JobType livekit.JobType

+ Metadata string

+ Participant *livekit.ParticipantInfo

+ Room *livekit.Room

+ type SignalConn interface

+ Close func() error

+ ReadWorkerMessage func() (*livekit.WorkerMessage, int, error)

+ WriteServerMessage func(msg *livekit.ServerMessage) (int, error)

+ type UnimplementedWorkerHandler struct

+ func (UnimplementedWorkerHandler) HandleWorkerDeregister(*Worker)

+ func (UnimplementedWorkerHandler) HandleWorkerJobStatus(*Worker, *livekit.UpdateJobStatus)

+ func (UnimplementedWorkerHandler) HandleWorkerMigrateJob(*Worker, *livekit.MigrateJobRequest)

+ func (UnimplementedWorkerHandler) HandleWorkerRegister(*Worker)

+ func (UnimplementedWorkerHandler) HandleWorkerSimulateJob(*Worker, *livekit.Job)

+ func (UnimplementedWorkerHandler) HandleWorkerStatus(*Worker, *livekit.UpdateWorkerStatus)

type Worker

+ func (w *Worker) AgentName() string

+ func (w *Worker) TerminateJob(jobID string, reason rpc.JobTerminateReason) (*livekit.JobState, error)

+ type WorkerHandler interface

+ HandleWorkerDeregister func(w *Worker)

+ HandleWorkerJobStatus func(w *Worker, status *livekit.UpdateJobStatus)

+ HandleWorkerMigrateJob func(w *Worker, request *livekit.MigrateJobRequest)

+ HandleWorkerRegister func(w *Worker)

+ HandleWorkerSimulateJob func(w *Worker, job *livekit.Job)

+ HandleWorkerStatus func(w *Worker, status *livekit.UpdateWorkerStatus)

Apr 11, 2024

Changes in this version

+ const CheckEnabledTimeout

+ const CurrentProtocol

+ const DefaultHandlerNamespace

+ const EnabledCacheTTL

+ const PublisherAgentTopic

+ const RoomAgentTopic

+ var ErrAvailabilityTimeout = errors.New("agent worker availability timeout")

+ var ErrWorkerClosed = errors.New("worker closed")

+ var ErrWorkerNotAvailable = errors.New("worker not available")

+ type Client interface

+ LaunchJob func(ctx context.Context, desc *JobDescription)

+ Stop func() error

+ func NewAgentClient(bus psrpc.MessageBus) (Client, error)

+ type Job struct

+ Logger logger.Logger

+ func NewJob(id, namespace string, jobType livekit.JobType) *Job

+ func (j *Job) ID() string

+ func (j *Job) Namespace() string

+ func (j *Job) Type() livekit.JobType

+ func (j *Job) UpdateMetadata(metadata string)

+ func (j *Job) UpdateStatus(req *livekit.UpdateJobStatus)

+ func (j *Job) WorkerLoad() float32

+ type JobDescription struct

+ JobType livekit.JobType

+ Participant *livekit.ParticipantInfo

+ Room *livekit.Room

+ type Worker struct

+ Logger logger.Logger

+ func NewWorker(protocolVersion WorkerProtocolVersion, apiKey string, apiSecret string, ...) *Worker

+ func (w *Worker) AssignJob(ctx context.Context, job *livekit.Job) error

+ func (w *Worker) Close()

+ func (w *Worker) HandleMessage(req *livekit.WorkerMessage)

+ func (w *Worker) ID() string

+ func (w *Worker) IsClosed() bool

+ func (w *Worker) JobType() livekit.JobType

+ func (w *Worker) Load() float32

+ func (w *Worker) Namespace() string

+ func (w *Worker) OnWorkerRegistered(f func(w *Worker))

+ func (w *Worker) Registered() bool

+ func (w *Worker) RunningJobs() map[string]*Job

+ func (w *Worker) Status() livekit.WorkerStatus

+ func (w *Worker) UpdateMetadata(metadata string)

+ func (w *Worker) UpdateStatus(status *livekit.UpdateWorkerStatus)

+ type WorkerProtocolVersion int