Protocols

EventAnalyticsController keeps track of events and notifies EventAnalyticsObserver. An event describes the success and failure conditions for the meeting session.

EventAnalyticsFacade exposes event analytics related function to builders

EventAnalyticsObserver handles events regarding to analytics.

AudioVideoControllerFacade manages the signaling and peer connections.

AudioVideoObserver handles audio/video session events.

PrimaryMeetingPromotionObserver handles events related to Primary meeting promotion. See AudioVideoControllerFacade.promoteToPrimaryMeeting for more information.

ActiveSpeakerDetectorFacade listens to the volume indicator updates from the RealtimeControllerFacade. It consults the ActiveSpeakerPolicy to determine if the speaker is active or not.

ActiveSpeakerObserver handles event related to finding active speaker and corresponding scores

Scheduler calls a callback on the schedule determined by the implementation.

ContentShareController exposes methods for starting and stopping content share with a ContentShareSource. The content represents a media steam to be shared in the meeting, such as screen capture or media files. Please refer to content share guide for details.

ContentShareObserver handles all callbacks related to the content share. By implementing the callback functions and registering with ContentShareController.addContentShareObserver, one can get notified with content share status events.

See Using Amazon Chime SDK live transcription developer guide for details about transcription message types and data guidelines

MetricsObserver handles events related to audio/video metrics.

VideoFrameBuffer is a buffer which contains a single video buffer’s raw data. Typically owned by a VideoFrame which includes additional metadata.

VideoRenderView is the type of VideoSink used by the VideoTileController

A VideoSink consumes video frames, typically from a VideoSource. It may process, fork, or render these frames. Typically connected via video VideoSource.addVideoSink and disconnected via VideoSource.removeVideoSink

VideoSource is an interface for sources which produce video frames, and can send to a VideoSink. Implementations can be passed to the AudioVideoFacade to be used as the video source sent to remote participlants

VideoTile is a tile that binds video render view to diplay the frame into the view.

VideoTileController handles rendering/creating of new VideoTile.

VideoTileControllerFacade allows one to control VideoTile. The caller is responsible for laying out video render views as desired and binding tile ids received from the observer in the videoTileDidAdd and videoTileDidRemove callbacks.

VideoTileObserver handles events related to VideoTile.

CameraCaptureSource is an interface for camera capture sources with additional features not covered by VideoCaptureSource. All the APIs in this protocol can be called regardless of whether the MeetingSession.audioVideo is started or not.

CaptureSourceObserver observes events resulting from different types of capture devices. Builders may desire this input to decide when to show certain UI elements, or to notify users of failure.

VideoCaptureSource is an interface for various video capture sources (i.e. screen, camera, file) which can emit VideoFrame objects. All the APIs in this protocol can be called regardless of whether the MeetingSession.audioVideo is started or not.

DeviceChangeObserver listens to the change of Audio Device.

DeviceController keeps track of the devices being used for audio device (e.g. built-in speaker), video input (e.g. camera)). The list functions return MediaDevice objects. Changes in device availability are broadcast to any registered DeviceChangeObserver.

EventBuffer defines storing and consuming of event data.

EventClientConfiguration contains speciic data required to send as metadata.

EventReporter process data. It will be called in DefaultEventAnalyticsController.

EventSender handles the sending of ingestion record

DataMessasgeObserver handles data message event,

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.

RealtimeObserver handles event that happens in realtime, such as delta in attendees join or leave, volume/signal status.

TranscriptEventObserver provides a callback to handle transcript event

Logger defines how to write logs for different logging level.