RTMP Ingest

Phenix supports ingest via RTMP push directly into a channel. This page provides specifics about the APIs used for RTMP. For additional information, such as limits on specific sources, please see the RTMP Integration Guide.

Push your RTMP feed to rtmp://ingest.phenixrts.com:80/ingest/ using the stream key from the channel API. Additional information on finding your stream key can be found on the related How-To page.

The basic RTMP URL looks like the following:

rtmp://ingest.phenixrts.com:80/ingest/{STREAMKEY}

Please note that changing options marked as experimental may alter expected behavior and may have unintended side effects and therefore should only be modified after consultation with the Phenix support staff.

RTMP publishing capabilities and tags can be set dynamically in the stream key or URL, or at the time of channel creation.

Capabilities and tags may be provided in the RTMP URL separated by semicolons, for example:

rtmp://ingest.phenixrts.com:80/ingest/{STREAMKEY};capabilities=fhd,multi-bitrate;tags=my-awesome-stream-id,my-customer-id

If your system does not allow the inclusion of semicolons in the URL, the | (pipe) can be used instead, for example:

rtmp://ingest.phenixrts.com:80/ingest/{STREAMKEY}|capabilities=fhd,multi-bitrate,prefer-h264|tags=my-awesome-stream-id,my-customer-id

Another method of adding options to RTMP publishing is to create them as a default (also known as "hardcoded capabilities") when creating a Channel or Room using the ingestOptions array.

Commonly-used capabilities include:

• Preferred resolution, either fhd, or hd, or sd
• multi-bitrate
• high-fidelity
• monitor-tracks
• kill-session-on-stream-ended
• kill-session-on-stream-failure
• aspect-ratio=16x9

When publishing RTMP to the Channel, use the Stream Key with no capabilities in your publishing tool or in the RTMP URL. If capabilities are passed with the RTMP stream key, the default settings will be ignored. Note that the RTMP stream key provided on the EdgeAuth/Publishing page in the Phenix Customer Portal includes capabilities.

To see the ingestOptions for a Room or Channel, fetch the Room or fetch the Channel.

PUT /pcast/channel HTTP/1.1
Host: pcast.phenixrts.com
Accept: application/json
Authorization: Basic YXBwbGljYXRpb25JZDpzZWNyZXQ=
Content-Type: application/json
Content-Length: 172
 
{
    "channel": {
        "alias": "<channelAlias>",
        "name": "<channelName>",
        "description": "<channelDescription>",
        "options": [],
        "ingestOptions": {
            "capabilities": ["hd,multi-bitrate","prefer-h264","aspect-ratio=9x16"],
            "tags": ["my-awesome-stream-id","my-customer-id"]
        }
    }
}