ktobs
0.5.0indexedOffers a wrapper around the OBS WebSocket API to control OBS programmatically, featuring core functionality and a Ktor-based WebSocket implementation for seamless integration.
4
Stars
—
Used by
dependents
—
Health
/ 100
Offers a wrapper around the OBS WebSocket API to control OBS programmatically, featuring core functionality and a Ktor-based WebSocket implementation for seamless integration.
Ktobs is a Kotlin multiplatform library that provides a convenient wrapper around the OBS WebSocket API, allowing you to programmatically control OBS from your Kotlin applications.
The library is available on Maven Central. It consists of two modules:
ktobs-core: Core functionality and APIktobs-ktor: Ktor-based WebSocket implementationrepositories {
mavenCentral()
}
dependencies {
implementation("io.github.rejeq:ktobs-core:<version>")
implementation("io.github.rejeq:ktobs-ktor:<version>")
}
repositories {
mavenCentral()
}
dependencies {
implementation "io.github.rejeq:ktobs-core:<version>"
implementation "io.github.rejeq:ktobs-ktor:<version>"
}
Here's a basic example of how to use ktobs with ktor backend:
fun main() = runBlocking {
val client = HttpClient(CIO) {
install(WebSockets) {
pingIntervalMillis = 20_000
contentConverter = KotlinxWebsocketSerializationConverter(Json)
}
}
// Configure OBS session
val session = ObsSessionBuilder(client).apply {
host = "127.0.0.1"
port = 4455
password = "your_password"
eventSubs = ObsEventSubs.General + ObsEventSubs.Inputs
// or listen all events
// eventsSubs = ObsEventSubs.All
}
// Handle OBS events
session.onEvent = { event ->
when (event.eventType) {
ExitStartedEvent -> println("OBS is shutting down")
InputCreatedEvent -> {
val data = event.get<InputCreatedEventData>()
println("Input was created: ${data.inputName}")
}
}
}
// Connect and execute commands
try {
session.connect {
// Get list of input kinds
val kindList = getInputKindList()
println("Available input kinds: $kindList")
// Create a new FFmpeg source
val response = createInput(
sceneName = "Scene",
name = "StreamSource",
kind = "ffmpeg_source",
settings = JsonObject(mapOf(
"input" to JsonPrimitive("your stream host"),
"is_local_file" to JsonPrimitive(false)
)
)
)
}
} catch (e: ObsAuthException) {
println("Failed to authenticate: $e")
} catch (e: ObsRequestException) {
println("Failed to execute request: $e")
}
client.close()
}
Surfaced from shared tags and platforms — no rankings paid for.