Home Assistant Unofficial Reference 2024.12.1
Namespaces | Classes | Functions | Variables
homeassistant.components.ffmpeg Namespace Reference

Namespaces

 camera
 

Classes

class  FFmpegBase
 
class  FFmpegManager
 

Functions

None __init__ (self, _HAFFmpegT ffmpeg, bool initial_state=True)
 
None _async_register_events (self)
 
None _async_restart_ffmpeg (self, list[str]|None entity_ids)
 
None _async_start_ffmpeg (self, list[str]|None entity_ids)
 
None _async_stop_ffmpeg (self, list[str]|None entity_ids)
 
None async_added_to_hass (self)
 
bytes|None async_get_image (HomeAssistant hass, str input_source, str output_format=IMAGE_JPEG, str|None extra_cmd=None, int|None width=None, int|None height=None)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool available (self)
 
FFmpegManager get_ffmpeg_manager (HomeAssistant hass)
 

Variables

bool _attr_should_poll = False
 
string CONF_EXTRA_ARGUMENTS = "extra_arguments"
 
string CONF_FFMPEG_BIN = "ffmpeg_bin"
 
string CONF_INITIAL_STATE = "initial_state"
 
string CONF_INPUT = "input"
 
string CONF_OUTPUT = "output"
 
 CONFIG_SCHEMA
 
string DATA_FFMPEG = "ffmpeg"
 
string DEFAULT_BINARY = "ffmpeg"
 
string DOMAIN = "ffmpeg"
 
 ffmpeg
 
 initial_state
 
string OFFICIAL_IMAGE_VERSION = "6.0"
 
 SERVICE_FFMPEG_SCHEMA = vol.Schema({vol.Optional(ATTR_ENTITY_ID): cv.entity_ids})
 
string SERVICE_RESTART = "restart"
 
string SERVICE_START = "start"
 
string SERVICE_STOP = "stop"
 
 SIGNAL_FFMPEG_RESTART = SignalType[list[str] | None]("ffmpeg.restart")
 
 SIGNAL_FFMPEG_START = SignalType[list[str] | None]("ffmpeg.start")
 
 SIGNAL_FFMPEG_STOP = SignalType[list[str] | None]("ffmpeg.stop")
 

Detailed Description

Support for FFmpeg.

Function Documentation

◆ __init__()

None homeassistant.components.ffmpeg.__init__ (   self,
_HAFFmpegT  ffmpeg,
bool   initial_state = True 
) 
Initialize ffmpeg base object.

Definition at line 184 of file __init__.py.

◆ _async_register_events()

None homeassistant.components.ffmpeg._async_register_events (   self)
private 
Register a FFmpeg process/device.

Definition at line 243 of file __init__.py.

◆ _async_restart_ffmpeg()

None homeassistant.components.ffmpeg._async_restart_ffmpeg (   self,
list[str] | None  entity_ids 
)
private 
Stop a FFmpeg process.

This method is a coroutine.

Definition at line 233 of file __init__.py.

◆ _async_start_ffmpeg()

None homeassistant.components.ffmpeg._async_start_ffmpeg (   self,
list[str] | None  entity_ids 
)
private 
Start a FFmpeg process.

This method is a coroutine.

Definition at line 218 of file __init__.py.

◆ _async_stop_ffmpeg()

None homeassistant.components.ffmpeg._async_stop_ffmpeg (   self,
list[str] | None  entity_ids 
)
private 
Stop a FFmpeg process.

This method is a coroutine.

Definition at line 225 of file __init__.py.

◆ async_added_to_hass()

None homeassistant.components.ffmpeg.async_added_to_hass (   self) 
Register dispatcher & events.

This method is a coroutine.

Definition at line 189 of file __init__.py.

◆ async_get_image()

bytes | None homeassistant.components.ffmpeg.async_get_image ( HomeAssistant  hass,
str  input_source,
str   output_format = IMAGE_JPEG,
str | None   extra_cmd = None,
int | None   width = None,
int | None   height = None 
) 
Get an image from a frame of an RTSP stream.

Definition at line 114 of file __init__.py.

◆ async_setup()

bool homeassistant.components.ffmpeg.async_setup ( HomeAssistant  hass,
ConfigType  config 
) 
Set up the FFmpeg component.

Definition at line 69 of file __init__.py.

◆ available()

bool homeassistant.components.ffmpeg.available (   self) 
Return True if entity is available.

Definition at line 214 of file __init__.py.

◆ get_ffmpeg_manager()

FFmpegManager homeassistant.components.ffmpeg.get_ffmpeg_manager ( HomeAssistant  hass) 
Return the FFmpegManager.

Definition at line 106 of file __init__.py.

Variable Documentation

◆ _attr_should_poll

bool homeassistant.components.ffmpeg._attr_should_poll = False
private 
Interface object for FFmpeg.

Definition at line 182 of file __init__.py.

◆ CONF_EXTRA_ARGUMENTS

string homeassistant.components.ffmpeg.CONF_EXTRA_ARGUMENTS = "extra_arguments"

Definition at line 46 of file __init__.py.

◆ CONF_FFMPEG_BIN

string homeassistant.components.ffmpeg.CONF_FFMPEG_BIN = "ffmpeg_bin"

Definition at line 45 of file __init__.py.

◆ CONF_INITIAL_STATE

string homeassistant.components.ffmpeg.CONF_INITIAL_STATE = "initial_state"

Definition at line 43 of file __init__.py.

◆ CONF_INPUT

string homeassistant.components.ffmpeg.CONF_INPUT = "input"

Definition at line 44 of file __init__.py.

◆ CONF_OUTPUT

string homeassistant.components.ffmpeg.CONF_OUTPUT = "output"

Definition at line 47 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.ffmpeg.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {vol.Optional(CONF_FFMPEG_BIN, default=DEFAULT_BINARY): cv.string}
5  )
6  },
7  extra=vol.ALLOW_EXTRA,
8 )

Definition at line 57 of file __init__.py.

◆ DATA_FFMPEG

string homeassistant.components.ffmpeg.DATA_FFMPEG = "ffmpeg"

Definition at line 41 of file __init__.py.

◆ DEFAULT_BINARY

string homeassistant.components.ffmpeg.DEFAULT_BINARY = "ffmpeg"

Definition at line 49 of file __init__.py.

◆ DOMAIN

string homeassistant.components.ffmpeg.DOMAIN = "ffmpeg"

Definition at line 31 of file __init__.py.

◆ ffmpeg

homeassistant.components.ffmpeg.ffmpeg

Definition at line 186 of file __init__.py.

◆ initial_state

homeassistant.components.ffmpeg.initial_state

Definition at line 187 of file __init__.py.

◆ OFFICIAL_IMAGE_VERSION

string homeassistant.components.ffmpeg.OFFICIAL_IMAGE_VERSION = "6.0"

Definition at line 55 of file __init__.py.

◆ SERVICE_FFMPEG_SCHEMA

homeassistant.components.ffmpeg.SERVICE_FFMPEG_SCHEMA = vol.Schema({vol.Optional(ATTR_ENTITY_ID): cv.entity_ids})

Definition at line 66 of file __init__.py.

◆ SERVICE_RESTART

string homeassistant.components.ffmpeg.SERVICE_RESTART = "restart"

Definition at line 35 of file __init__.py.

◆ SERVICE_START

string homeassistant.components.ffmpeg.SERVICE_START = "start"

Definition at line 33 of file __init__.py.

◆ SERVICE_STOP

string homeassistant.components.ffmpeg.SERVICE_STOP = "stop"

Definition at line 34 of file __init__.py.

◆ SIGNAL_FFMPEG_RESTART

homeassistant.components.ffmpeg.SIGNAL_FFMPEG_RESTART = SignalType[list[str] | None]("ffmpeg.restart")

Definition at line 39 of file __init__.py.

◆ SIGNAL_FFMPEG_START

homeassistant.components.ffmpeg.SIGNAL_FFMPEG_START = SignalType[list[str] | None]("ffmpeg.start")

Definition at line 37 of file __init__.py.

◆ SIGNAL_FFMPEG_STOP

homeassistant.components.ffmpeg.SIGNAL_FFMPEG_STOP = SignalType[list[str] | None]("ffmpeg.stop")

Definition at line 38 of file __init__.py.