esphome::api::CameraEntity Class Reference

Handle to a Camera entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::CameraEntity:

Collaboration diagram for esphome::api::CameraEntity:

Public Member Functions
std::optional< CameraInfo >	info () const
void	request_image (const bool single=true, const bool stream=false) const
	Request a still image (single) or start a stream.
Public Member Functions inherited from esphome::api::TypedEntity< CameraEntity >
std::string	icon () const
bool	disabled_by_default () const
EntityCategory	entity_category () const
std::uint32_t	device_id () const
	Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
Public Member Functions inherited from esphome::api::Entity
	Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
std::uint32_t	key () const noexcept
const std::string &	object_id () const noexcept
const std::string &	name () const noexcept

Static Public Member Functions
static constexpr EntityType	type ()

Additional Inherited Members
Protected Attributes inherited from esphome::api::Entity
Client *	client_
std::uint32_t	key_
std::string	object_id_
std::string	name_

Detailed Description

Handle to a Camera entity.

Member Function Documentation

info()

std::optional< CameraInfo > esphome::api::CameraEntity::info ( ) const

inline

request_image()

void esphome::api::CameraEntity::request_image ( const bool  single = true, const bool  stream = false  ) const

inline

Request a still image (single) or start a stream.

type()

static constexpr EntityType esphome::api::CameraEntity::type ( )

inlinestaticconstexpr

---

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

• include/esphome/api/model/entity_handles.hpp