producers library
Classes
- LanguageEntry
- Language entry with optional per-language voice config
- ListenerOverride
- Listener override for speaker output
- TranslationChannelsAvailableData
- TranslationChannelsAvailableOptions
- TranslationConfigUpdatedData
- TranslationConfigUpdatedOptions
- TranslationErrorData
- TranslationErrorOptions
- TranslationLanguageSetData
- TranslationLanguageSetOptions
- TranslationMemberStateData
- TranslationMemberStateOptions
- TranslationProducerClosedData
- TranslationProducerClosedOptions
- TranslationProducerReadyData
- TranslationProducerReadyOptions
- TranslationRoomConfig
- Room-level translation configuration
- TranslationRoomConfigData
- TranslationRoomConfigOptions
- TranslationSpeakerOutputChangedData
- TranslationSpeakerOutputChangedOptions
- TranslationSubscribedData
- TranslationSubscribedOptions
- TranslationTranscriptData
- TranslationTranscriptOptions
- TranslationUnsubscribedData
- TranslationUnsubscribedOptions
Enums
- LanguageMode
- Language mode for allowlist/blocklist filtering
Functions
-
allMembers(
AllMembersOptions options) → Future< void> - Manages all members and updates the UI.
-
allMembersRest(
AllMembersRestOptions options) → Future< void> - Main function to handle participant updates, settings, and server connections in the room.
-
allWaitingRoomMembers(
AllWaitingRoomMembersOptions options) → Future< void> - Updates the waiting room participants list and the total count of waiting room participants.
-
banParticipant(
BanParticipantOptions options) → Future< void> - Bans a participant by removing them from the active and display names lists, updating the participants list, and reordering the streams if necessary.
-
controlMediaHost(
ControlMediaHostOptions options) → Future< void> - Controls media actions based on the specified ControlMediaHostOptions.
-
disconnect(
DisconnectOptions options) → void - Disconnects the user from the session, updating the necessary state and triggering alerts if needed.
-
disconnectUserSelf(
DisconnectUserSelfOptions options) → Future< void> - Disconnects the user from the specified room and bans them.
-
getDomains(
GetDomainsOptions options) → Future< void> - Connects to specified domains, processes IPs, and handles domain-related connections.
-
hostRequestResponse(
HostRequestResponseOptions options) → Future< void> -
meetingEnded(
{required MeetingEndedOptions options}) → Future< void> - Handles the end of a meeting by showing an alert and performing a redirect if necessary.
-
meetingStillThere(
{required MeetingStillThereOptions options}) → Future< void> - Updates the visibility of the "still there?" modal in a meeting.
-
meetingTimeRemaining(
{required MeetingTimeRemainingOptions options}) → Future< void> - Updates the meeting time remaining and shows an alert if the event type is not 'chat'.
-
participantRequested(
ParticipantRequestedOptions options) → void - Handles the participant request to join the event.
-
personJoined(
PersonJoinedOptions options) → void - Function that handles a person joining an event.
-
producerMediaClosed(
ProducerMediaClosedOptions options) → Future< void> - Handles the closure of a media producer's stream or screenshare.
-
producerMediaPaused(
ProducerMediaPausedOptions options) → Future< void> - Pauses the media for a producer based on specified parameters.
-
producerMediaResumed(
ProducerMediaResumedOptions options) → Future< void> - Resumes media for a specified participant in a meeting.
-
receiveMessage(
ReceiveMessageOptions options) → Future< void> - Processes an incoming message and updates the message list and badge display based on specified rules. Filters out messages from banned participants and categorizes messages into group and direct. Displays a badge for new messages if certain conditions are met.
-
recordingNotice(
RecordingNoticeOptions options) → Future< void> - Handles recording state changes and updates recording settings accordingly.
-
reInitiateRecording(
ReInitiateRecordingOptions options) → Future< void> - Re-initiates the recording for a specified room and member.
-
roomRecordParams(
RoomRecordParamsOptions options) → void -
Updates various recording parameters based on the provided
recordParams. -
screenProducerId(
ScreenProducerIdOptions options) → void - Manages and updates screen sharing based on the producer ID.
-
startRecords(
StartRecordsOptions options) → Future< void> - Starts recording for a specified room.
-
stoppedRecording(
StoppedRecordingOptions options) → Future< void> - Displays an alert message when the recording has stopped, indicating the reason.
-
timeLeftRecording(
TimeLeftRecordingOptions options) → void - Displays an alert message indicating the remaining time left for recording.
-
translationChannelsAvailable(
TranslationChannelsAvailableOptions options) → Future< void> - Handles the translation:channelsAvailable socket event. Called when a speaker has translation channels available.
-
translationConfigUpdated(
TranslationConfigUpdatedOptions options) → Future< void> - Handles the translation:configUpdated socket event. Called when the host changes room translation settings.
-
translationError(
TranslationErrorOptions options) → Future< void> - Handles the translation:error socket event. Called when a translation operation fails.
-
translationLanguageSet(
TranslationLanguageSetOptions options) → Future< void> - Handles the translation:languageSet socket event. Called when the user's spoken language is confirmed.
-
translationMemberState(
TranslationMemberStateOptions options) → Future< void> - Handles the translation:memberState socket event. Called when another member's translation state changes.
-
translationProducerClosed(
TranslationProducerClosedOptions options) → Future< void> - Handles the translation:producerClosed socket event. Called when a translation producer is closed.
-
translationProducerReady(
TranslationProducerReadyOptions options) → Future< void> - Handles the translation:producerReady socket event. Called when a translation producer is ready for consumption.
-
translationRoomConfig(
TranslationRoomConfigOptions options) → Future< void> - Handles the translation:roomConfig socket event. Called when joining a room to receive room-level translation configuration.
-
translationSpeakerOutputChanged(
TranslationSpeakerOutputChangedOptions options) → Future< void> - Handles the translation:speakerOutputChanged socket event. Called when a speaker changes their output language.
-
translationSubscribed(
TranslationSubscribedOptions options) → Future< void> - Handles the translation:subscribed socket event. Called when successfully subscribed to a translation channel.
-
translationTranscript(
TranslationTranscriptOptions options) → Future< void> - Handles the translation:transcript socket event. Called when a translation transcript (text) is available for display.
-
translationUnsubscribed(
TranslationUnsubscribedOptions options) → Future< void> - Handles the translation:unsubscribed socket event. Called when unsubscribed from a translation channel.
-
updateConsumingDomains(
UpdateConsumingDomainsOptions options) → void - Updates consuming domains based on the provided options.
-
updatedCoHost(
UpdatedCoHostOptions options) → void - Updates co-host information and responsibilities based on provided options.
-
updateMediaSettings(
UpdateMediaSettingsOptions options) → void - Updates media settings by calling the respective update functions for each setting type.
-
userWaiting(
UserWaitingOptions options) → void - Handles the event when a user joins the waiting room.
Typedefs
-
TranslationChannelsAvailableType
= Future<
void> Function(TranslationChannelsAvailableOptions options) -
TranslationConfigUpdatedType
= Future<
void> Function(TranslationConfigUpdatedOptions options) -
TranslationErrorType
= Future<
void> Function(TranslationErrorOptions options) -
TranslationLanguageSetType
= Future<
void> Function(TranslationLanguageSetOptions options) -
TranslationMemberStateType
= Future<
void> Function(TranslationMemberStateOptions options) -
TranslationProducerClosedType
= Future<
void> Function(TranslationProducerClosedOptions options) -
TranslationProducerMap
= Map<
String, Map< String, String> > - Translation producer map type Maps originalProducerId -> { languageCode: translationProducerId }
-
TranslationProducerReadyType
= Future<
void> Function(TranslationProducerReadyOptions options) -
TranslationRoomConfigType
= Future<
void> Function(TranslationRoomConfigOptions options) -
TranslationSpeakerOutputChangedType
= Future<
void> Function(TranslationSpeakerOutputChangedOptions options) -
TranslationSubscribedType
= Future<
void> Function(TranslationSubscribedOptions options) -
TranslationTranscriptType
= Future<
void> Function(TranslationTranscriptOptions options) -
TranslationUnsubscribedType
= Future<
void> Function(TranslationUnsubscribedOptions options)