ZixiPlugin

ZixiPlugin is the tight integration of Zixi SDK to Ant Media Server.

Features

ZixiClient

It can connect and pulls the stream from ZixiBroadcaster to Ant Media Server so that you can watch the stream with WebRTC/HLS/DASH etc. on Ant Media Server. In other words, any stream in ZixiBroadcaster can be available in Ant Media Server

ZixiFeeder

It can push the stream in Ant Media Server to ZixiBroadcaster so that any stream ingested by WebRTC, RTSP, RTMP, SRT, etc. in Ant Media Server can be available in ZixiBroadcaster

REST Methods

You can control everything through REST Methods. REST Methods will be available for each application in the Ant Media Server. For all methods, please take a look at the ZixiRestService.java

How to Install

Pre-request

You need to install Ant Media Server Enterprise Edition in your instance. ZixiPlugin is compatible with Ant Media Server 2.5.2 and later versions. Current zixi-plugin.jar is x86_64 compatible.

Install

1. Download the pre-built zixi-plugin.jar file

wget https://github.com/ant-media/Plugins/raw/master/ZixiPlugin/build/zixi-plugin.jar

2. Copy the zixi-plugin.jar file to plugins directory under /usr/local/antmedia

sudo cp zixi-plugin.jar /usr/local/antmedia/plugins

3. Restart the service

sudo service antmedia restart

How to Use

ZixiPlugins have REST Methods so start ZixiClient and ZixiFeeder. Firstly, please install your ZixiBroadcast to your instance. Please reach out to Zixi to have ZixiBroadcaster and instructions.

Start a ZixiClient

1. Click INPUTS in ZixiBroadcaster and then Click New Input

2. Add a new stream with Push type. You can give any name for stream id. In the sample below, we use as stream1.

3. Push a stream to ZixiBroadcaster. You need to have Zixi SDK to push the stream to ZixiBroadcaster. Here are the commands we use to push the stream

   $ git clone https://github.com/ant-media/Plugins.git
   $ cd Plugins/ZixiPlugin/src/test/resources/zixi_sdks-antmedia-16.4.44489/linux64/test/
   $ ffmpeg -re -i ../../../test.flv -codec copy -f mpegts udp://127.0.0.1:1234?pkt_size=1316 
   

   The command above push the content of a UDP stream to the 1234 port of localhost. In a second terminal go to Zixi SDK directory again

   $ cd Plugins/ZixiPlugin/src/test/resources/zixi_sdks-antmedia-16.4.44489/linux64/test/
   $ export LD_LIBRARY_PATH=../lib
   $ ./feeder_interface_tester 1234 127.0.0.1 2088 stream1 1000 10000 0 -1 0
   

   The command above gets the packet from 1234 port and push to the ZixiBroadcasters in 127.0.0.1 through 2088 port and stream1 channel.

4. You must see that stream1 is online on the ZixiBroadcaster as shown below

5. Call the REST Method below to let Ant Media Server pull the stream from ZixiBroadcaster through the following url zixi://127.0.0.1:2077/stream1

   curl -X "POST" http://127.0.0.1:5080/LiveApp/rest/zixi/client?start=true -H 'Content-Type: application/json' -d '{"streamUrl":"zixi://127.0.0.1:2077/stream1"}'
   

   The method should return something below. Please pay attention to dataId field because it's the stream id to play the stream in Ant Media Server

   {"success":"true", "message":"Stream pulling is started for ", "dataId":"zLPmjtlT7whX1670583419181", "errorId":0}

6. Visit http://AMS_SERVER_IP:5080/LiveApp/player.html. Write the stream id(zLPmjtlT7whX1670583419181) to the box below and click the Start Playing button.

   

7. Stop the streaming from client. Pay attention that the stream id(zLPmjtlT7whX1670583419181) is being used in the URL

   curl -X "DELETE" http://127.0.0.1:5080/LiveApp/rest/zixi/client/zLPmjtlT7whX1670583419181 -H 'Content-Type: application/json'
   

Start a ZixiFeeder

1. Click INPUTS in ZixiBroadcaster and then Click New Input

2. Add a new stream with Push type. You can give any name for stream id. In the sample below, we use as stream2.

3. Publish a stream to Ant Media Server through WebRTC on https://AMS_FQDN_DOMAIN:5443/LiveApp as shown below with 'webrtc_stream'

   

4. Call the following REST method to push the 'webrtc_stream' to the ZixiBroadcaster. Pay attention that we use webrtc_stream in the url below and add the ZixiBroadcaster endpoint as url parameter(zixi://127.0.0.1:2088/stream2)

   curl -X "POST" http://127.0.0.1:5080/LiveApp/rest/zixi/feeder/webrtc_stream?url=zixi://127.0.0.1:2088/stream2  -H 'Content-Type: application/json'
   

5. Go to the ZixiBroadcaster and see that stream2 is connected on ZixiBroadcaster

6. Stop the ZixiFeeder with the following command by using stream id webrtc_stream at the end of the url

   curl -X "DELETE" http://127.0.0.1:5080/LiveApp/rest/zixi/feeder/webrtc_stream  -H 'Content-Type: application/json'