Enum RoomEvent 

#[non_exhaustive]
pub enum RoomEvent {
    ParticipantConnected(RemoteParticipant),
    ParticipantActive(RemoteParticipant),
    ParticipantDisconnected(RemoteParticipant),
    LocalTrackPublished {
        publication: LocalTrackPublication,
        track: LocalTrack,
        participant: LocalParticipant,
    },
    LocalTrackUnpublished {
        publication: LocalTrackPublication,
        participant: LocalParticipant,
    },
    LocalTrackSubscribed {
        track: LocalTrack,
    },
    TrackSubscribed {
        track: RemoteTrack,
        publication: RemoteTrackPublication,
        participant: RemoteParticipant,
    },
    TrackUnsubscribed {
        track: RemoteTrack,
        publication: RemoteTrackPublication,
        participant: RemoteParticipant,
    },
    TrackSubscriptionFailed {
        participant: RemoteParticipant,
        error: TrackError,
        track_sid: TrackSid,
    },
    TrackPublished {
        publication: RemoteTrackPublication,
        participant: RemoteParticipant,
    },
    TrackUnpublished {
        publication: RemoteTrackPublication,
        participant: RemoteParticipant,
    },
    TrackMuted {
        participant: Participant,
        publication: TrackPublication,
    },
    TrackUnmuted {
        participant: Participant,
        publication: TrackPublication,
    },
    RoomMetadataChanged {
        old_metadata: String,
        metadata: String,
    },
    ParticipantMetadataChanged {
        participant: Participant,
        old_metadata: String,
        metadata: String,
    },
    ParticipantNameChanged {
        participant: Participant,
        old_name: String,
        name: String,
    },
    ParticipantAttributesChanged {
        participant: Participant,
        changed_attributes: HashMap<String, String>,
    },
    ParticipantEncryptionStatusChanged {
        participant: Participant,
        is_encrypted: bool,
    },
    ParticipantPermissionChanged {
        participant: Participant,
        permission: Option<ParticipantPermission>,
    },
    ActiveSpeakersChanged {
        speakers: Vec<Participant>,
    },
    ConnectionQualityChanged {
        quality: ConnectionQuality,
        participant: Participant,
    },
    DataReceived {
        payload: Arc<Vec<u8>>,
        topic: Option<String>,
        kind: DataPacketKind,
        participant: Option<RemoteParticipant>,
    },
    TranscriptionReceived {
        participant: Option<Participant>,
        track_publication: Option<TrackPublication>,
        segments: Vec<TranscriptionSegment>,
    },
    SipDTMFReceived {
        code: u32,
        digit: Option<String>,
        participant: Option<RemoteParticipant>,
    },
    ChatMessage {
        message: ChatMessage,
        participant: Option<RemoteParticipant>,
    },
    ByteStreamOpened {
        reader: TakeCell<ByteStreamReader>,
        topic: String,
        participant_identity: ParticipantIdentity,
    },
    TextStreamOpened {
        reader: TakeCell<TextStreamReader>,
        topic: String,
        participant_identity: ParticipantIdentity,
    },
    StreamHeaderReceived {
        header: Header,
        participant_identity: String,
    },
    StreamChunkReceived {
        chunk: Chunk,
        participant_identity: String,
    },
    StreamTrailerReceived {
        trailer: Trailer,
        participant_identity: String,
    },
    E2eeStateChanged {
        participant: Participant,
        state: EncryptionState,
    },
    ConnectionStateChanged(ConnectionState),
    Connected {
        participants_with_tracks: Vec<(RemoteParticipant, Vec<RemoteTrackPublication>)>,
    },
    Disconnected {
        reason: DisconnectReason,
    },
    Reconnecting,
    Reconnected,
    DataChannelBufferedAmountLowThresholdChanged {
        kind: DataPacketKind,
        threshold: u64,
    },
    RoomUpdated {
        room: RoomInfo,
    },
    Moved {
        room: RoomInfo,
    },
    ParticipantsUpdated {
        participants: Vec<Participant>,
    },
    TokenRefreshed {
        token: String,
    },
    DataTrackPublished(RemoteDataTrack),
    DataTrackUnpublished(DataTrackSid),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ParticipantConnected(RemoteParticipant)

Remote participant joined the room.

This event is fired immediately after a participant joins before it is able to receive data messages. To send data messages in response to a participant joining, respond to the Self::ParticipantActive event instead.

ParticipantActive(RemoteParticipant)

Remote participant is active and ready to receive data messages.

ParticipantDisconnected(RemoteParticipant)

Remote participant disconnected from the room.

LocalTrackPublished

Fields

publication: LocalTrackPublication

track: LocalTrack

participant: LocalParticipant

LocalTrackUnpublished

Fields

publication: LocalTrackPublication

participant: LocalParticipant

LocalTrackSubscribed

Fields

track: LocalTrack

TrackSubscribed

Fields

track: RemoteTrack

publication: RemoteTrackPublication

participant: RemoteParticipant

TrackUnsubscribed

Fields

track: RemoteTrack

publication: RemoteTrackPublication

participant: RemoteParticipant

TrackSubscriptionFailed

Fields

participant: RemoteParticipant

error: TrackError

track_sid: TrackSid

TrackPublished

Fields

publication: RemoteTrackPublication

participant: RemoteParticipant

TrackUnpublished

Fields

publication: RemoteTrackPublication

participant: RemoteParticipant

TrackMuted

Fields

participant: Participant

publication: TrackPublication

TrackUnmuted

Fields

participant: Participant

publication: TrackPublication

RoomMetadataChanged

Fields

old_metadata: String

metadata: String

ParticipantMetadataChanged

Fields

participant: Participant

old_metadata: String

metadata: String

ParticipantNameChanged

Fields

participant: Participant

old_name: String

name: String

ParticipantAttributesChanged

Fields

participant: Participant

changed_attributes: HashMap<String, String>

ParticipantEncryptionStatusChanged

Fields

participant: Participant

is_encrypted: bool

ParticipantPermissionChanged

Fields

participant: Participant

permission: Option<ParticipantPermission>

ActiveSpeakersChanged

Fields

speakers: Vec<Participant>

ConnectionQualityChanged

Fields

quality: ConnectionQuality

participant: Participant

DataReceived

Fields

payload: Arc<Vec<u8>>

topic: Option<String>

kind: DataPacketKind

participant: Option<RemoteParticipant>

TranscriptionReceived

Fields

participant: Option<Participant>

track_publication: Option<TrackPublication>

segments: Vec<TranscriptionSegment>

SipDTMFReceived

Fields

code: u32

digit: Option<String>

participant: Option<RemoteParticipant>

ChatMessage

Fields

message: ChatMessage

participant: Option<RemoteParticipant>

ByteStreamOpened

Fields

reader: TakeCell<ByteStreamReader>

topic: String

participant_identity: ParticipantIdentity

TextStreamOpened

Fields

reader: TakeCell<TextStreamReader>

topic: String

participant_identity: ParticipantIdentity

StreamHeaderReceived

👎Deprecated:

Use high-level data streams API instead.

Fields

header: Header

👎Deprecated:

Use high-level data streams API instead.

participant_identity: String

👎Deprecated:

Use high-level data streams API instead.

StreamChunkReceived

👎Deprecated:

Use high-level data streams API instead.

Fields

chunk: Chunk

👎Deprecated:

Use high-level data streams API instead.

participant_identity: String

👎Deprecated:

Use high-level data streams API instead.

StreamTrailerReceived

👎Deprecated:

Use high-level data streams API instead.

Fields

trailer: Trailer

👎Deprecated:

Use high-level data streams API instead.

participant_identity: String

👎Deprecated:

Use high-level data streams API instead.

E2eeStateChanged

Fields

participant: Participant

state: EncryptionState

ConnectionStateChanged(ConnectionState)

Connected

Fields

participants_with_tracks: Vec<(RemoteParticipant, Vec<RemoteTrackPublication>)>

Initial participants & their tracks prior to joining the room We’re not returning this directly inside Room::connect because it is unlikely to be used

Disconnected

Fields

reason: DisconnectReason

Reconnecting

Reconnected

DataChannelBufferedAmountLowThresholdChanged

Fields

kind: DataPacketKind

threshold: u64

RoomUpdated

Fields

room: RoomInfo

Moved

Fields

room: RoomInfo

ParticipantsUpdated

Fields

participants: Vec<Participant>

TokenRefreshed

Fields

token: String

DataTrackPublished(RemoteDataTrack)

A remote participant published a data track.

DataTrackUnpublished(DataTrackSid)

A remote participant has unpublished a data track.

Trait Implementations

impl Clone for RoomEvent

fn clone(&self) -> RoomEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RoomEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.