Struct ScreenpipeClient

pub struct ScreenpipeClient { /* private fields */ }

Main client for interacting with the Screenpipe API

Implementations

impl ScreenpipeClient

pub fn new(base_url: &str) -> Result<Self>

Create a new ScreenpipeClient

Arguments

• base_url - The base URL of the Screenpipe server (e.g., “http://localhost:3030”)

Example

use screenpipe_sdk_rs::ScreenpipeClient;
 
let client = ScreenpipeClient::new("http://localhost:3030")?;

pub fn with_client(base_url: &str, client: HttpClient) -> Result<Self>

Create a new ScreenpipeClient with custom HTTP client configuration

pub async fn handle_response<T: DeserializeOwned>( response: Response, ) -> Result<T>

pub fn build_url(&self, path: &str) -> Result<Url>

pub async fn health(&self) -> Result<HealthResponse>

Get server health status

pub async fn search(&self, params: SearchRequest) -> Result<SearchResponse>

Search for content

pub async fn list_audio_devices(&self) -> Result<Vec<AudioDevice>>

List available audio devices

pub async fn list_monitors(&self) -> Result<Vec<Monitor>>

List available monitors

pub async fn add_tags( &self, content_type: &str, id: &str, tags: Vec<String>, ) -> Result<TagsResponse>

Add tags to content

pub async fn remove_tags( &self, content_type: &str, id: &str, tags: Vec<String>, ) -> Result<TagsResponse>

Remove tags from content

pub async fn get_pipe_info(&self, pipe_id: &str) -> Result<PipeInfo>

Get pipe information

pub async fn list_pipes(&self) -> Result<Vec<PipeInfo>>

List all pipes

pub async fn download_pipe(&self, url: &str) -> Result<PipeResponse>

Download a pipe from URL

pub async fn enable_pipe(&self, pipe_id: &str) -> Result<PipeResponse>

Enable a pipe

pub async fn disable_pipe(&self, pipe_id: &str) -> Result<PipeResponse>

Disable a pipe

pub async fn update_pipe_config( &self, pipe_id: &str, config: HashMap<String, Value>, ) -> Result<PipeResponse>

Update pipe configuration

pub async fn execute_raw_sql(&self, query: &str) -> Result<Value>

Execute raw SQL query

pub async fn add_content( &self, request: AddContentRequest, ) -> Result<SuccessResponse>

Add content to the database

pub async fn input_control( &self, action: InputAction, ) -> Result<SuccessResponse>

Control input (experimental)

pub async fn merge_videos( &self, video_paths: Vec<String>, ) -> Result<MergeVideosResponse>

Merge videos (experimental)

pub async fn stream_frames( &self, start_time: Option<DateTime<Utc>>, end_time: Option<DateTime<Utc>>, ) -> Result<impl Stream<Item = Result<StreamFrame>>>

Stream frames (returns a stream)

Trait Implementations

impl Clone for ScreenpipeClient

fn clone(&self) -> ScreenpipeClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScreenpipeClient

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

Formats the value using the given formatter.