rvoip — Universal real-time gateway library

Maturity tiers (plain numeric — no -alpha/-beta suffixes): 0.1.x = alpha, 0.2.x = beta, 1.0 = stable. The sip surface is beta (0.2.2); the other surfaces (app, webrtc, uctp, the voip-3 extensions, client) are alpha (0.1.0) — expect breaking changes before 1.0. Pin exact versions.

rvoip is the facade crate for the rvoip workspace. It always compiles the voip-3 substrate (rvoip-core's Orchestrator + the shared Conversation/Session/ Connection/Stream/Message/Participant model) and lets you opt into transports and extensions behind cargo features — defaulting to the SIP product. One process, one Orchestrator, many protocols, bridged through a single conversation model.

Quick start

[dependencies]
rvoip = "0.2.2"   # default feature: sip

use rvoip::{Orchestrator, Config};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // `Orchestrator::new` returns an `Arc<Orchestrator>`.
    let orchestrator = Orchestrator::new(Config::default());

    // Register interop adapters (e.g. a SIP adapter built from a configured
    // `rvoip::sip::UnifiedCoordinator`) with `orchestrator.register(adapter)?`.

    let mut events = orchestrator.subscribe_events();
    while let Ok(event) = events.recv().await {
        // handle each orchestrator event (inbound call, bridge, recording, …)
        drop(event);
    }
    Ok(())
}

The unifying nouns are re-exported at the crate root from rvoip-core-traits as rvoip::core_traits. For a SIP softphone with microphone/speaker audio, see the rvoip-sip examples — sip_client (a terminal softphone with CPAL device I/O) and pbx.

For a compact cross-transport gateway, enable app and declare roles, transports, assignment, and callbacks through rvoip::app:

rvoip = { version = "0.2.2", features = ["app"] }

use rvoip::app::*;

# async fn run() -> rvoip::app::AppResult<()> {
let app = RvoipApp::builder()
    .webrtc(WebRtcConfig::ws("127.0.0.1:8081")
        .allow(Role::Customer, [Capability::Text, Capability::Voice]))
    .sip(SipConfig::bind("127.0.0.1:5060")
        .domain("callcenter.local")
        .allow(Role::Employee, [Capability::Voice])
        .registrar_users([("alice", "password123")]))
    .employees(EmployeePolicy::named(["alice"]))
    .customers(CustomerPolicy::webrtc_only())
    .assignment(AssignmentPolicy::fixed("alice"))
    .on_message(|ctx, msg| async move {
        ctx.reply("Alice", format!("Alice received: {}", msg.text)).await
    })
    .build()
    .await?;
app.run().await
# }

Cargo features

The transport-agnostic conversation-model extensions — vCon emission, identity backends, and the AI harness — are reachable only through the voip-3 feature.

# e.g. the full multi-transport rvoip-3 experience
rvoip = { version = "0.2.2", features = ["voip-3"] }

Module layout

Crate map

Beta — published at 0.2.2 (the SIP product + shared spine): rvoip (facade), rvoip-core, rvoip-core-traits, rvoip-infra-common, the media engine (rvoip-media-core · rvoip-rtp-core · rvoip-codec-core), the SIP stack (rvoip-sip + sip-core · sip-transport · sip-dialog · sip-proxy · sip-registrar), and rvoip-auth-core.

Alpha — published at 0.1.0 (opt-in surfaces): rvoip-webrtc; the UCTP family (rvoip-uctp · rvoip-quic · rvoip-webtransport · rvoip-websocket); rvoip::app · rvoip-vcon · rvoip-harness · rvoip-stir-shaken; rvoip-identity · rvoip-users-core; rvoip-client.

Documentation

• API docs: docs.rs/rvoip
• Workspace overview: repository README
• Architecture & protocol design: PRD.md, INTERFACE_DESIGN.md, CONVERSATION_PROTOCOL.md

License

Licensed under the MIT License.