Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.stream.core.StreamView Class Reference
Inheritance diagram for homeassistant.components.stream.core.StreamView:
[legend]
Collaboration diagram for homeassistant.components.stream.core.StreamView:
[legend]

Public Member Functions

web.StreamResponse get (self, web.Request request, str token, str sequence="", str part_num="")
 
web.StreamResponse handle (self, web.Request request, Stream stream, str sequence, str part_num)
 

Static Public Attributes

bool requires_auth = False
 

Detailed Description

Base StreamView.

For implementation of a new stream format, define `url` and `name`
attributes, and implement `handle` method in a child class.

Definition at line 371 of file core.py.

Member Function Documentation

◆ get()

web.StreamResponse homeassistant.components.stream.core.StreamView.get (   self,
web.Request  request,
str  token,
str   sequence = "",
str   part_num = "" 
)
Start a GET request.

Definition at line 380 of file core.py.

◆ handle()

web.StreamResponse homeassistant.components.stream.core.StreamView.handle (   self,
web.Request  request,
Stream  stream,
str  sequence,
str   part_num 
)

Member Data Documentation

◆ requires_auth

bool homeassistant.components.stream.core.StreamView.requires_auth = False
static

Definition at line 378 of file core.py.


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