Events Reference

This is a list of events emitted by the SDK and the various plugin types.

This event system provides a unified, event-driven architecture that allows plugins to be composed and integrated into audio processing pipelines.

Events Emitted by Plugins

All plugins inherit from base classes (STT, TTS, VAD, STS) that define standard event patterns using AsyncIOEventEmitter. Events include rich metadata for debugging and monitoring.

Note: all audio events use PCM format.

Events Emitted by the Python AI SDK

Notes

1. Event Architecture: The RTC module uses a hierarchical event system where:
   • Low-level components emit specific events
   • Higher-level managers aggregate and forward events
   • SFU events are automatically forwarded from the signaling layer

2. SFU Events: All SFU (Selective Forwarding Unit) events are automatically forwarded through the signaling layer, providing real-time updates about call state, participants, media streams, and connection quality. SFU events can be listened to from the SDK as they are forwarded by the ConnectionManager class.

A full list of SFU events Stream emits is also available.

3. Recording Events: Comprehensive recording event system supports both per-user and composite recording with detailed lifecycle tracking.

4. Network Monitoring: Built-in network monitoring provides connectivity state changes for robust connection handling.

5. WebRTC Integration: Events closely follow WebRTC standards for peer connection management, ICE handling, and media track lifecycle.

Usage Example

from getstream.video import rtc

# Connect to a call
async with await rtc.join(call, user_id) as connection:
    # Listen for participant events
    @connection.on("participant_joined")
    async def on_participant_joined(participant):
        print(f"Participant {participant.user_id} joined")

    # Listen for audio data
    @connection.on("audio")
    async def on_audio(pcm_data, user):
        print(f"Received audio from {user}")

    # Listen for connection state changes
    @connection.on("connection.state_changed")
    async def on_connection_state_changed(event):
        print(f"Connection state: {event['old']} -> {event['new']}")

    # Wait for the connection to end
    await connection.wait()