com.twilio.video

Class ScreenCapturer

java.lang.Object

com.twilio.video.ScreenCapturer

All Implemented Interfaces:

tvi.webrtc.VideoCapturer

public class ScreenCapturer
extends java.lang.Object
implements VideoCapturer

The ScreenCapturer class is used to provide video frames for a LocalVideoTrack from a device's screen. The frames are provided via the MediaProjection api. This capturer is only compatible with Build.VERSION_CODES.LOLLIPOP or higher.

This class represents an implementation of a VideoCapturer interface. Although public, these methods are not meant to be invoked directly.

Note: This capturer can be reused, but cannot be shared across multiple LocalVideoTracks simultaneously.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScreenCapturer.Listener Interface that provides events and errors related to ScreenCapturer.

Constructor Summary

Constructors

Constructor and Description
ScreenCapturer(android.content.Context context, int screenCaptureIntentResult, android.content.Intent screenCaptureIntentData, ScreenCapturer.Listener screenCapturerListener)

Method Summary

Modifier and Type	Method and Description
void	dispose() This method provides an optional step to perform a final cleanup.
VideoFormat	getCaptureFormat()
void	initialize(tvi.webrtc.SurfaceTextureHelper surfaceTextureHelper, android.content.Context context, tvi.webrtc.CapturerObserver capturerObserver)
boolean	isScreencast() Indicates that the screen capturer is a screencast.
void	startCapture(int width, int height, int framerate)
void	stopCapture() Stops all frames being captured.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.twilio.video.VideoCapturer

changeCaptureFormat

Constructor Detail

ScreenCapturer

public ScreenCapturer(@NonNull
                      android.content.Context context,
                      int screenCaptureIntentResult,
                      @NonNull
                      android.content.Intent screenCaptureIntentData,
                      @Nullable
                      ScreenCapturer.Listener screenCapturerListener)

Method Detail

getCaptureFormat

public VideoFormat getCaptureFormat()

isScreencast

public boolean isScreencast()

Indicates that the screen capturer is a screencast.

Specified by:

isScreencast in interface tvi.webrtc.VideoCapturer

initialize

public void initialize(@NonNull
                       tvi.webrtc.SurfaceTextureHelper surfaceTextureHelper,
                       @NonNull
                       android.content.Context context,
                       @NonNull
                       tvi.webrtc.CapturerObserver capturerObserver)

Specified by:

initialize in interface tvi.webrtc.VideoCapturer

startCapture

public void startCapture(int width,
                         int height,
                         int framerate)

Specified by:

startCapture in interface tvi.webrtc.VideoCapturer

stopCapture

public void stopCapture()

Stops all frames being captured. MediaProjection should be available for use upon completion.

Note: This method is not meant to be invoked directly.

Specified by:

stopCapture in interface tvi.webrtc.VideoCapturer

dispose

public void dispose()

Description copied from interface: VideoCapturer

This method provides an optional step to perform a final cleanup.

Specified by:

dispose in interface tvi.webrtc.VideoCapturer