ManagerVideos

homey.manager.videos

Manages video streams used by the App. You can access this manager through the Homey instance as self.homey.videos.

Ancestors

Methods

get_video

def get_video(self, id: str) ‑> Video

Get the video with the given ID.

Raises

NotFound
Raised if no video with the given ID is found.

unregister_video

async def unregister_video(self, video: Video)

Unregisters the given video.

Args

NameTypeDescription
video Video The Video to unregister.

Raises

NotRegistered
Raised if the video is not registered.

create_video_web_rtc

async def create_video_web_rtc(self, data_channel=True) ‑> VideoWebRTC

Create a WebRTC video instance for video streaming. The video must be associated with a device using Device.set_camera_video() to enable streaming functionality.

Args

NameTypeDescription
data_channel Whether the frontend should set up a WebRTC data channel for bidirectional communication. Some video streams don't work with a data channel and some don't work without it.

create_video_rtsp

async def create_video_rtsp(self,
allow_invalid_certificates=False,
demuxer: "Literal['h264', 'h265', 'mpegts', 'ts'] | None" = None)
‑> VideoRTSP

Create an RTSP video instance for video streaming. The video must be associated with a device using Device.set_camera_video() to enable streaming functionality.

create_video_rtmp

async def create_video_rtmp(self,
allow_invalid_certificates=False,
demuxer: "Literal['h264', 'h265', 'mpegts', 'ts'] | None" = None)
‑> VideoRTMP

Create an RTMP video instance for video streaming. The video must be associated with a device using Device.set_camera_video() to enable streaming functionality.

create_video_hls

async def create_video_hls(self,
allow_invalid_certificates=False,
demuxer: "Literal['h264', 'h265', 'mpegts', 'ts'] | None" = None)
‑> VideoHLS

Create a HLS video instance for video streaming. The video must be associated with a device using Device.set_camera_video() to enable streaming functionality.

create_video_dash

async def create_video_dash(self,
allow_invalid_certificates=False,
demuxer: "Literal['h264', 'h265', 'mpegts', 'ts'] | None" = None)
‑> VideoDASH

Create a DASH video instance for video streaming. The video must be associated with a device using Device.set_camera_video() to enable streaming functionality.

create_video_other

async def create_video_other(self,
allow_invalid_certificates=False,
demuxer: "Literal['h264', 'h265', 'mpegts', 'ts'] | None" = None)
‑> VideoOther

Create a video instance for video streaming. This video can contain any VLC-supported URL, and the front-end will try to play it. The video must be associated with a device using Device.set_camera_video() to enable streaming functionality.

Inherited members