Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.voip.voip.PreRecordMessageProtocol Class Reference
Inheritance diagram for homeassistant.components.voip.voip.PreRecordMessageProtocol:
[legend]
Collaboration diagram for homeassistant.components.voip.voip.PreRecordMessageProtocol:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, str file_name, int opus_payload_type, float message_delay=1.0, float loop_delay=2.0, RtcpState|None rtcp_state=None)
 
None on_chunk (self, bytes audio_bytes)
 

Public Attributes

 file_name
 
 hass
 
 loop_delay
 
 message_delay
 

Private Member Functions

None _play_message (self)
 

Private Attributes

 _audio_bytes
 
 _audio_task
 

Detailed Description

Plays a pre-recorded message on a loop.

Definition at line 121 of file voip.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.voip.voip.PreRecordMessageProtocol.__init__ (   self,
HomeAssistant  hass,
str  file_name,
int  opus_payload_type,
float   message_delay = 1.0,
float   loop_delay = 2.0,
RtcpState | None   rtcp_state = None 
)
Set up RTP server.

Definition at line 124 of file voip.py.

Member Function Documentation

◆ _play_message()

None homeassistant.components.voip.voip.PreRecordMessageProtocol._play_message (   self)
private

Definition at line 164 of file voip.py.

◆ on_chunk()

None homeassistant.components.voip.voip.PreRecordMessageProtocol.on_chunk (   self,
bytes  audio_bytes 
)
Handle raw audio chunk.

Definition at line 148 of file voip.py.

Member Data Documentation

◆ _audio_bytes

homeassistant.components.voip.voip.PreRecordMessageProtocol._audio_bytes
private

Definition at line 156 of file voip.py.

◆ _audio_task

homeassistant.components.voip.voip.PreRecordMessageProtocol._audio_task
private

Definition at line 159 of file voip.py.

◆ file_name

homeassistant.components.voip.voip.PreRecordMessageProtocol.file_name

Definition at line 142 of file voip.py.

◆ hass

homeassistant.components.voip.voip.PreRecordMessageProtocol.hass

Definition at line 141 of file voip.py.

◆ loop_delay

homeassistant.components.voip.voip.PreRecordMessageProtocol.loop_delay

Definition at line 144 of file voip.py.

◆ message_delay

homeassistant.components.voip.voip.PreRecordMessageProtocol.message_delay

Definition at line 143 of file voip.py.


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