Struct libcamera::request::Request

pub struct Request { /* private fields */ }

A camera capture request.

Capture requests are created by ActiveCamera::create_request() and scheduled for execution by ActiveCamera::queue_request(). Completed requests are returned by request completed callback (see ActiveCamera::on_request_completed()) and can (should) be reused by calling ActiveCamera::queue_request() again.

Implementations

impl Request

pub fn controls(&self) -> &ControlList

Returns an immutable reference of request controls.

See controls for available items.

pub fn controls_mut(&mut self) -> &mut ControlList

Returns a mutable reference of request controls.

See controls for available items.

pub fn metadata(&self) -> &ControlList

Returns request metadata, which contains information relevant to the request execution (i.e. capture timestamp).

See controls for available items.

pub fn add_buffer<T: AsFrameBuffer + Any>( &mut self, stream: &Stream, buffer: T, ) -> Result<()>

Attaches framebuffer to the request.

Buffers can only be attached once. To access framebuffer after executing request use Self::buffer() or Self::buffer_mut().

pub fn buffer<T: 'static>(&self, stream: &Stream) -> Option<&T>

Returns a reference to the buffer that was attached with Self::add_buffer().

T must be equal to the type used in Self::add_buffer(), otherwise this will return None.

pub fn buffer_mut<T: 'static>(&mut self, stream: &Stream) -> Option<&mut T>

Returns a mutable reference to the buffer that was attached with Self::add_buffer().

T must be equal to the type used in Self::add_buffer(), otherwise this will return None.

pub fn sequence(&self) -> u32

Returns auto-incrementing sequence number of the capture

pub fn cookie(&self) -> u64

Returns request identifier that was provided in ActiveCamera::create_request().

Returns zero if cookie was not provided.

pub fn status(&self) -> RequestStatus

Capture request status

pub fn reuse(&mut self, flags: ReuseFlag)

Reset the request for reuse.

Reset the status and controls associated with the request, to allow it to be reused and requeued without destruction. This function shall be called prior to queueing the request to the camera, in lieu of constructing a new request. The application can reuse the buffers that were previously added to the request via Self::add_buffer() by setting flags to ReuseFlag::REUSE_BUFFERS.

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl Drop for Request

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Request