Struct Client 

pub struct Client { /* private fields */ }

The VideoSDK server SDK client.

Cloning is cheap: clones share one connection pool and one token cache. The client mints and attaches the API token for its own requests automatically, so you never hand-roll a JWT or set the Authorization header.

// Reads VIDEOSDK_API_KEY and VIDEOSDK_SECRET from the environment.
let client = videosdk::Client::new()?;

Implementations

impl Client

pub fn new() -> Result<Self>

Constructs a client from the VIDEOSDK_API_KEY, VIDEOSDK_SECRET and VIDEOSDK_API_ENDPOINT environment variables.

pub fn builder() -> ClientBuilder

Starts building a client.

pub fn base_url(&self) -> &str

The resolved API endpoint.

pub fn with_max_retries(&self, max_retries: u32) -> Self

Returns a clone of this client that retries a different number of times.

The clone shares the same connection pool and token cache.

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

Returns a clone of this client with a different per-request timeout. Duration::ZERO disables the timeout.

pub fn generate_token(&self) -> Result<String>

Mints a fresh management token from the client’s credentials, applying any configured TokenOptions.

pub fn access_token(&self) -> Result<AccessTokenBuilder>

Starts building an access token.

Defaults to a participant token (roles: ["rtc"]); call AccessTokenBuilder::for_api for a management token.

pub fn verify_token(&self, token: &str) -> Result<TokenClaims>

Verifies a token against the client’s secret and returns its claims.

impl Client

pub async fn request( &self, method: Method, path: &str, request: RawRequest, ) -> Result<Value>

Calls any endpoint with an arbitrary HTTP method, applying auth and retries, and returns the undecoded JSON response.

For the common verbs, Client::api reads better.

pub fn api(&self) -> Api<'_>

The raw HTTP escape hatch. Each method applies auth and retries, and returns the undecoded JSON response.

impl Client

pub fn rooms(&self) -> RoomsResource<'_>

The rooms (meetings) API.

pub fn sessions(&self) -> SessionsResource<'_>

The sessions API, covering live and past sessions and their participants.

pub fn participants(&self) -> ParticipantsResource<'_>

A room-keyed view over a room’s live participants.

pub fn recordings(&self) -> RecordingsResource<'_>

The recordings API: room, participant, track, composite and merge.

pub fn hls(&self) -> HlsResource<'_>

The HLS API.

pub fn rtmp(&self) -> RtmpResource<'_>

The RTMP-out (livestream) API.

pub fn sip(&self) -> SipResource<'_>

The SIP / telephony API.

pub fn agents(&self) -> AgentsResource<'_>

The AI agents API: dispatch agents and manage cloud deployments.

pub fn alert_rules(&self) -> AlertRulesResource<'_>

The alert-rules API: metric-threshold alerts over your telemetry.

pub fn batch_call(&self) -> BatchCallsResource<'_>

The batch-calls API: bulk outbound phone campaigns.

pub fn connectors(&self) -> ConnectorsResource<'_>

The telephony connectors API.

pub fn resource_pool(&self) -> ResourcePoolResource<'_>

The resource-pool API: pre-acquire composition units. Enterprise tier.

pub fn transcodings(&self) -> TranscodingsResource<'_>

The transcoding API: post-process recordings and HLS into files.

pub fn transcription(&self) -> TranscriptionResource<'_>

The transcription API.

pub fn whip(&self) -> WhipResource<'_>

The WHIP ingress builder: WebRTC-HTTP publish into a room.

pub fn whep(&self) -> WhepResource<'_>

The WHEP egress builder: standards-based WebRTC pull from a room.

pub fn socket_ingress(&self) -> SocketIngressResource<'_>

Streams media and data frames into a room over a single-use WebSocket.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.