producers/socket_receive_methods/panelist_receive_methods library
Handler for panelist-related socket events.
Listens for:
- panelistsUpdated: When the panelist list changes
- addedAsPanelist: When current user is added as a panelist
- removedFromPanelists: When current user is removed from panelists
- panelistFocusChanged: When focus mode is toggled
- controlMedia: When media is controlled (mute) due to focus mode
Classes
- AddedAsPanelistData
- Data received when added as panelist.
- AddedAsPanelistOptions
- Options for handling addedAsPanelist event.
- ControlMediaData
- Data received when media control is requested.
- ControlMediaOptions
- Options for handling controlMedia event.
- PanelistData
- Panelist data received from socket.
- PanelistFocusChangedData
- Data received when panelist focus mode changes.
- PanelistFocusChangedOptions
- Options for handling panelistFocusChanged event.
- PanelistsUpdatedData
- Data received when panelists list is updated.
- PanelistsUpdatedOptions
- Options for handling panelistsUpdated event.
- RemovedFromPanelistsData
- Data received when removed from panelists.
- RemovedFromPanelistsOptions
- Options for handling removedFromPanelists event.
Functions
-
addedAsPanelist(
AddedAsPanelistOptions options) → Future< void> - Handles the addedAsPanelist socket event. Called when current user is added as a panelist.
-
controlMedia(
ControlMediaOptions options) → Future< void> - Handles the controlMedia socket event. Called when media needs to be controlled due to focus mode.
-
panelistFocusChanged(
PanelistFocusChangedOptions options) → Future< void> - Handles the panelistFocusChanged socket event. Called when the host toggles focus mode on/off.
-
panelistsUpdated(
PanelistsUpdatedOptions options) → Future< void> - Handles the panelistsUpdated socket event. Called when the panelist list changes.
-
removedFromPanelists(
RemovedFromPanelistsOptions options) → Future< void> - Handles the removedFromPanelists socket event. Called when current user is removed from panelists.
Typedefs
-
AddedAsPanelistType
= Future<
void> Function(AddedAsPanelistOptions options) -
ControlMediaType
= Future<
void> Function(ControlMediaOptions options) -
PanelistFocusChangedType
= Future<
void> Function(PanelistFocusChangedOptions options) -
PanelistsUpdatedType
= Future<
void> Function(PanelistsUpdatedOptions options) -
RemovedFromPanelistsType
= Future<
void> Function(RemovedFromPanelistsOptions options) - VoidCallback = void Function()