amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo/DefaultAudioVideoFacade

DefaultAudioVideoFacade

class DefaultAudioVideoFacade(context: Context, audioVideoController: AudioVideoControllerFacade, realtimeController: RealtimeControllerFacade, deviceController: DeviceController, videoTileController: VideoTileController, activeSpeakerDetector: ActiveSpeakerDetectorFacade, contentShareController: ContentShareController, eventAnalyticsController: EventAnalyticsController) : AudioVideoFacade

Constructors

constructor(context: Context, audioVideoController: AudioVideoControllerFacade, realtimeController: RealtimeControllerFacade, deviceController: DeviceController, videoTileController: VideoTileController, activeSpeakerDetector: ActiveSpeakerDetectorFacade, contentShareController: ContentShareController, eventAnalyticsController: EventAnalyticsController)

Functions

addActiveSpeakerObserver

open override fun addActiveSpeakerObserver(policy: ActiveSpeakerPolicy, observer: ActiveSpeakerObserver)

Adds an active speaker observer along with a policy to calculate active speaker scores

addAudioVideoObserver

open override fun addAudioVideoObserver(observer: AudioVideoObserver)

Subscribe to audio, video, and connection events with an AudioVideoObserver.

addContentShareObserver

open override fun addContentShareObserver(observer: ContentShareObserver)

Subscribe the given observer to content share events (sharing started and stopped).

addDeviceChangeObserver

open override fun addDeviceChangeObserver(observer: DeviceChangeObserver)

Adds an observer to receive callbacks about device changes.

addEventAnalyticsObserver

open override fun addEventAnalyticsObserver(observer: EventAnalyticsObserver)

Subscribe to meeting event related data with an observer.

addMetricsObserver

open override fun addMetricsObserver(observer: MetricsObserver)

Subscribe to metrics events with an MetricsObserver.

addRealtimeDataMessageObserver

open override fun addRealtimeDataMessageObserver(topic: String, observer: DataMessageObserver)

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

addRealtimeObserver

open override fun addRealtimeObserver(observer: RealtimeObserver)

Subscribes to real time events with an observer

addRealtimeTranscriptEventObserver

open override fun addRealtimeTranscriptEventObserver(observer: TranscriptEventObserver)

Subscribes to transcript event with an observer

addVideoTileObserver

open override fun addVideoTileObserver(observer: VideoTileObserver)

Subscribe to Video Tile events with an VideoTileObserver.

bindVideoView

open override fun bindVideoView(videoView: VideoRenderView, tileId: Int)

Binds the video rendering view to Video Tile. The view will start displaying the video frame after the completion of this API.

chooseAudioDevice

open override fun chooseAudioDevice(mediaDevice: MediaDevice)

Selects an audio device to use.

demoteFromPrimaryMeeting

open override fun demoteFromPrimaryMeeting()

Remove the promoted attendee from the Primary meeting. This client will stop sharing audio, video, and data messages. This will revert the end-user to precisely the state they were before a call to promoteToPrimaryMeeting

getActiveAudioDevice

open override fun getActiveAudioDevice(): MediaDevice?

Get the active input/output audio device in the meeting, return null if there isn't any.

getActiveCamera

open override fun getActiveCamera(): MediaDevice?

Get the currently active camera, if any. This will return null if using a custom source, e.g. one passed in via AudioVideoControllerFacade.startLocalVideo

getCommonEventAttributes

open override fun getCommonEventAttributes(): EventAttributes

Retrieve common attributes, including deviceName, osName, and more.

getMeetingHistory

open override fun getMeetingHistory(): List<MeetingHistoryEvent>

Retrieve meeting history.

listAudioDevices

open override fun listAudioDevices(): List<MediaDevice>

Lists currently available audio devices.

pauseRemoteVideoTile

open override fun pauseRemoteVideoTile(tileId: Int)

Pauses the specified remote video tile. Ignores the tileId if it belongs to the local video tile.

promoteToPrimaryMeeting

open override fun promoteToPrimaryMeeting(credentials: MeetingSessionCredentials, observer: PrimaryMeetingPromotionObserver)

Allows an attendee in a Replica meeting to immediately transition to a Primary meeting attendee without need for reconnection.

realtimeIsVoiceFocusEnabled

open override fun realtimeIsVoiceFocusEnabled(): Boolean

Checks if Amazon Voice Focus is enabled.

realtimeLocalMute

open override fun realtimeLocalMute(): Boolean

Mute the audio input.

realtimeLocalUnmute

open override fun realtimeLocalUnmute(): Boolean

Unmutes the audio input.

realtimeSendDataMessage

open override fun realtimeSendDataMessage(topic: String, data: Any, lifetimeMs: Int)

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.

realtimeSetVoiceFocusEnabled

open override fun realtimeSetVoiceFocusEnabled(enabled: Boolean): Boolean

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

removeActiveSpeakerObserver

open override fun removeActiveSpeakerObserver(observer: ActiveSpeakerObserver)

Removes an active speaker observer.

removeAudioVideoObserver

open override fun removeAudioVideoObserver(observer: AudioVideoObserver)

Unsubscribes from audio, video, and connection events by removing specified AudioVideoObserver.

removeContentShareObserver

open override fun removeContentShareObserver(observer: ContentShareObserver)

Unsubscribe the given observer from content share events.

removeDeviceChangeObserver

open override fun removeDeviceChangeObserver(observer: DeviceChangeObserver)

Removes an observer to stop receiving callbacks about device changes.

removeEventAnalyticsObserver

open override fun removeEventAnalyticsObserver(observer: EventAnalyticsObserver)

Unsubscribe from meeting event by removing the specified observer.

removeMetricsObserver

open override fun removeMetricsObserver(observer: MetricsObserver)

Unsubscribes from metrics by removing specified MetricsObserver.

removeRealtimeDataMessageObserverFromTopic

open override fun removeRealtimeDataMessageObserverFromTopic(topic: String)

Unsubscribes from a message topic

removeRealtimeObserver

open override fun removeRealtimeObserver(observer: RealtimeObserver)

Unsubscribes from real time events by removing the specified observer

removeRealtimeTranscriptEventObserver

open override fun removeRealtimeTranscriptEventObserver(observer: TranscriptEventObserver)

Unsubscribes from transcript event by removing the specified observer

removeVideoTileObserver

open override fun removeVideoTileObserver(observer: VideoTileObserver)

Unsubscribes from Video Tile events by removing specified VideoTileObserver.

resumeRemoteVideoTile

open override fun resumeRemoteVideoTile(tileId: Int)

Resumes the specified remote video tile. Ignores the tileId if it belongs to the local video tile.

start

open override fun start()

Starts audio and video.

open override fun start(audioVideoConfiguration: AudioVideoConfiguration)

Starts audio and video with the given configuration.

startContentShare

open override fun startContentShare(source: ContentShareSource)

Start sharing the content of a given ContentShareSource.

open override fun startContentShare(source: ContentShareSource, config: LocalVideoConfiguration)

Start sharing the content of a given ContentShareSource with configuration.

startLocalVideo

open override fun startLocalVideo()

Start local video and begin transmitting frames from an internally held DefaultCameraCaptureSource. stopLocalVideo will stop the internal capture source if being used.

open override fun startLocalVideo(config: LocalVideoConfiguration)

Start local video with configuration and begin transmitting frames from an internally held DefaultCameraCaptureSource. stopLocalVideo will stop the internal capture source if being used.

open override fun startLocalVideo(source: VideoSource)

Start local video with a provided custom VideoSource which can be used to provide custom VideoFrame objects to be transmitted to remote clients

open override fun startLocalVideo(source: VideoSource, config: LocalVideoConfiguration)

Start local video with with configuration and a provided custom VideoSource which can be used to provide custom VideoFrame objects to be transmitted to remote clients

startRemoteVideo

open override fun startRemoteVideo()

Start remote video.

stop

open override fun stop()

Stops audio and video. It's important to call this when your meeting connection is no longer needed in order to clean up and explicitly release resources.

stopContentShare

open override fun stopContentShare()

Stop sharing the content of a ContentShareSource that previously started.

stopLocalVideo

open override fun stopLocalVideo()

Stops sending video for local attendee. This will additionally stop the internal capture source if being used. If using a custom video source, this will call VideoSource.removeVideoSink on the previously provided source.

stopRemoteVideo

open override fun stopRemoteVideo()

Stop remote video.

switchCamera

open override fun switchCamera()

Switches the currently active camera. This will no-op if using a custom source, e.g. one passed in via AudioVideoControllerFacade.startLocalVideo

unbindVideoView

open override fun unbindVideoView(tileId: Int)

Unbinds the video rendering view from Video Tile. The view will stop displaying the video frame after the completion of this API.

updateVideoSourceSubscriptions

open override fun updateVideoSourceSubscriptions(addedOrUpdated: Map<RemoteVideoSource, VideoSubscriptionConfiguration>, removed: Array<RemoteVideoSource>)

Add, update, or remove subscriptions to remote video sources provided via remoteVideoSourcesDidBecomeAvailable.