VideoStream

This API is in beta and subject to change.

Base class for LocalVideoStream and RemoteVideoStream that provides the base functionality such as adding and removing video renderers.

Methods

fun addVideoRenderer(viewRenderer: VideoSink, scaleType: RenderScaleType, rendererEventsListener: RendererEvents?): Unit

This API is in beta and subject to change.

Adds a new view renderer to the video stream.

viewRenderer:
VideoSink
org.webrtc.SurfaceViewRenderer or org.webrtc.TextureViewRenderer
scaleType:
RenderScaleType
The scale type to be applied to the video renderer
rendererEventsListener:
RendererEvents?
Optional
Listener to handle the first frame rendered and frame resolution changed events

fun removeVideoRenderer(viewRenderer: VideoSink): Unit

This API is in beta and subject to change.

Removes the previously added view renderer.

viewRenderer:
VideoSink
org.webrtc.SurfaceViewRenderer or org.webrtc.TextureViewRenderer

fun removeAllVideoRenderers(): Unit

This API is in beta and subject to change.

Removes all video renderers for the video stream

fun toString(): String

val id: String

This API is in beta and subject to change.

The video stream id.

var type: VideoStreamType

This API is in beta and subject to change.

The video stream type.