Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.axis.camera.AxisCamera Class Reference
Inheritance diagram for homeassistant.components.axis.camera.AxisCamera:
[legend]
Collaboration diagram for homeassistant.components.axis.camera.AxisCamera:
[legend]

Public Member Functions

None __init__ (self, AxisHub hub)
 
None async_added_to_hass (self)
 
str generate_options (self, bool skip_stream_profile=False, bool add_video_codec_h264=False)
 
str image_source (self)
 
str mjpeg_source (self)
 
str stream_source (self)
 
- Public Member Functions inherited from homeassistant.components.axis.entity.AxisEntity
None async_signal_reachable_callback (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Private Member Functions

None _generate_sources (self)
 

Private Attributes

 _mjpeg_url
 
 _still_image_url
 
 _stream_source
 

Static Private Attributes

 _attr_supported_features = CameraEntityFeature.STREAM
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.axis.entity.AxisEntity
 hub
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a Axis camera.

Definition at line 37 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.axis.camera.AxisCamera.__init__ (   self,
AxisHub  hub 
)
Initialize Axis Communications camera component.

Reimplemented from homeassistant.components.axis.entity.AxisEntity.

Definition at line 46 of file camera.py.

Member Function Documentation

◆ _generate_sources()

None homeassistant.components.axis.camera.AxisCamera._generate_sources (   self)
private
Generate sources.

Additionally used when device change IP address.

Definition at line 73 of file camera.py.

◆ async_added_to_hass()

None homeassistant.components.axis.camera.AxisCamera.async_added_to_hass (   self)
Subscribe camera events.

Reimplemented from homeassistant.components.axis.entity.AxisEntity.

Definition at line 63 of file camera.py.

◆ generate_options()

str homeassistant.components.axis.camera.AxisCamera.generate_options (   self,
bool   skip_stream_profile = False,
bool   add_video_codec_h264 = False 
)
Generate options for video stream.

Definition at line 118 of file camera.py.

◆ image_source()

str homeassistant.components.axis.camera.AxisCamera.image_source (   self)
Return still image URL for device.

Definition at line 105 of file camera.py.

◆ mjpeg_source()

str homeassistant.components.axis.camera.AxisCamera.mjpeg_source (   self)
Return mjpeg URL for device.

Definition at line 110 of file camera.py.

◆ stream_source()

str homeassistant.components.axis.camera.AxisCamera.stream_source (   self)
Return the stream source.

Definition at line 114 of file camera.py.

Member Data Documentation

◆ _attr_supported_features

homeassistant.components.axis.camera.AxisCamera._attr_supported_features = CameraEntityFeature.STREAM
staticprivate

Definition at line 40 of file camera.py.

◆ _mjpeg_url

homeassistant.components.axis.camera.AxisCamera._mjpeg_url
private

Definition at line 88 of file camera.py.

◆ _still_image_url

homeassistant.components.axis.camera.AxisCamera._still_image_url
private

Definition at line 83 of file camera.py.

◆ _stream_source

homeassistant.components.axis.camera.AxisCamera._stream_source
private

Definition at line 93 of file camera.py.


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