Struct MemvidEncoder

pub struct MemvidEncoder { /* private fields */ }

Main encoder for creating QR code videos from text documents

Implementations

impl MemvidEncoder

pub async fn new(config: Option<Config>) -> Result<Self>

Create a new encoder with optional configuration

pub async fn add_text( &mut self, text: &str, chunk_size: usize, overlap: usize, ) -> Result<()>

Add text content with custom chunk size and overlap

pub async fn add_pdf<P: AsRef<Path>>(&mut self, pdf_path: P) -> Result<()>

Add PDF document content

pub async fn add_text_file<P: AsRef<Path>>( &mut self, file_path: P, ) -> Result<()>

Add plain text file content

pub async fn add_markdown_file<P: AsRef<Path>>( &mut self, file_path: P, ) -> Result<()>

Add markdown file content

pub async fn build_video( &mut self, output_file: &str, index_file: &str, ) -> Result<EncodingStats>

Build video from chunks, generating embeddings if enabled

pub async fn build_video_with_progress<F>( &mut self, output_file: &str, index_file: &str, progress_callback: F, ) -> Result<EncodingStats>

where F: Fn(f32),

Build video with progress callback

pub fn clear(&mut self)

Clear all chunks

pub fn get_stats(&self) -> EncodingStats

Get encoding statistics

pub fn chunk_count(&self) -> usize

Get current chunk count

pub fn config(&self) -> &Config

Get configuration

pub fn add_chunks(&mut self, chunks: Vec<String>) -> Result<()>

Add pre-chunked text content directly

pub fn has_embeddings(&self) -> bool

Check if embeddings are enabled (always true)

pub async fn append_chunks( &mut self, existing_video_file: &str, existing_index_file: &str, new_chunks: Vec<String>, ) -> Result<EncodingStats>

Append new chunks to an existing video and database (INCREMENTAL UPDATE) This is the core functionality for personal knowledge base use cases

pub async fn append_conversation_history( &mut self, existing_video_file: &str, existing_index_file: &str, conversations: Vec<(String, String)>, ) -> Result<EncodingStats>

Append chunks from LLM conversation history Specialized for the LLM conversation use case

pub async fn append_document_chunks( &mut self, existing_video_file: &str, existing_index_file: &str, document_path: &str, ) -> Result<EncodingStats>

Append chunks from document processing Specialized for the document indexing use case