SpeakInstruction

class SpeakInstruction[source]

Bases: BaseInstruction

Define the common interface for speech-based instructions.

abstract property id: int

Return the unique speech instruction identifier.

Returns:

Speech instruction identifier.

Return type:

int

abstractmethod perform(speaker: BaseSpeaker, *args, **kwargs) → BaseUi[source]

Execute the instruction with a speaker backend.

Parameters:

  • speaker (BaseSpeaker) – Speaker used to synthesize or play speech.

  • args – Additional positional arguments for the execution flow.

  • kwargs – Additional keyword arguments for the execution flow.

Returns:

Updated UI state when the implementation returns it.

Return type:

BaseUi