RTMP Push Stream to ZEGO Server

Feature Introduction

In live streaming scenarios, hosts can push audio and video streams to ZEGO servers via RTMP push streaming tools to achieve low latency. Viewers can use ZEGO Express SDK to play streams.

RTMP push streaming tools refer to third-party tools that push streams via RTMP addresses, mainly including hardware push streaming devices, software OBS, etc.

Prerequisites

Contacted ZEGOCLOUD Technical Support to enable permissions for RTMP tools to push streams to ZEGO servers.
Prepared RTMP push streaming tools, such as OBS.

Usage Steps

Get RTMP Push Stream Address

Please contact ZEGOCLOUD Technical Support to enable the service and obtain the RTMP push stream address through the RTMP Push Stream Dispatch server-side interface.

Use RTMP Tool to Push Stream

The following uses OBS as an example to introduce RTMP tool push streaming operations.

Set Push Stream Address

Open the OBS tool, click "Settings" in the "Controls" tab at the bottom toolbar to enter the settings interface.

Click "Stream" to enter the stream settings tab, select the service type as "Custom Streaming Server".
Fill in the obtained RTMP push stream address in the "Server" and "Stream Key" fields.

Server: Corresponds to the RTMP push stream address, i.e., rtmp://hosts/AppName/

Please note that the RTMP push stream address URL is different from the push stream address URL in CDN Stream Publishing Authentication. Do not mix them up. Please distinguish them when using.
Stream Key: Corresponds to the RTMP push stream name, i.e., "streamID".

Click "OK" to save the above settings information.

Set Push Stream Guide

In the "Source" tab at the bottom toolbar, click the "+" button.

Select an input source as needed, such as "Display Capture".

Use OBS to Push Stream

In the "Controls" tab at the bottom toolbar, click "Start Streaming" to push the audio and video stream to the set push stream address. A green light appears at the bottom, indicating successful push streaming.

To stop pushing streams, click "Stop Streaming" in the "Controls" tab.

Warning

After using the RTMP tool to push streams, users cannot receive notifications of audio and video stream additions or deletions through the RoomStreamUpdate callback. They can obtain notifications through the following two ways:

After using the RTMP tool to push streams, the business server sends the third-party push "streamID" to other users in the room through business signaling, notifying other users in the room that there is a stream addition or deletion.
You can use ZEGO server-side Add Room Stream and Delete Room Stream interfaces to add or delete stream information to a specified room, and send the "streamID" information to other users in the room. At this time, other users can receive notifications of audio and video stream additions or deletions through the RoomStreamUpdate callback.

Use SDK to Play/Stop Playing Stream

Call the startPlayingStream interface and pass in the "streamID" of the RTMP push (i.e., the "Stream Key" set when setting the push stream address) to play the stream. The following takes Live Streaming as an example. For other play methods, please refer to Implementing Live Streaming.

// Stream status update callback
zg.on('roomStreamUpdate', async (roomID, updateType, streamList, extendedData) => {
    // When updateType is ADD, it means there is a new audio and video stream. At this time, you can call the startPlayingStream interface to play this audio and video stream
    if (updateType == 'ADD') {
        // Stream added, start playing
        // To make the example code more concise, we only play the first stream in the newly added audio and video stream list. In actual business, it is recommended for developers to loop through streamList and play each audio and video stream

        let playOption = {};
        let video = document.create
        playOption.resourceMode = 2;

         const remoteStream = await zg.startPlayingStream(streamID);

        // Create a media stream playback component object for playing remote media streams.
        const remoteView = zg.createRemoteStreamView(remoteStream);
        // Mount the playback component to the page, "remote-video" is the id of the component container DOM element.
        remoteView.play("remote-video");

    } else if (updateType == 'DELETE') {
        // Stream deleted, stop playing
    }
});

// Stream status update callback
zg.on('roomStreamUpdate', async (roomID, updateType, streamList, extendedData) => {
    // When updateType is ADD, it means there is a new audio and video stream. At this time, you can call the startPlayingStream interface to play this audio and video stream
    if (updateType == 'ADD') {
        // Stream added, start playing
        // To make the example code more concise, we only play the first stream in the newly added audio and video stream list. In actual business, it is recommended for developers to loop through streamList and play each audio and video stream

        let playOption = {};
        let video = document.create
        playOption.resourceMode = 2;

         const remoteStream = await zg.startPlayingStream(streamID);

        // Create a media stream playback component object for playing remote media streams.
        const remoteView = zg.createRemoteStreamView(remoteStream);
        // Mount the playback component to the page, "remote-video" is the id of the component container DOM element.
        remoteView.play("remote-video");

    } else if (updateType == 'DELETE') {
        // Stream deleted, stop playing
    }
});

Call the stopPlayingStream interface and pass in the "streamID" of the RTMP push (i.e., the "Stream Key" set when setting the push stream address) to stop playing the audio and video stream pushed by the remote end.

// Stream status update callback
zg.on('roomStreamUpdate', async (roomID, updateType, streamList, extendedData) => {
    if (updateType == 'ADD') {
        // Stream added, start playing
    } else if (updateType == 'DELETE') {
        // Stream deleted, stop playing streams through the streamID of each stream in the stream deletion list.
        const streamID = streamList[0].streamID;
        zg.stopPlayingStream(streamID)
    }
});

// Stream status update callback
zg.on('roomStreamUpdate', async (roomID, updateType, streamList, extendedData) => {
    if (updateType == 'ADD') {
        // Stream added, start playing
    } else if (updateType == 'DELETE') {
        // Stream deleted, stop playing streams through the streamID of each stream in the stream deletion list.
        const streamID = streamList[0].streamID;
        zg.stopPlayingStream(streamID)
    }
});

FAQ

1. How does the business server know whether the RTMP push tool has started or stopped pushing streams?

ZEGO provides publish_start start push stream and publish_stop stop push stream callback notifications. For needs, please contact ZEGOCLOUD Technical Support for configuration.