Struct EgressClient 

pub struct EgressClient { /* private fields */ }

Implementations

impl EgressClient

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

Authenticates with an API key and secret, signing a short-lived token per request.

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

Authenticates with a pre-signed token, sent verbatim on every request.

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

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

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

Enables or disables region failover (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) for calls on this client.

pub async fn start_room_composite_egress( &self, room: &str, outputs: Vec<EgressOutput>, options: RoomCompositeOptions, ) -> ServiceResult<EgressInfo>

pub async fn start_web_egress( &self, url: &str, outputs: Vec<EgressOutput>, options: WebOptions, ) -> ServiceResult<EgressInfo>

pub async fn start_participant_egress( &self, room: &str, participant_identity: &str, outputs: Vec<EgressOutput>, options: ParticipantEgressOptions, ) -> ServiceResult<EgressInfo>

pub async fn start_track_composite_egress( &self, room: &str, outputs: Vec<EgressOutput>, options: TrackCompositeOptions, ) -> ServiceResult<EgressInfo>

pub async fn start_track_egress( &self, room: &str, output: TrackEgressOutput, track_id: &str, ) -> ServiceResult<EgressInfo>

pub async fn update_layout( &self, egress_id: &str, layout: &str, ) -> ServiceResult<EgressInfo>

pub async fn update_stream( &self, egress_id: &str, add_output_urls: Vec<String>, remove_output_urls: Vec<String>, ) -> ServiceResult<EgressInfo>

pub async fn list_egress( &self, options: EgressListOptions, ) -> ServiceResult<Vec<EgressInfo>>

pub async fn stop_egress(&self, egress_id: &str) -> ServiceResult<EgressInfo>

Trait Implementations

impl Debug for EgressClient

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

Formats the value using the given formatter.