Package-level declarations

AudioTrack and VideoTrack are the classes that represent the types of media streams that can be subscribed and published.

Types

Link copied to clipboard
abstract class AudioTrack(name: String, val rtcTrack: AudioTrack) : Track

A class representing an audio track.

Link copied to clipboard
Link copied to clipboard
class LocalAudioTrack(name: String, mediaTrack: AudioTrack) : AudioTrack

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

Link copied to clipboard
data class LocalAudioTrackOptions(val noiseSuppression: Boolean = true, val echoCancellation: Boolean = true, val autoGainControl: Boolean = true, val highPassFilter: Boolean = true, val typingNoiseDetection: Boolean = true)
Link copied to clipboard
class LocalScreencastVideoTrack @AssistedInject constructor(@Assisted capturer: VideoCapturer, @Assisted source: VideoSource, @Assisted name: String, @Assisted options: LocalVideoTrackOptions, @Assisted rtcTrack: VideoTrack, @Assisted mediaProjectionCallback: LocalScreencastVideoTrack.MediaProjectionCallback, peerConnectionFactory: PeerConnectionFactory, context: Context, eglBase: EglBase, defaultsManager: DefaultsManager, videoTrackFactory: LocalVideoTrack.Factory) : LocalVideoTrack
Link copied to clipboard
class LocalTrackPublication(info: <Error class: unknown class>, track: Track, participant: LocalParticipant, val options: TrackPublishOptions) : TrackPublication
Link copied to clipboard
open class LocalVideoTrack @AssistedInject constructor(@Assisted capturer: VideoCapturer, @Assisted source: VideoSource, @Assisted name: String, @Assisted options: LocalVideoTrackOptions, @Assisted rtcTrack: VideoTrack, peerConnectionFactory: PeerConnectionFactory, context: Context, eglBase: EglBase, defaultsManager: DefaultsManager, trackFactory: LocalVideoTrack.Factory, @Assisted dispatchObserver: CaptureDispatchObserver? = null) : VideoTrack

A representation of a local video track (generally input coming from camera or screen).

Link copied to clipboard
data class LocalVideoTrackOptions(val isScreencast: Boolean = false, val deviceId: String? = null, val position: CameraPosition? = CameraPosition.FRONT, val captureParams: VideoCaptureParameter = VideoPreset169.H720.capture)
Link copied to clipboard
class RemoteAudioTrack(name: String, val rtcTrack: AudioTrack, receiver: RtpReceiver) : AudioTrack

A representation of a remote audio track.

Link copied to clipboard
class RemoteTrackPublication(info: <Error class: unknown class>, track: Track? = null, participant: RemoteParticipant, @Named(value = "dispatcher_io") ioDispatcher: CoroutineDispatcher) : TrackPublication
Link copied to clipboard
class RemoteVideoTrack(name: String, val rtcTrack: VideoTrack, val autoManageVideo: Boolean = false, @Named(value = "dispatcher_default") dispatcher: CoroutineDispatcher, receiver: RtpReceiver) : VideoTrack
Link copied to clipboard
abstract class Track(name: String, kind: Track.Kind, val rtcTrack: MediaStreamTrack)
Link copied to clipboard
sealed class TrackException : Exception
Link copied to clipboard
open class TrackPublication(info: <Error class: unknown class>, track: Track?, participant: Participant)
Link copied to clipboard
data class VideoCaptureParameter(val width: Int, val height: Int, val maxFps: Int)
Link copied to clipboard
Link copied to clipboard
data class VideoEncoding(val maxBitrate: Int, val maxFps: Int)
Link copied to clipboard
interface VideoPreset
Link copied to clipboard

16:9 Video presets along with suggested bitrates

Link copied to clipboard

4:3 Video presets along with suggested bitrates

Link copied to clipboard
Link copied to clipboard
abstract class VideoTrack(name: String, val rtcTrack: VideoTrack) : Track