org.webrtc

Class SurfaceTextureHelper

java.lang.Object

org.webrtc.SurfaceTextureHelper

public class SurfaceTextureHelper
extends java.lang.Object

Helper class for using a SurfaceTexture to create WebRTC VideoFrames. In order to create WebRTC VideoFrames, render onto the SurfaceTexture. The frames will be delivered to the listener. Only one texture frame can be in flight at once, so the frame must be released in order to receive a new frame. Call stopListening() to stop receiveing new frames. Call dispose to release all resources once the texture frame is released.

Method Summary

Modifier and Type	Method and Description
static SurfaceTextureHelper	create(java.lang.String threadName, EglBase.Context sharedContext) Same as above with alignTimestamps set to false.
static SurfaceTextureHelper	create(java.lang.String threadName, EglBase.Context sharedContext, boolean alignTimestamps) Construct a new SurfaceTextureHelper sharing OpenGL resources with |sharedContext|.
void	dispose() Call disconnect() to stop receiving frames.
android.os.Handler	getHandler() Retrieve the handler that calls onFrame().
android.graphics.SurfaceTexture	getSurfaceTexture() Retrieve the underlying SurfaceTexture.
boolean	isTextureInUse()
void	setFrameRotation(int rotation) Set the rotation of the delivered frames.
void	setTextureSize(int textureWidth, int textureHeight) Use this function to set the texture size.
void	startListening(VideoSink listener) Start to stream textures to the given |listener|.
void	stopListening() Stop listening.
VideoFrame.I420Buffer	textureToYuv(VideoFrame.TextureBuffer textureBuffer) Deprecated. Use toI420() instead.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SurfaceTextureHelper create(java.lang.String threadName,
                                          EglBase.Context sharedContext,
                                          boolean alignTimestamps)

Construct a new SurfaceTextureHelper sharing OpenGL resources with |sharedContext|. A dedicated thread and handler is created for handling the SurfaceTexture. May return null if EGL fails to initialize a pixel buffer surface and make it current. If alignTimestamps is true, the frame timestamps will be aligned to rtc::TimeNanos(). If frame timestamps are aligned to rtc::TimeNanos() there is no need for aligning timestamps again in PeerConnectionFactory.createVideoSource(). This makes the timestamps more accurate and closer to actual creation time.

create

public static SurfaceTextureHelper create(java.lang.String threadName,
                                          EglBase.Context sharedContext)

Same as above with alignTimestamps set to false.

See Also:

create(String, EglBase.Context, boolean)

startListening

public void startListening(VideoSink listener)

Start to stream textures to the given |listener|. If you need to change listener, you need to call stopListening() first.

stopListening

public void stopListening()

Stop listening. The listener set in startListening() is guaranteded to not receive any more onFrame() callbacks after this function returns.

setTextureSize

public void setTextureSize(int textureWidth,
                           int textureHeight)

Use this function to set the texture size. Note, do not call setDefaultBufferSize() yourself since this class needs to be aware of the texture size.

setFrameRotation

public void setFrameRotation(int rotation)

Set the rotation of the delivered frames.

getSurfaceTexture

public android.graphics.SurfaceTexture getSurfaceTexture()

Retrieve the underlying SurfaceTexture. The SurfaceTexture should be passed in to a video producer such as a camera or decoder.

getHandler

public android.os.Handler getHandler()

Retrieve the handler that calls onFrame(). This handler is valid until dispose() is called.

isTextureInUse

public boolean isTextureInUse()

dispose

public void dispose()

Call disconnect() to stop receiving frames. OpenGL resources are released and the handler is stopped when the texture frame has been released. You are guaranteed to not receive any more onFrame() after this function returns.

textureToYuv

@Deprecated
public VideoFrame.I420Buffer textureToYuv(VideoFrame.TextureBuffer textureBuffer)

Deprecated. Use toI420() instead.

Posts to the correct thread to convert |textureBuffer| to I420.