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

HMSLocalVideoTrack

class HMSLocalVideoTrack : HMSVideoTrack, HMSLocalTrack

The video track of the local peer

Functions

addSink

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

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

captureImageAtMaxPublishResolution

fun captureImageAtMaxPublishResolution(videoFrameListener: HmsVideoFrameListener)

changeInputFps

fun changeInputFps(fps: Int)

equals

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

getCameraControl

fun getCameraControl(): CameraControl?

getInputResolutionAndFps

fun getInputResolutionAndFps(): Pair<Size, Int>

getTextureHelper

fun getTextureHelper(): SurfaceTextureHelper

removeSink

open fun removeSink(sink: VideoSink)

Takes in a view that needs to be removed from rendering

setDescription

open override fun setDescription(value: String)

Set description to this track from the app layer, if any

setMute

open override fun setMute(value: Boolean)

Sets the local mute status of this track

setSettings

suspend fun setSettings(newSettings: HMSVideoTrackSettings)

switchCamera

fun switchCamera(onAction: HMSActionResultListener? = null): Job

Method to toggle camera between the front and back

fun switchCamera(deviceId: String, onAction: HMSActionResultListener?): Job

Method to switch camera to the given deviceID

fun switchCamera(face: HMSVideoTrackSettings.CameraFacing, onAction: HMSActionResultListener? = null): Job

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 var isDegraded: Boolean = false

true - if this track has been degraded due to network issues false - no degradation applied on this track

isMute

var isMute: Boolean = false

true - if this track is muted, otherwise false

settings

var settings: HMSVideoTrackSettings

source

var source: String

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

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