This software application consists of server components deployed in a docker container and client components that run on embedded devices such as android machines and smart TVs.
This service consumes the guide and recording service to provide video streaming, playback control, and guide / scheduling.
This service will provide a REST API that performs the following functions:
- Manage video streams.
- Allow viewer to start an ephemeral recording stream.
- Allow viewer to stream a video file from the library (previously recorded)
- Allow viewer to pause, play, ffwd, rwnd, and stop a stream.
- Display information about current streams. This can be used for the system dashboard.
- Store what is viewed and when along with cursors. This can be used to
provide advanced features like:
- Continue watching...
- Favorite shows...
Streams will always originate from a file on disk. Even viewing live TV will require an ephemeral recording for the desired channel which will then be streamed to the viewer.
ffmpeg or VLC or similar will be used to actually stream the video data.
Streaming may use RTP or HTTP or both.
Recordings will be written using a configurable format. Viewers may request a different format which will require transcoding. The streaming software (ffmpeg or VLC or similar) will convert the data before streaming it.
The guide service is responsible for providing the data necessary for viewing and scheduling TV shows and recordings.
This service provides a REST API to perform the following functions:
- Fetch a dataset including available channels and the programming scheduled for those channels as well as scheduled and ongoing recordings. This data will come from HDHomeRun tuner, the recording service and a TV listing data source.
- Create a scheduled recording by POSTing the start time, end time, and channel.
- Fetch a list of scheduled recordings.
As well as an HTML interface that:
- Renders an HTML / Javascript guide that can be viewed within client applications. The data will originate from the guide service.
- Performs necessary actions to allow a browser to view a video stream.
The guide service may serve the web interface available to desktop computers. If the user chooses not to use the viewer "app" on an embedded device, the web interface available from the guide will be their only UI.