livekit-android-sdk/io.livekit.android.room.track/LocalAudioTrack

LocalAudioTrack

class LocalAudioTrack @AssistedInject constructor(@Assisted name: String, @Assisted mediaTrack: AudioTrack, @Assisted options: LocalAudioTrackOptions, audioProcessingController: AudioProcessingController, @Named(value = "dispatcher_default") dispatcher: CoroutineDispatcher, @Named(value = "local_audio_record_samples_dispatcher") audioRecordSamplesDispatcher: AudioRecordSamplesDispatcher, @Named(value = "local_audio_record_samples_dispatcher") audioBufferCallbackDispatcher: AudioBufferCallbackDispatcher) : AudioTrack

Represents a local audio track (generally using the microphone as input).

This class should not be constructed directly, but rather through LocalParticipant.createAudioTrack.

Constructors

LocalAudioTrack

@AssistedInject

constructor(@Assisted name: String, @Assisted mediaTrack: AudioTrack, @Assisted options: LocalAudioTrackOptions, audioProcessingController: AudioProcessingController, @Named(value = "dispatcher_default") dispatcher: CoroutineDispatcher, @Named(value = "local_audio_record_samples_dispatcher") audioRecordSamplesDispatcher: AudioRecordSamplesDispatcher, @Named(value = "local_audio_record_samples_dispatcher") audioBufferCallbackDispatcher: AudioBufferCallbackDispatcher)

Types

Companion

object Companion

Factory

@AssistedFactory

interface Factory

Properties

enabled

var enabled: Boolean

events

val events: EventListenable<TrackEvent>

features

@FlowObservable

@get:FlowObservable

val features: <Error class: unknown class>

Changes can be observed by using io.livekit.android.util.flow

kind

var kind: Track.Kind

name

var name: String

rtcTrack

open override val rtcTrack: AudioTrack

The underlying WebRTC audio track.

sid

var sid: String?

statsGetter

var statsGetter: RTCStatsGetter?

streamState

var streamState: Track.StreamState

Functions

addSink

open override fun addSink(sink: AudioTrackSink)

Note: This function relies on us setting JavaAudioDeviceModule.Builder.setSamplesReadyCallback. If you provide your own AudioDeviceModule, or set your own callback, your sink will not receive any audio data.

dispose

open override fun dispose()

Disposes the track. LiveKit will generally take care of disposing tracks for you.

getRTCStats

suspend fun getRTCStats(): RTCStatsReport?

Return the RTCStatsReport for this track, or null if none is available.

fun getRTCStats(callback: RTCStatsCollectorCallback)

Calls the callback with the RTCStatsReport for this track, or null if none is available.

removeSink