producers\socket_receive_methods\translation_receive_methods library

Translation Socket Receive Methods

Handler implementations for translation-related socket events.

Listens for:

  • translation:roomConfig - Room-level translation configuration
  • translation:configUpdated - Host updated room config
  • translation:languageSet - Confirmation of spoken language set
  • translation:subscribed - Confirmation of translation subscription
  • translation:unsubscribed - Confirmation of translation unsubscription
  • translation:producerReady - Translation producer is available for consumption
  • translation:producerClosed - Translation producer was closed
  • translation:channelsAvailable - Channels available from a speaker
  • translation:memberState - Another member's translation state
  • translation:error - Translation operation error
  • translation:transcript - Live transcription text
  • translation:speakerOutputChanged - Speaker changed output language

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

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.

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)