com.twilio.video

Class ScreenCapturer

java.lang.Object

com.twilio.video.ScreenCapturer

All Implemented Interfaces:

VideoCapturer

public class ScreenCapturer
extends 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
List<VideoFormat>	getSupportedFormats() Returns a list containing one supported video format derived from the device screen size.
boolean	isScreencast() Indicates that the screen capturer is a screencast.
void	startCapture(VideoFormat captureFormat, VideoCapturer.Listener capturerListener) Starts capturing frames at the specified format.
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

Constructor Detail

ScreenCapturer

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

Method Detail

getSupportedFormats

public List<VideoFormat> getSupportedFormats()

Returns a list containing one supported video format derived from the device screen size.

Note: This method can be invoked for informational purposes, but is primarily used internally.

Specified by:

getSupportedFormats in interface VideoCapturer

Returns:

all supported video formats.

isScreencast

public boolean isScreencast()

Indicates that the screen capturer is a screencast.

Specified by:

isScreencast in interface VideoCapturer

Returns:

true if the video capturer is a screencast and false if not.

startCapture

public void startCapture(VideoFormat captureFormat,
                         VideoCapturer.Listener capturerListener)

Starts capturing frames at the specified format. Frames will be provided to the given listener upon availability.

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

Specified by:

startCapture in interface VideoCapturer

Parameters:

captureFormat - the format in which to capture frames.

capturerListener - consumer of available frames.

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 VideoCapturer