Struct Context 

pub struct Context<E: Encoder> { /* private fields */ }

Auxiliary structure to encapsulate an encoder object and its additional data.

Implementations

impl<E: Encoder> Context<E>

pub fn by_name<T: Descriptor<OutputEncoder = E> + ?Sized>( codecs: &Codecs<T>, name: &str, ) -> Option<Self>

Retrieves a codec descriptor from a codec list through its name, creates the relative encoder, and encapsulates it into a new Context.

pub fn configure(&mut self) -> Result<()>

Configures the encoder.

pub fn set_params(&mut self, params: &CodecParams) -> Result<()>

Sets the parameters associated to a determined codec.

pub fn get_params(&self) -> Result<CodecParams>

Gets the parameters associated to a determined codec.

pub fn set_option<'a, V>(&mut self, key: &str, val: V) -> Result<()>

where V: Into<Value<'a>>,

Sets an encoder option.

pub fn get_extradata(&mut self) -> Option<Vec<u8>>

Returns the extra data added by an encoder to a codec.

pub fn send_frame(&mut self, frame: &ArcFrame) -> Result<()>

Sends to the encoder a frame to be encoded.

pub fn receive_packet(&mut self) -> Result<Packet>

Returns an encoded packet.

pub fn flush(&mut self) -> Result<()>

Tells encoder to clear its internal state.

pub fn encoder(&self) -> &E

Returns the underlying encoder.