livekit-android-sdk/io.livekit.android.room.participant/VideoTrackPublishOptions

VideoTrackPublishOptions

data class VideoTrackPublishOptions(val name: String? = null, val videoEncoding: VideoEncoding? = null, val simulcast: Boolean = true, val videoCodec: String = VideoCodec.VP8.codecName, val scalabilityMode: String? = null, val backupCodec: BackupVideoCodec? = null, val source: Track.Source? = null, val stream: String? = null, val degradationPreference: RtpParameters.DegradationPreference? = null, val simulcastLayers: List<VideoPreset>? = null) : BaseVideoTrackPublishOptions, TrackPublishOptions

Constructors

Link copied to clipboard
constructor(name: String? = null, base: BaseVideoTrackPublishOptions, source: Track.Source? = null, stream: String? = null)
constructor(name: String? = null, videoEncoding: VideoEncoding? = null, simulcast: Boolean = true, videoCodec: String = VideoCodec.VP8.codecName, scalabilityMode: String? = null, backupCodec: BackupVideoCodec? = null, source: Track.Source? = null, stream: String? = null, degradationPreference: RtpParameters.DegradationPreference? = null, simulcastLayers: List<VideoPreset>? = null)

Properties

Link copied to clipboard
open override val backupCodec: BackupVideoCodec? = null

Multi-codec Simulcast

Link copied to clipboard
open override val degradationPreference: RtpParameters.DegradationPreference? = null

When bandwidth is constrained, this preference indicates which is preferred between degrading resolution vs. framerate.

Link copied to clipboard
open override val name: String? = null

The name of the track.

Link copied to clipboard
open override val scalabilityMode: String? = null

scalability mode for svc codecs, defaults to 'L3T3'. for svc codecs, simulcast is disabled.

Link copied to clipboard
open override val simulcast: Boolean = true
Link copied to clipboard
open override val simulcastLayers: List<VideoPreset>? = null

Up to two additional simulcast layers to publish in addition to the original Track. Layers should be ordered from smallest to largest. Layers beyond the first two will be ignored. Any layers that have larger resolutions than the source resolution will also be ignored.

Link copied to clipboard
open override val source: Track.Source? = null

The source of a track, camera, microphone or screen.

Link copied to clipboard
open override val stream: String? = null

The stream name for the track. Audio and video tracks with the same stream name will be placed in the same MediaStream and offer better synchronization.

Link copied to clipboard
open override val videoCodec: String

The video codec to use if available.

Link copied to clipboard
open override val videoEncoding: VideoEncoding? = null

Functions

Link copied to clipboard