amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture/DefaultScreenCaptureSource

DefaultScreenCaptureSource

class DefaultScreenCaptureSource(context: Context, logger: Logger, surfaceTextureCaptureSourceFactory: SurfaceTextureCaptureSourceFactory, activityResultCode: Int, activityData: Intent, displayManager: DisplayManager = context.getSystemService(Context.DISPLAY_SERVICE) as DisplayManager, mediaProjectionManager: MediaProjectionManager = context.getSystemService(MEDIA_PROJECTION_SERVICE) as MediaProjectionManager) : VideoCaptureSource, VideoSink

DefaultScreenCaptureSource uses MediaProjection to create a VirtualDisplay to capture the device screen. It will render the captured frames to a Surface provided by a SurfaceTextureCaptureSourceFactory.

Builders will need to get permission from users to obtain the activityResultCode and activityData arguments, required to create an internal MediaProjection object. Read content share guide for more information.

Note that you must finish starting the foreground service before calling start. Otherwise start will fail to succeed despite having the user grant permission and despite having created a foreground service for the MediaProjection. CaptureSourceObserver.onCaptureFailed will be called with CaptureSourceError.SystemFailure in this case.

If the MediaProjection could not be obtained with the activityResultCode and activityData, CaptureSourceObserver.onCaptureFailed will be called with CaptureSourceError.ConfigurationFailure.

Constructors

DefaultScreenCaptureSource

constructor(context: Context, logger: Logger, surfaceTextureCaptureSourceFactory: SurfaceTextureCaptureSourceFactory, activityResultCode: Int, activityData: Intent, displayManager: DisplayManager = context.getSystemService(Context.DISPLAY_SERVICE) as DisplayManager, mediaProjectionManager: MediaProjectionManager = context.getSystemService(MEDIA_PROJECTION_SERVICE) as MediaProjectionManager)

Properties

contentHint

open override val contentHint: VideoContentHint

Content hint for downstream processing

Functions

addCaptureSourceObserver

open override fun addCaptureSourceObserver(observer: CaptureSourceObserver)

Add a capture source observer to receive callbacks from the source on lifecycle events which can be used to trigger UI. This observer is entirely optional.

addVideoSink

open override fun addVideoSink(sink: VideoSink)

Add a video sink which will immediately begin to receive new frames.

onVideoFrameReceived

open override fun onVideoFrameReceived(frame: VideoFrame)

Receive a video frame from some upstream source. The VideoSink may render, store, process, and forward the frame, among other applications.

release

fun release()

removeCaptureSourceObserver

open override fun removeCaptureSourceObserver(observer: CaptureSourceObserver)

Remove a capture source observer

removeVideoSink

open override fun removeVideoSink(sink: VideoSink)

Remove a video sink which will no longer receive new frames on return

setMaxResolution

open override fun setMaxResolution(maxResolution: VideoResolution)

Set max resolution for video capture source DefaultCameraCaptureSource and DefaultScreenCaptureSource call this function to set max resolution for camera and screen capture

start

open override fun start()

Start capturing on this source and emitting video frames

stop

open override fun stop()

Stop capturing on this source and cease emitting video frames