Rate this page:

VideoStream

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

Methods

addVideoRenderer

Copy URL
fun addVideoRenderer(videoSink: 

VideoSink

,
scaleType:

RenderScaleType

,
callback:

RendererCallback

):

Unit

Adds a new videoSink to the video stream.

Parameters

  • videoSink:

    VideoSink

    SurfaceViewRenderer or TextureViewRenderer

  • scaleType:

    RenderScaleType

    The scale type to be applied to the video renderer

  • The callback which is invoked once the video renderer is started or failed to start.

Returns

  • type:

    Unit

removeVideoRenderer

Copy URL
fun removeVideoRenderer(videoSink: 

VideoSink

):

Unit

Removes the previously added videoSink.

Parameters

  • videoSink:

    VideoSink

    SurfaceViewRenderer or TextureViewRenderer

Returns

  • type:

    Unit

removeAllVideoRenderers

Copy URL
fun removeAllVideoRenderers(): 

Unit

Removes all video renderers for the video stream

Returns

  • type:

    Unit

toString

Copy URL
fun toString(): 

String

Returns

  • type:

    String

Props

type

Copy URL
var type: 

VideoStreamType

The video stream type.

Returns

id

Copy URL
val id: 

String

The video stream id.

Returns

  • type:

    String