test-livestream-api

This repository contains information about videoDAC's test-livestream API.

Contents

• Objective
• About
• Public API
• Local API
• Connect to API
  • Command Line Interface
  • Graphical User Interface
  • Web Interface
  • Mobile SDK

Objective

To help developers of video-enabled applications start developing client applications for Consuming livestreaming video.

About

videoDAC's test-livestream API is a one-way livestream of AV (audiovisual) content.

The content is of a dynamic multi-coloured test card including an integer which increments every one second.

It is presented as a .m3u8 file extension, and contains a stream of hls AV segments.

The content is in 144p format, which is 256 pixels by 144 pixels, refreshing at a rate of 30 frames per second.

This is a gif file showing a sample of the content:

Public API

A publicly-available API is provided as a free-to-use hosted-service at the following URL:

http://52.29.226.43:8935/stream/hello_world.m3u8

http://52.29.226.43:8935/stream/hello_world.m3u8

Local API

To set up your own local API, go to simple-streaming-server.

Connect to API

Instructions for connecting to the API using a Command Line Interface or a Graphical User Interface.

Command Line Interface

curl (content meta-data only)

This requires curl to be installed on your system:

1. Open Terminal.

2. Run this command to Consume content meta-data from the test livestream API:

curl http://52.29.226.43:8935/stream/hello_world.m3u8

3. View content meta-data:

ffplay (FFmpeg)

This requires FFmpeg to be installed on your system:

1. Open Terminal.

2. Run this command to Consume content from the test-livestream API:

ffplay http://52.29.226.43:8935/stream/hello_world.m3u8

3. View content being played:

Graphical User Interface

VLC Media Player

This requires VLC Media Player to be installed on your system.

VLC Media Player is available on Android, iOS, Windows, Linux and MacOS.

1. Open VLC Media Player

2. Open Network Stream (Ctrl+n) and paste the URL for the API into the field:

3. Press Play, and view the content

OBS Studio

This requires OBS Studio to be installed on your system. OBS Studio is available on Windows, Linux and MacOS.

1. Open OBS Studio

2. Add a new "Media Source" under "Sources"

3. Deselect "Local File", and paste the URL for the API into the "Input" field:

4. Click "OK" and see the content as a new Source in OBS:

Web Interface

hls.js player

hls.js is a Javascript library for displaying hls video content.

Here is a sample html page containing hls.js player, playing content from the hosted test-livestream-api URL.

Alternatively, you can get started using hls.js documentation.

Mobile SDKs

Android (ExoPlayer)

ExoPlayer is an application level media player for Android.