esp32cam::Frame Class Reference

A frame of picture. More...

#include <frame.hpp>

Classes
struct	CameraFbT

Public Member Functions
	~Frame ()
uint8_t *	data () const
size_t	size () const
int	getWidth () const
int	getHeight () const
bool	writeTo (Print &os, int timeout=10000)
	Write frame buffer to os . More...
bool	writeTo (Client &os, int timeout=10000)
	Write frame buffer to os . More...
bool	isJpeg () const
bool	toJpeg (int quality)
	Convert frame to JPEG. More...
bool	isBmp () const
bool	toBmp ()
	Convert frame to BMP. More...

Friends
class	CameraClass

Detailed Description

A frame of picture.

Constructor & Destructor Documentation

~Frame()

esp32cam::Frame::~Frame

(

)

Member Function Documentation

data()

uint8_t* esp32cam::Frame::data ( ) const

inline

getHeight()

int esp32cam::Frame::getHeight ( ) const

inline

getWidth()

int esp32cam::Frame::getWidth ( ) const

inline

isBmp()

bool esp32cam::Frame::isBmp

(

)

const

isJpeg()

bool esp32cam::Frame::isJpeg

(

)

const

size()

size_t esp32cam::Frame::size ( ) const

inline

toBmp()

bool esp32cam::Frame::toBmp

(

)

Convert frame to BMP.

toJpeg()

bool esp32cam::Frame::toJpeg

(

int

quality

)

Convert frame to JPEG.

Parameters

quality

JPEG quality between 0 (worst) and 100 (best).

writeTo() [1/2]

bool esp32cam::Frame::writeTo	(	Client &	os,
		int	timeout = 10000
	)

Write frame buffer to os .

Parameters

os	output socket.
timeout	total time limit in millis.

Return values

true	writing completed.
false	writing disrupted by timeout or socket error.

writeTo() [2/2]

bool esp32cam::Frame::writeTo	(	Print &	os,
		int	timeout = 10000
	)

Write frame buffer to os .

Parameters

os	output stream.
timeout	total time limit in millis.

Return values

true	writing completed.
false	writing disrupted by timeout.

Friends And Related Function Documentation

CameraClass

friend class CameraClass

friend

---

The documentation for this class was generated from the following files:

• /home/runner/work/esp32cam/esp32cam/src/esp32cam/frame.hpp
• /home/runner/work/esp32cam/esp32cam/src/esp32cam/frame.cpp