Struct LiveKitApi 

pub struct LiveKitApi { /* private fields */ }

A single entry point to every LiveKit server API, exposing each service through an accessor (room(), egress(), ingress(), sip(), agent_dispatch(), connector()).

Construct it with an API key and secret (with_api_key, or new to read them from the environment) for backend use, or with a pre-signed token (with_token) for client-side use where the API secret must not be exposed.

Implementations

impl LiveKitApi

pub fn with_api_key(host: &str, api_key: &str, api_secret: &str) -> Self

pub fn new(host: &str) -> ServiceResult<Self>

Reads the key and secret from the LIVEKIT_API_KEY and LIVEKIT_API_SECRET environment variables.

pub fn with_token(host: &str, token: &str) -> Self

Authenticates with a pre-signed token, sent verbatim on every request. The token’s grants must cover the calls made through this client.

pub fn with_failover(self, enabled: bool) -> Self

Enables or disables region failover on every service (enabled by default). Failover only engages for LiveKit Cloud hosts.

pub fn with_request_timeout(self, timeout: Duration) -> Self

Overrides the default per-request timeout (10s) on every service.

pub fn room(&self) -> &RoomClient

pub fn egress(&self) -> &EgressClient

pub fn ingress(&self) -> &IngressClient

pub fn sip(&self) -> &SIPClient

pub fn agent_dispatch(&self) -> &AgentDispatchClient

pub fn connector(&self) -> &ConnectorClient

Trait Implementations

impl Debug for LiveKitApi

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.