NymphCast

Repository Structure · Getting Started · Multi-Room Playback · Building From Source · Developer's Guide · SDK · License · Donate

NymphCast is a software solution which turns your choice of hardware into an audio and video source for a television or (powered) speakers. It enables the streaming of audio and video over the network from a client device or media server, as well as the streaming of internet media to a NymphCast server, controlled by a client device, or directly on the receiver.

In addition, the server supports NymphCast apps (currently in preview status) written in AngelScript to extend the overall NymphCast functionality with e.g. 3rd party audio / video streaming protocol support on the server side, and customisable UIs in the client application.

NymphCast requires the use of a client device in all but the GUI ('Smart TV') mode. The server application (receiver) runs on a target device, while the client device functions as a remote control device:

Client-side core functionality is provided through the NymphCast library.

NymphCast Audio demo

The following video demonstrates NymphCast (v0.1-RC1) in an audio setup with a Raspberry Pi 2B, USB WiFi dongle, Generic 2.1 speaker set and an Android phone.

Usage Scenarios

NymphCast can be used in a number of scenarios:

• NymphCast Audio :arrow_right: Audio-only receiver mode.
  • Profile: nymphcast_audio_config.ini
  • Setup guide
• NymphCast Video :arrow_right: Audio & Video receiver mode.
  • Profile: nymphcast_video_config.ini
  • Setup guide
• NymphCast ScreenSaver :arrow_right: Like NymphCast Video, but with image-based ScreenSaver when not playing content.
  • Profile: nymphcast_screensaver_config.ini
  • Setup guide
• NymphCast GUI :arrow_right: Like NymphCast Video, but with stand-alone GUI mode (smart TV) enabled. (experimental feature)
  • Profile: nymphcast_gui_config.ini
  • Setup guide

Network ports

Note: NymphCast Server uses UDP port 4004 for discovery, and TCP port 4004 for playback.

All of these ports have to be reachable on a system running NymphCast Server.

Systems running the NymphCast MediaServer also need to have UDP & TCP ports 4005 reachable.

Please ensure that these ports are whitelisted in e.g. firewall rules if applicable.

Features & Status

The currently stable version is v0.1, with v0.2 in development. The followi