Module livekit.agents.ipc.job_executor

Classes

class JobExecutor (*args, **kwargs)

Expand source code

class JobExecutor(Protocol):
    @property
    def started(self) -> bool: ...

    @property
    def user_arguments(self) -> Any | None: ...

    @user_arguments.setter
    def user_arguments(self, value: Any | None) -> None: ...

    @property
    def running_job(self) -> RunningJobInfo | None: ...

    @property
    def status(self) -> JobStatus: ...

    async def start(self) -> None: ...

    async def join(self) -> None: ...

    async def initialize(self) -> None: ...

    async def aclose(self) -> None: ...

    async def launch_job(self, info: RunningJobInfo) -> None: ...

Base class for protocol classes.

Protocol classes are defined as::

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example::

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as::

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

Ancestors

• typing.Protocol
• typing.Generic

Instance variables

prop running_job : RunningJobInfo | None

Expand source code

@property
def running_job(self) -> RunningJobInfo | None: ...

prop started : bool

Expand source code

@property
def started(self) -> bool: ...

prop status : JobStatus

Expand source code

@property
def status(self) -> JobStatus: ...

prop user_arguments : Any | None

Expand source code

@property
def user_arguments(self) -> Any | None: ...

Methods

async def aclose(self) ‑> None

Expand source code

async def aclose(self) -> None: ...

async def initialize(self) ‑> None

Expand source code

async def initialize(self) -> None: ...

async def join(self) ‑> None

Expand source code

async def join(self) -> None: ...

async def launch_job(self, info: RunningJobInfo) ‑> None

Expand source code

async def launch_job(self, info: RunningJobInfo) -> None: ...

async def start(self) ‑> None

Expand source code

async def start(self) -> None: ...

class JobStatus (*args, **kwds)

Expand source code

class JobStatus(Enum):
    RUNNING = "running"
    FAILED = "failed"
    SUCCESS = "success"

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

• attribute access:

Color.RED

• value lookup:

Color(1)

• name lookup:

Color['RED']

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

Ancestors

• enum.Enum

Class variables

var FAILED

var RUNNING

var SUCCESS