livekit-android-sdk/io.livekit.android.token

Package-level declarations

Types

abstract class BaseCachingTokenSource(store: TokenStore, validator: TokenValidator)

class CachingConfigurableTokenSource(source: ConfigurableTokenSource, store: TokenStore, validator: TokenValidator) : BaseCachingTokenSource, ConfigurableTokenSource

CachingFixedTokenSource

class CachingFixedTokenSource(source: FixedTokenSource, store: TokenStore, validator: TokenValidator) : BaseCachingTokenSource, FixedTokenSource

ConfigurableTokenSource

interface ConfigurableTokenSource : TokenSource

A configurable token source takes in a TokenRequestOptions when requesting credentials.

FixedTokenSource

interface FixedTokenSource : TokenSource

A non-configurable token source that does not take any options.

RoomAgentDispatch

@Serializable

data class RoomAgentDispatch(val agentName: String? = null, val metadata: String? = null)

RoomConfiguration

@Serializable

data class RoomConfiguration(val name: String? = null, val emptyTimeout: Int? = null, val departureTimeout: Int? = null, val maxParticipants: Int? = null, val metadata: String? = null, val minPlayoutDelay: Int? = null, val maxPlayoutDelay: Int? = null, val syncStreams: Int? = null, val agents: List<RoomAgentDispatch>? = null)

SandboxTokenServerOptions

data class SandboxTokenServerOptions(val baseUrl: String? = null)

TokenPayload

data class TokenPayload(val token: String)

Decodes a LiveKit connection token and grabs relevant information from it.

TokenRequestOptions

data class TokenRequestOptions(val roomName: String? = null, val participantName: String? = null, val participantIdentity: String? = null, val participantMetadata: String? = null, val participantAttributes: Map<String, String>? = null, val agentName: String? = null, val agentMetadata: String? = null)

The options for a token request.

TokenSource

interface TokenSource

TokenSourceRequest

@Serializable

data class TokenSourceRequest(val roomName: String?, val participantName: String?, val participantIdentity: String?, val participantMetadata: String?, val participantAttributes: Map<String, String>?, val roomConfig: RoomConfiguration?)

The JSON serializable format of the request sent to standard LiveKit token servers.

TokenSourceResponse

@Serializable

data class TokenSourceResponse(val serverUrl: String, val participantToken: String, val roomName: String? = null, val participantName: String? = null)

TokenStore

interface TokenStore

TokenValidator

typealias TokenValidator = (options: TokenRequestOptions?, response: TokenSourceResponse) -> Boolean

VideoGrants

data class VideoGrants(val room: String?, val roomJoin: Boolean?, val canPublish: Boolean?, val canPublishData: Boolean?, val canPublishSources: List<String>?, val canSubscribe: Boolean?)

Functions

cached

fun ConfigurableTokenSource.cached(store: TokenStore = InMemoryTokenStore(), validator: TokenValidator = defaultValidator): CachingConfigurableTokenSource

fun FixedTokenSource.cached(store: TokenStore = InMemoryTokenStore(), validator: TokenValidator = defaultValidator): CachingFixedTokenSource

Wraps the token store with a cache so that it reuses the token as long as it is valid.

hasValidToken

fun TokenSourceResponse.hasValidToken(tolerance: Duration = 60.seconds, date: Date = Date()): Boolean

Validates whether the JWT token is still valid.

toRequest

fun TokenRequestOptions.toRequest(): TokenSourceRequest

Converts a TokenRequestOptions to TokenSourceRequest, a JSON serializable request body.