Struct LiveKitModule 

pub struct LiveKitModule { /* private fields */ }

Implementations

impl LiveKitModule

pub fn mute( &self, ctx: &mut ModuleContext<'_, LiveKitModule>, sender: Option<ParticipantId>, participants: BTreeSet<ParticipantId>, return_channel: Sender<ParticipantsMuted>, )

Trait Implementations

impl SignalingModule for LiveKitModule

const NAMESPACE: ModuleId = LIVEKIT_MODULE_ID

The unique namespace for the module

type Incoming = LiveKitCommand

The incoming websocket payload which is received as in SignalingModule::on_websocket_message

type Outgoing = LiveKitEvent

The outgoing websocket payload that is sent to the clients

type Internal = LiveKitInternal

The incoming command which is received from other SignalingModules

type Loopback = Result<LiveKitLoopback, LiveKitError>

Internal result type for asynchronous tasks

type JoinInfo = LiveKitState

Namespaced data that can be attached to a participants JoinSuccess message

type PeerJoinInfo = ()

Namespaced data that can be attached to the Joined message

type Error = LiveKitError

The non-fatal error that can be returned from signaling module event handlers

fn init(init_data: SignalingModuleInitData) -> Option<Self>

Creates an instance of the interface to access the module

fn on_participant_joined( &mut self, ctx: &mut ModuleContext<'_, Self>, participant_id: ParticipantId, connection_id: ConnectionId, _is_first_connection: bool, ) -> Result<ModuleJoinData<Self>, SignalingModuleError<Self::Error>>

fn on_participant_disconnected( &mut self, ctx: &mut ModuleContext<'_, Self>, participant_id: ParticipantId, connection_id: ConnectionId, ) -> Result<(), SignalingModuleError<Self::Error>>

fn on_websocket_message( &mut self, ctx: &mut ModuleContext<'_, Self>, sender: ParticipantId, connection_id: ConnectionId, payload: Self::Incoming, ) -> Result<(), SignalingModuleError<Self::Error>>

fn on_loopback_event( &mut self, ctx: &mut ModuleContext<'_, Self>, event: Self::Loopback, ) -> Result<(), SignalingModuleError<Self::Error>>

fn on_internal_command( &mut self, ctx: &mut ModuleContext<'_, Self>, command: Self::Internal, ) -> Result<(), SignalingModuleError<Self::Error>>

fn on_closing(&mut self, ctx: &mut ModuleContext<'_, Self>) -> Result<(), Error>

Destroy the module and remove all associated resources

fn on_breakout_start( &mut self, ctx: &mut ModuleContext<'_, Self>, rooms: &[BreakoutRoom], _duration: Option<Duration>, ) -> Result<(), SignalingModuleError<Self::Error>>

fn on_breakout_switch( &mut self, ctx: &mut ModuleContext<'_, Self>, participant_id: ParticipantId, old_room: RoomKind, new_room: RoomKind, ) -> Result<ModuleSwitchData<Self>, SignalingModuleError<Self::Error>>

fn on_breakout_closed( &mut self, ctx: &mut ModuleContext<'_, Self>, ) -> Result<(), SignalingModuleError<Self::Error>>

fn on_websocket_message_waiting_room( &mut self, ctx: &mut ModuleContext<'_, Self>, sender: ParticipantId, connection_id: ConnectionId, payload: Self::Incoming, ) -> Result<(), SignalingModuleError<Self::Error>>

fn on_breakout_closing( &mut self, ctx: &mut ModuleContext<'_, Self>, ) -> Result<(), SignalingModuleError<Self::Error>>

impl SignalingModuleDescription for LiveKitModule

const MODULE_ID: ModuleId = LIVEKIT_MODULE_ID

const DESCRIPTION: &'static str = "Handles Livekit media streams coordination and integration"

const FEATURES: &[SignalingModuleFeatureDescription]