Struct syeve::Encoder

pub struct Encoder { /* fields omitted */ }

Implementations

impl Encoder

pub fn new(
    size: (usize, usize),
    pixel_size: usize,
    compression: Compression,
    seq_len: u32
) -> Self

Creates a new encoder

pixel_size is the number of bytes per pixel.

Because each frame is encoded relatively to the previous frame, a lost frame can cause all the next frames to be wrong. Hence, we need to periodically send a frame that does not depend on the previous frame. seq_len (sequence length) is the number of frames between these “independent” frames. The higher, the longer glitches can remain. The lower, the more bandwidth will be used.

pub fn set_compression(&mut self, compression: Compression)

pub fn set_frame_settings(&mut self, pixel_size: usize, size: (usize, usize))

pub fn set_seq_len(&mut self, seq_len: u32)

pub fn set_seq_number(&mut self, seq_number: u32)

If the decoder may have already read data from another encoder, then you should ensure to set a different sequence number than the last one received by the decoder from the previous encoder. Otherwise, the decoder may think it’s the same sequence, and won’t decode the frame (thus possibly the entire sequence) correctly. If you don’t know, just use random.

pub fn get_compression(&self) -> &Compression

pub fn get_frame_number(&self) -> u32

pub fn get_pixel_size(&self) -> usize

pub fn get_seq_len(&self) -> u32

pub fn get_seq_number(&self) -> u32

pub fn get_size(&self) -> (usize, usize)

pub fn encode<W: Write>(
    &mut self,
    pixels: &mut [u8],
    buf: W
) -> Result<(), EncodeError>

Encode raw frame pixels into buf

Trait Implementations

impl Clone for Encoder

fn clone(&self) -> Encoder

Returns a copy of the value.

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

Performs copy-assignment from source.