RealtimeControllerFacade

RealtimeControllerFacade controls aspects meetings concerning realtime UX that for performance, privacy, or other reasons should be implemented using the most direct path. Callbacks generated by this interface should be consumed synchronously and without business logic dependent on the UI state where possible.

Events will be passed through RealtimeObserver, which in turn provides consumers the volume/mute/signal/attendee callbacks that can be used to render in the UI. Data Messages will be passed through DataMessageObserver.

Inheritors

Functions

Link copied to clipboard

Subscribes to receive message on a topic, there could be multiple observers per topic

Link copied to clipboard
abstract fun addRealtimeObserver(observer: RealtimeObserver)

Subscribes to real time events with an observer

Link copied to clipboard

Subscribes to transcript event with an observer

Link copied to clipboard

Checks if Amazon Voice Focus is enabled.

Link copied to clipboard
abstract fun realtimeLocalMute(): Boolean

Mute the audio input.

Link copied to clipboard

Unmutes the audio input.

Link copied to clipboard
abstract fun realtimeSendDataMessage(topic: String, data: Any, lifetimeMs: Int = 0)

Send message via data channel. Messages are only expected to be sent after audio video has started, otherwise will be ignored. Even though one can send data messages to any valid topic, in order to receive the messages from the given topic, one need to subscribed to the topic by calling addRealtimeDataMessageObserver. LifetimeMs specifies milliseconds for the given message can be stored in server side. Up to 1024 messages may be stored for a maximum of 5 minutes.

Link copied to clipboard

Enable or disable Amazon Voice Focus (ML-based noise suppression) on the audio input.

Unsubscribes from a message topic

Link copied to clipboard

Unsubscribes from real time events by removing the specified observer

Link copied to clipboard

Unsubscribes from transcript event by removing the specified observer