-
public final class LocalAudioTrack extends AudioTrack
Represents a local audio track (generally using the microphone as input).
This class should not be constructed directly, but rather through LocalParticipant.createAudioTrack.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classLocalAudioTrack.Companionpublic interfaceLocalAudioTrack.Factory
-
Field Summary
Fields Modifier and Type Field Description private final <ERROR CLASS>featuresprivate final AudioTrackrtcTrackprivate final EventListenable<TrackEvent>eventsprivate Stringnameprivate Track.Kindkindprivate Stringsidprivate Track.StreamStatestreamStateprivate Booleanenabledprivate Function1<RTCStatsCollectorCallback, Unit>statsGetterprivate final RTCThreadTokenrtcThreadToken
-
Constructor Summary
Constructors Constructor Description LocalAudioTrack(String name, AudioTrack mediaTrack, LocalAudioTrackOptions options, AudioProcessingController audioProcessingController, CoroutineDispatcher dispatcher, AudioRecordSamplesDispatcher audioRecordSamplesDispatcher, AudioBufferCallbackDispatcher audioBufferCallbackDispatcher, AudioRecordPrewarmer audioRecordPrewarmer, RTCThreadToken rtcThreadToken)
-
Method Summary
Modifier and Type Method Description final <ERROR CLASS>getFeatures()Changes can be observed by using io.livekit.android.util.flow AudioTrackgetRtcTrack()The underlying WebRTC audio track. final EventListenable<TrackEvent>getEvents()final StringgetName()final UnitsetName(String name)final Track.KindgetKind()final UnitsetKind(Track.Kind kind)final StringgetSid()final UnitsetSid(String sid)final Track.StreamStategetStreamState()final UnitsetStreamState(Track.StreamState streamState)final BooleangetEnabled()final UnitsetEnabled(Boolean enabled)final Function1<RTCStatsCollectorCallback, Unit>getStatsGetter()final UnitsetStatsGetter(Function1<RTCStatsCollectorCallback, Unit> statsGetter)final RTCThreadTokengetRtcThreadToken()final Unitprewarm()Prewarms the audio stack if needed by starting the recording regardless of whether it's being published. final UnitstopPrewarm()UnitaddSink(AudioTrackSink sink)Note: This function relies on us setting JavaAudioDeviceModule.Builder.setSamplesReadyCallback. UnitremoveSink(AudioTrackSink sink)Removes a previously added sink. final UnitsetAudioBufferCallback(AudioBufferCallback callback)Use this method to mix in custom audio. Unitdispose()Disposes the track. -
-
Constructor Detail
-
LocalAudioTrack
LocalAudioTrack(String name, AudioTrack mediaTrack, LocalAudioTrackOptions options, AudioProcessingController audioProcessingController, CoroutineDispatcher dispatcher, AudioRecordSamplesDispatcher audioRecordSamplesDispatcher, AudioBufferCallbackDispatcher audioBufferCallbackDispatcher, AudioRecordPrewarmer audioRecordPrewarmer, RTCThreadToken rtcThreadToken)
-
-
Method Detail
-
getFeatures
@FlowObservable() final <ERROR CLASS> getFeatures()
Changes can be observed by using io.livekit.android.util.flow
-
getRtcTrack
AudioTrack getRtcTrack()
The underlying WebRTC audio track.
-
getEvents
final EventListenable<TrackEvent> getEvents()
-
getKind
final Track.Kind getKind()
-
setKind
final Unit setKind(Track.Kind kind)
-
getStreamState
final Track.StreamState getStreamState()
-
setStreamState
final Unit setStreamState(Track.StreamState streamState)
-
getEnabled
final Boolean getEnabled()
-
setEnabled
final Unit setEnabled(Boolean enabled)
-
getStatsGetter
final Function1<RTCStatsCollectorCallback, Unit> getStatsGetter()
-
setStatsGetter
final Unit setStatsGetter(Function1<RTCStatsCollectorCallback, Unit> statsGetter)
-
getRtcThreadToken
final RTCThreadToken getRtcThreadToken()
-
prewarm
final Unit prewarm()
Prewarms the audio stack if needed by starting the recording regardless of whether it's being published.
-
stopPrewarm
final Unit stopPrewarm()
-
addSink
Unit addSink(AudioTrackSink sink)
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.
-
removeSink
Unit removeSink(AudioTrackSink sink)
Removes a previously added sink.
-
setAudioBufferCallback
final Unit setAudioBufferCallback(AudioBufferCallback callback)
Use this method to mix in custom audio.
See MixerAudioBufferCallback for automatic handling of mixing in the provided audio data.
-
-
-
-