Release NotesUser InterfaceSystem Status
Recent API Changes
Back to All

08 April 2016 - Live Transcoding Zixi support and new Retranslation Endpoints format

almost 9 years ago by Encoding.com Product Team

Live Transcoding Zixi support

You can start the Live Transcoding process using your device with Zixi Feeder.
To start the stream follow these several steps:

  1. Use, or create a Retranslation Endpoint
  2. Configure your device, using the zixi-credentials from your endpoint.
  3. Create media with the zixi-source
<?xml version="1.0"?>
<query>
    <userid><<id>></userid><!-- REQUIRED -->
    <userkey><<key>></userkey><!-- REQUIRED -->
    <action>AddMedia</action>
    <source>zixi://stream.encoding.com/live/[ZixiStreamID]</source>
    <format>
        <output>live_hls</output>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "AddMedia",
        "source": "zixi://stream.encoding.com/live/[ZixiStreamID]",
        "format": {
            "output": "live_hls"
        }
    }
}

New Live Transcoding Retranslation Endpoints format

Now our Retranslation Endpoints service can be used as a Zixi Feeder endpoint.

📘

Note

We've changed endpoint's domain, but the old endpoint (rtmp.encoding.com) will also work.

Endpoint syntax:

TypeFormat
RTMP:rtmp://stream.encoding.com/live/[EndpointToken]
Zixi:zixi://stream.encoding.com/live/[ZixiStreamID]

Add Endpoint

Request:

📘

Note

Maximum number of endpoints is 10.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid><!-- REQUIRED -->
    <userkey><<key>></userkey><!-- REQUIRED -->
    <type>[all|rtmp|zixi]</type>
    <action>AddStreamEndpoint</action>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "type": "[all|rtmp|zixi]",
        "action": "AddStreamEndpoint"
    }
}
Field NameDescriptionAllowed ValuesDefault Values
typeType of Endpoint credentials used in response.all, rtmp, zixiall
Response:
<?xml version="1.0"?>
<response>
    <endpoint>
        <rtmp>
            <url>rtmp://stream.encoding.com/live/[EndpointToken]</url>
            <credentials>
                <host>stream.encoding.com</host>
                <port>1935</port>
                <app_name>live</app_name>
                <stream>[EndpointToken]</stream>
            </credentials>
        </rtmp>
        <zixi>
            <url>zixi://stream.encoding.com/live/[ZixiStreamID]</url>
            <credentials>
                <host>stream.encoding.com</host>
                <port>2088</port>
                <channel_name>[ZixiStreamID]</channel_name>
                <password>[ZixiPassword]</password>
            </credentials>
        </zixi>
    </endpoint>
</response>

{
    "response": {
        "endpoint": {
            "rtmp": {
                "url": "rtmp://stream.encoding.com/live/[EndpointToken]",
                "credentials": {
                    "host": "stream.encoding.com",
                    "port": "1935",
                    "app_name": "live",
                    "stream": "[EndpointToken]"
                }
            },
            "zixi": {
                "url": "zixi://stream.encoding.com/live/[ZixiStreamID]",
                "credentials": {
                    "host": "stream.encoding.com",
                    "port": "2088",
                    "channel_name": "[ZixiStreamID]",
                    "password": "[ZixiPassword]"
                }
            }
        }
    }
}

Get Endpoints

Request:
<?xml version="1.0"?>
<query>
    <userid><<id>></userid><!-- REQUIRED -->
    <userkey><<key>></userkey><!-- REQUIRED -->
    <action>GetStreamEndpointList</action>
    <type>[all|rtmp|zixi]</type>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "GetStreamEndpointList",
        "type": "[all|rtmp|zixi]"
    }
}
Field NameDescriptionAllowed ValuesDefault Values
typeType of Endpoint credentials in response.all, rtmp, zixiall
Response:
<?xml version="1.0"?>
<response>
    <endpoint>
        <status>[inactive|online]</status>
        <rtmp>
            <url>rtmp://stream.encoding.com/live/[EndpointToken]</url>
            <credentials>
                <host>stream.encoding.com</host>
                <port>1935</port>
                <app_name>live</app_name>
                <stream>[EndpointToken]</stream>
            </credentials>
        </rtmp>
        <zixi>
            <url>zixi://stream.encoding.com/live/[ZixiStreamID]</url>
            <credentials>
                <host>stream.encoding.com</host>
                <port>2088</port>
                <channel_name>[ZixiStreamID]</channel_name>
                <password>[ZixiPassword]</password>
            </credentials>
        </zixi>
    </endpoint>
</response>

{
    "response": {
        "endpoint": {
            "status": "[inactive|online]",
            "rtmp": {
                "url": "rtmp://stream.encoding.com/live/[EndpointToken]",
                "credentials": {
                    "host": "stream.encoding.com",
                    "port": "1935",
                    "app_name": "live",
                    "stream": "[EndpointToken]"
                }
            },
            "zixi": {
                "url": "zixi://stream.encoding.com/live/[ZixiStreamID]",
                "credentials": {
                    "host": "stream.encoding.com",
                    "port": "2088",
                    "channel_name": "[ZixiStreamID]",
                    "password": "[ZixiPassword]"
                }
            }
        }
    }
}

Delete Endpoint

Request:
<?xml version="1.0"?>
<query>
    <userid><<id>></userid><!-- REQUIRED -->
    <userkey><<key>></userkey><!-- REQUIRED -->
    <action>DeleteStreamEndpoint</action>
    <endpoint>[EndpointURL]</endpoint>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "DeleteStreamEndpoint",
        "endpoint": "[EndpointURL]"
    }
}
Response:
<?xml version="1.0"?>
<response>
    <success>Endpoint is deleted!</success>
</response>

{
    "response": {
        "success": "Endpoint is deleted!"
    }
}