Playing Stream by URL

Overview

When the publishing end uses third-party publishing tools (such as OBS software, IP Camera, etc.) to push the stream to CDN, or uses ZEGO SDK to relay the audio and video screen to third-party CDN through the CDN relaying function, you can directly pass in the URL address to play the stream.

Prerequisites

Before implementing the URL stream playing functionality, ensure:

• You have created a project in the ZEGOCLOUD Console and applied for a valid AppID and AppSign. For details, please refer to Console - Project Information.

• You have integrated ZEGO Express SDK into the project and implemented basic audio and video streaming functionality. For details, please refer to Quick Start - Integration and Quick Start - Implementation.

• You have contacted ZEGOCLOUD Technical Support to enable the URL stream playing functionality.

• You have pushed the audio and video stream to CDN and know the corresponding URL. For details, please refer to Use CDN for Live Streaming.

Usage Steps

1 Configure Stream Playing Parameters

To play streams directly through the CDN's URL address, you need to use the ZegoCDNConfig object to fill in the URL parameters. If the corresponding CDN has configured stream playing authentication, you also need to fill in the authentication parameters through the authParam field.

// Set CDN parameters
let config = new ZegoCDNConfig();
// URL is the CDN stream playing address
config.url = "rtmp://xxxxxxxx";
// If authentication is required, set the authentication parameters. If authentication is not required, you can leave it unset (the authentication parameter cannot contain the "?" character)
config.authParam = "xxx";

let playerConfig = { cdnConfig: config }

// Set CDN parameters
let config = new ZegoCDNConfig();
// URL is the CDN stream playing address
config.url = "rtmp://xxxxxxxx";
// If authentication is required, set the authentication parameters. If authentication is not required, you can leave it unset (the authentication parameter cannot contain the "?" character)
config.authParam = "xxx";

let playerConfig = { cdnConfig: config }

2 Start Playing Stream

Call the startPlayingStream interface to start playing stream. If an error occurs during stream playing, please refer to Common Error Codes - 1004xxx Stream Playing Related Error Codes.

// Start playing stream
// After filling in the url parameter, the SDK will pull the audio and video stream from the url, but you still need to pass a unique streamID to the SDK, and the SDK will use this streamID to identify this stream internally
ZegoExpressEngine.instance().startPlayingStream("STREAM_ID", playerConfig);

// Start playing stream
// After filling in the url parameter, the SDK will pull the audio and video stream from the url, but you still need to pass a unique streamID to the SDK, and the SDK will use this streamID to identify this stream internally
ZegoExpressEngine.instance().startPlayingStream("STREAM_ID", playerConfig);

3 Stop Playing Stream

To stop playing stream, call the stopPlayingStream interface.

// The streamID passed when stopping playing stream is the streamID passed when playing stream
ZegoExpressEngine.instance().stopPlayingStream("STREAM_ID");

// The streamID passed when stopping playing stream is the streamID passed when playing stream
ZegoExpressEngine.instance().stopPlayingStream("STREAM_ID");

4 (Optional) Listen to Stream Playing Related Event Notifications

ZegoExpressEngine.instance().on("playerStateUpdate", (streamID, state, errorCode, extendedData) => {
    console.info(`playerStateUpdate:streamID:${streamID}, state:${state}, errorCode:${errorCode}, extendedData:${JSON.stringify(extendedData)}`);

    // After successfully calling the playing stream interface, when the player state changes, such as network interruption causing publishing exceptions, etc., the SDK will notify through this callback while retrying to play stream
    // 1. When receiving this callback notification and state is Playing, it indicates successful stream playing
    // 2. When receiving this callback notification and state is PlayRequesting, it indicates that it may be playing stream or the SDK is retrying to play stream due to network interruption, etc.
    // 3. When receiving this callback notification and state is NoPlay, it indicates stream playing has stopped
    // 4. When playing stream by URL, the stream_id in the callback parameters is the stream ID when calling the playing stream API, used to uniquely identify the current stream playing event.
});

ZegoExpressEngine.instance().on("playerStateUpdate", (streamID, state, errorCode, extendedData) => {
    console.info(`playerStateUpdate:streamID:${streamID}, state:${state}, errorCode:${errorCode}, extendedData:${JSON.stringify(extendedData)}`);

    // After successfully calling the playing stream interface, when the player state changes, such as network interruption causing publishing exceptions, etc., the SDK will notify through this callback while retrying to play stream
    // 1. When receiving this callback notification and state is Playing, it indicates successful stream playing
    // 2. When receiving this callback notification and state is PlayRequesting, it indicates that it may be playing stream or the SDK is retrying to play stream due to network interruption, etc.
    // 3. When receiving this callback notification and state is NoPlay, it indicates stream playing has stopped
    // 4. When playing stream by URL, the stream_id in the callback parameters is the stream ID when calling the playing stream API, used to uniquely identify the current stream playing event.
});