VideoStream
This API is in beta and subject to change.
Base interface for LocalVideoStream and RemoteVideoStream that provides the base functionality such as adding and removing video renderers.
Methods
addVideoRenderer
fun addVideoRenderer(videoRenderer: VideoSink
, scaleType: , rendererEventsListener: RendererEvents?
): Unit
This API is in beta and subject to change.
Adds a new video renderer to the video stream.
Parameters
videoRenderer:
VideoSink
org.webrtc.SurfaceViewRenderer or org.webrtc.TextureViewRenderer
scaleType:
The scale type to be applied to the video renderer
rendererEventsListener:
RendererEvents?
OptionalListener to handle the first frame rendered and frame resolution changed events
Returns
type:
Unit
removeVideoRenderer
fun removeVideoRenderer(videoRenderer: VideoSink
): Unit
This API is in beta and subject to change.
Removes the previously added video renderer.
Parameters
videoRenderer:
VideoSink
org.webrtc.SurfaceViewRenderer or org.webrtc.TextureViewRenderer
Returns
type:
Unit
removeAllVideoRenderers
fun removeAllVideoRenderers(): Unit
This API is in beta and subject to change.
Removes all video renderers for the video stream
Returns
type:
Unit
Props
id
val id: String
This API is in beta and subject to change.
The video stream id.
Returns
type:
String
type
val type: This API is in beta and subject to change.
The video stream type.
Returns
type: