lib/live.hms.video.media.tracks/HMSRemoteVideoTrack

HMSRemoteVideoTrack

class HMSRemoteVideoTrack : HMSVideoTrack, HMSRemoteTrack

This contains the video track of the HMSRemotePeer

Functions

addSink

open override fun addSink(sink: VideoSink, resultListener: HMSAddSinkResultListener?)

Takes in a view on which the video needs to be rendered

addSinkInternal

fun addSinkInternal(sink: VideoSink, selectedLayer: HMSLayer)

adds sink with selectedLayer as params

equals

open operator override fun equals(other: Any?): Boolean

getLayer

fun getLayer(): HMSLayer

Public API to get current layer value

getLayerDefinition

fun getLayerDefinition(): List<HMSSimulcastLayerDefinition>

Public API to get layers definition

removeSink

open override fun removeSink(sink: VideoSink)

Takes in a view that needs to be removed from rendering

setLayer

fun setLayer(HMSLayer: HMSLayer, resultListener: HMSAddSinkResultListener? = null)

Public api to set layer to HMSLayer.HIGH, HMSLayer.LOW, HMSLayer.MEDIUM

toString

open override fun toString(): String

Properties

description

var description: String

A description if any that has been set for this track by the app

isDegraded

open override var isDegraded: Boolean = false

Is true if this track has been degraded due to auto degradation by the SDK

isMute

var isMute: Boolean = false

true - if this track is muted, otherwise false

isPlaybackAllowed

open override var isPlaybackAllowed: Boolean

Method to set if playback is needed of this remote track or not

source

var source: String

Specifies the source of this track Regular - from default camera/mic Screen - from screenshare Plugin - from plugin

ssrc

open override var ssrc: Long

TAG

val TAG: String

trackId

val trackId: String

The trackID of this track

type

open override val type: HMSTrackType

This specifies the type of track, either one of HMSTrackType