videosdk-android-sdk/live.videosdk.rtc.android.precall

Package-level declarations

Types

Link copied to clipboard
@Immutable
class PreCallAudioConfig(val microphoneId: String? = null, val encoderConfig: CustomMicrophoneTrackConfig? = null, val noiseConfig: NoiseConfig? = null)

How the test opens the microphone. Every field is optional; null is unset.

Link copied to clipboard
@Immutable
class PreCallAudioQuality

Audio measurements for one direction. bytesSent is filled on the uplink and bytesReceived on the downlink; the other is null.

Link copied to clipboard
@Immutable
class PreCallDirectionQuality

One direction's verdict: a single quality score, the factors that held it down, and the audio and video measurements the score came from.

Link copied to clipboard
@Immutable
class PreCallMediaReport

What one device — the camera or the microphone — did when the test opened it.

Link copied to clipboard
@Immutable
class PreCallNetworkQuality

How the connection behaved in each direction. Also what the onStatsChange callback of VideoSDK.runPreCallTest receives while the test is still running, so the same fields can drive a live meter and the final verdict.

Link copied to clipboard
class PreCallTestException(val code: String, message: String) : Exception

Why a pre-call test, or one device inside it, failed. Thrown by VideoSDK.runPreCallTest, and carried by PreCallMediaReport.error when only one device failed.

Link copied to clipboard
class PreCallTestOptions(val token: String, val samplingDuration: Int? = null, val audioOnly: Boolean = false, val videoTrack: CustomStreamTrack? = null, val audioTrack: CustomStreamTrack? = null, val videoConfig: PreCallVideoConfig? = null, val audioConfig: PreCallAudioConfig? = null)

Options for VideoSDK.runPreCallTest.

Link copied to clipboard
@Immutable
class PreCallTestResult

What a pre-call test found. Read it in three parts: camera and microphone say whether each device produced a usable track, and networkQuality scores what the connection did with it.

Link copied to clipboard
@Immutable
class PreCallVideoConfig(val cameraId: String? = null, val encoderConfig: CustomCameraTrackConfig? = null, val facingMode: FacingMode? = null, val multiStream: Boolean? = null, val bitrateMode: BitrateMode? = null, val maxLayer: EncodingLayer? = null)

How the test opens the camera. Every field is optional; null is unset.

Link copied to clipboard
@Immutable
class PreCallVideoQuality

Video measurements for one direction. The uplink fills bytesSent and qualityLimitationReason; the downlink fills bytesReceived and the frame-drop and freeze fields. Everything belonging to the other direction is null.