Android SDK reference: methods, events, options and errors

The complete surface of in.voltkit:voltkit-rtc 0.9.4. For how to use it, start with the Android SDK page and the voice call and audio room guides.

Errors

Every call fails with RpcError (code, message, data). Decide on code, log message. The codes are the same in every VoltKit SDK; info (from the shared registry) says whether a code is terminal (retrying cannot help) or retryable.

try {
    client.publish(PublishOptions(video = false))
} catch (e: RpcError) {
    when (e.code) {
        "media-unavailable" -> askForPermission(e.data?.get("permission"))
        "forbidden" -> showListenerOnly()
        "media-disabled" -> showNotAllowed()
        "closed" -> startNewCall()
        else -> if (e.info?.retryable == true) retryLater() else showError(e.message)
    }
}
scope.launch { client.onError.collect { e -> log("voltkit ${e.code}: ${e.message}") } }

onError carries every problem that is not the answer to a call you made: quality warnings, a subscription or republish that failed, a microphone or camera failure, and the endings replaced and reconnect-gave-up. onPublishWarning repeats the quality warnings as text; onSubscribeError the failed subscriptions with their producer.

Codes this SDK raises itself:

Warnings on onError (publishing goes on): codec-fallback, degradation-preference-failed, frame-rate-fallback, frame-rate-not-allowed, video-quality-not-allowed, audio-quality-not-allowed, video-subscription-limit.

Codes from the server you may meet: bad-token (expired or wrong token: mint a new one), no-room and room-ended, kicked, quota-exhausted, daily-limit-reached, monthly-limit-reached and tenant-suspended (the account), participant-quota / viewer-quota, slot-taken, slot-blocked, slot-occupied, chat-muted, rate-limited, source-already-published, token-mismatch (updateToken with a token for another room or identity). Every code: Errors.

API reference

StreamClient

StreamClient(context, wsUrl, token, options = StreamOptions()); also StreamClient(context, wsUrl, token, connection: ConnectionOptions).

Room and chat calls: raiseHand, lowerHand, claim, release, blockSlot, unblockSlot, setMetadata, setRoomMetadata, muteParticipant, requestMute, forceMute, promote, kick, endRoom, getRoomState, sendMessage, getMessages, deleteMessage, muteChat, setTyping, getChatState (see above).

RemoteTrack

identity, producerId, consumerId, kind (audio / video), source (mic, music, camera, screen), isAudio, isVideo, isMusic, isEnded, track; addSink(sink), removeSink(sink), setVolume(0.0..10.0) (this device only; 0 on a music track mutes the music and keeps the voice), setEnabled(on).

StreamOptions

Threads

Every suspend function is main-safe; media work runs on the client's own thread. Flows are hot SharedFlows: collect before connect() so nothing is missed (onClosed replays to a late collector). The same client may be used from any thread.