stream-webrtc-android/org.webrtc/SurfaceEglRenderer

SurfaceEglRenderer

open class SurfaceEglRenderer : EglRenderer, SurfaceHolder.Callback

Display the video stream on a Surface. renderFrame() is asynchronous to avoid blocking the calling thread. This class is thread safe and handles access from potentially three different threads: Interaction from the main app in init, release and setMirror. Interaction from C++ rtc::VideoSinkInterface in renderFrame. Interaction from SurfaceHolder lifecycle in surfaceCreated, surfaceChanged, and surfaceDestroyed.

Constructors

SurfaceEglRenderer

constructor(name: String)

In order to render something, you must first call init().

Functions

disableFpsReduction

open fun disableFpsReduction()

open fun init(sharedContext: EglBase.Context, configAttributes: Array<Int>, drawer: RendererCommon.GlDrawer)

Same as above with usePresentationTimeStamp set to false.

open fun init(sharedContext: EglBase.Context, rendererEvents: RendererCommon.RendererEvents, configAttributes: Array<Int>, drawer: RendererCommon.GlDrawer)

Initialize this class, sharing resources with `sharedContext`.

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 pauseVideo()

setFpsReduction

open fun setFpsReduction(fps: Float)

Limit render framerate.

open fun surfaceChanged(holder: SurfaceHolder, format: Int, width: Int, height: Int)

open fun surfaceCreated(holder: SurfaceHolder)

surfaceDestroyed

open fun surfaceDestroyed(holder: SurfaceHolder)

Inherited functions

addFrameListener

open fun addFrameListener(listener: EglRenderer.FrameListener, scale: Float)

open fun addFrameListener(listener: EglRenderer.FrameListener, scale: Float, drawerParam: RendererCommon.GlDrawer)

open fun addFrameListener(listener: EglRenderer.FrameListener, scale: Float, @Nullable drawerParam: RendererCommon.GlDrawer, applyFpsReduction: Boolean)

Register a callback to be invoked when a new video frame has been received.

open fun clearImage()

Post a task to clear the surface to a transparent uniform color.

open fun clearImage(r: Float, g: Float, b: Float, a: Float)

Post a task to clear the surface to a specific color.

createEglSurface

open fun createEglSurface(surfaceTexture: SurfaceTexture)

open fun createEglSurface(surface: Surface)

open fun init(@Nullable sharedContext: EglBase.Context, configAttributes: Array<Int>, drawer: RendererCommon.GlDrawer, usePresentationTimeStamp: Boolean)

Initialize this class, sharing resources with `sharedContext`.

printStackTrace

open fun printStackTrace()

open fun release()

Block until any pending frame is returned and all GL resources released, even if an interrupt occurs.

releaseEglSurface

open fun releaseEglSurface(completionCallback: Runnable)

Release EGL surface.

removeFrameListener

open fun removeFrameListener(listener: EglRenderer.FrameListener)

Remove any pending callback that was added with addFrameListener.

setErrorCallback

open fun setErrorCallback(errorCallback: EglRenderer.ErrorCallback)

Can be set in order to be notified about errors encountered during rendering.

setLayoutAspectRatio

open fun setLayoutAspectRatio(layoutAspectRatio: Float)

Set layout aspect ratio.

open fun setMirror(mirror: Boolean)

Set if the video stream should be mirrored horizontally or not.

setMirrorVertically

open fun setMirrorVertically(mirrorVertically: Boolean)

Set if the video stream should be mirrored vertically or not.