stream-webrtc-android/org.webrtc/ScreenCapturerAndroid

ScreenCapturerAndroid

open class ScreenCapturerAndroid : VideoCapturer, VideoSink

An implementation of VideoCapturer to capture the screen content as a video stream. Capturing is done by MediaProjection on a SurfaceTexture. We interact with this SurfaceTexture using a SurfaceTextureHelper. The SurfaceTextureHelper is created by the native code and passed to this capturer in VideoCapturer.initialize(). On receiving a new frame, this capturer passes it as a texture to the native code via CapturerObserver.onFrameCaptured(). This takes place on the HandlerThread of the given SurfaceTextureHelper. When done with each frame, the native code returns the buffer to the SurfaceTextureHelper to be used for new frames. At any time, at most one frame is being processed.

Constructors

ScreenCapturerAndroid

constructor(mediaProjectionPermissionResultData: Intent, mediaProjectionCallback: MediaProjection.Callback)

Constructs a new Screen Capturer.

Properties

mediaProjection

open val mediaProjection: MediaProjection

numCapturedFrames

open val numCapturedFrames: Long

Functions

changeCaptureFormat

open fun changeCaptureFormat(width: Int, height: Int, ignoredFramerate: Int)

Changes output video format.

open fun dispose()

Perform any final cleanup here.

open fun initialize(surfaceTextureHelper: SurfaceTextureHelper, applicationContext: Context, capturerObserver: CapturerObserver)

This function is used to initialize the camera thread, the android application context, and the capture observer.

open fun isScreencast(): Boolean

open fun onFrame(frame: VideoFrame)

Implementations should call frame.retain() if they need to hold a reference to the frame after this function returns.

open fun startCapture(width: Int, height: Int, ignoredFramerate: Int)

Start capturing frames in a format that is as close as possible to width x height and framerate.

open fun stopCapture()

Stop capturing.