Playing Stream by URL

Feature Introduction

When the publishing end uses third-party publishing tools (such as OBS software, network camera IP Camera, etc.) to publish the stream to a CDN, or uses the ZEGO SDK's forward-to-CDN feature to push audio and video content to a third-party CDN, you can directly pass in the URL address to play the stream.

Prerequisites

Before implementing the URL playing stream feature, please 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 the ZEGO Express SDK in the project and implemented basic audio and video publishing and playing functions. For details, please refer to Quick Start - Integration and Quick Start - Implementation Flow.

• You have contacted ZEGO technical support to enable the URL playing stream feature.

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

Usage Steps

1 Configure playing stream parameters

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

ZegoPlayerConfig *playerConfig = [[ZegoPlayerConfig alloc] init];
ZegoCDNConfig *cdnConfig = [[ZegoCDNConfig alloc] init];
// url is the cdn playing stream address
cdnConfig.url = @"rtmp:\\xxxxxxx";
// If authentication is required, set authentication parameters
cdnConfig.auth = @"xxxx";
playerConfig.cdnConfig = cdnConfig;

ZegoPlayerConfig *playerConfig = [[ZegoPlayerConfig alloc] init];
ZegoCDNConfig *cdnConfig = [[ZegoCDNConfig alloc] init];
// url is the cdn playing stream address
cdnConfig.url = @"rtmp:\\xxxxxxx";
// If authentication is required, set authentication parameters
cdnConfig.auth = @"xxxx";
playerConfig.cdnConfig = cdnConfig;

2 Start playing stream

Start playing stream by calling the startPlayingStream interface.

When playing stream, if an error occurs, please refer to Common Error Codes - 1004xxx Playing Stream Related Error Codes.

// Start playing stream, set the remote playing stream rendering view canvas, use SDK default mode for view mode, aspect ratio scaling to fill the entire View
// After filling in the url parameter, the sdk will pull audio and video streams from the url, but still needs to pass a unique streamID to the SDK, the SDK will use this streamID to identify this stream internally
[[ZegoExpressEngine sharedEngine] startPlayingStream:streamID canvas:[ZegoCanvas canvasWithView:self.remoteUserView] config:playerConfig];

// Start playing stream, set the remote playing stream rendering view canvas, use SDK default mode for view mode, aspect ratio scaling to fill the entire View
// After filling in the url parameter, the sdk will pull audio and video streams from the url, but still needs to pass a unique streamID to the SDK, the SDK will use this streamID to identify this stream internally
[[ZegoExpressEngine sharedEngine] startPlayingStream:streamID canvas:[ZegoCanvas canvasWithView:self.remoteUserView] config:playerConfig];

3 Stop playing stream

To stop playing stream, call the stopPlayingStream interface.

// Stop playing stream
// The streamID passed when stopping playing stream is the streamID passed when playing stream
[[ZegoExpressEngine sharedEngine] stopPlayingStream:@"streamID"];

// Stop playing stream
// The streamID passed when stopping playing stream is the streamID passed when playing stream
[[ZegoExpressEngine sharedEngine] stopPlayingStream:@"streamID"];

4 (Optional) Listen to playing stream related event notifications

// Notification of user playing audio and video stream status
// When the user's playing audio and video stream status changes, this callback will be received. If the network is interrupted and causes playing stream abnormality, the SDK will automatically retry.
- (void)onPlayerStateUpdate:(ZegoPlayerState)state errorCode:(int)errorCode extendedData:(NSDictionary *)extendedData streamID:(NSString *)streamID {
    if (errorCode != 0) {
        NSLog(@"Playing stream status error streamID: %@, errorCode:%d", streamID, errorCode);
    } else {
        switch (state) {
            case ZegoPlayerStatePlaying:
                NSLog(@"Playing stream in progress");
                break;
            case ZegoPlayerStatePlayRequesting:
                NSLog(@"Requesting to play stream");
                break;
            case ZegoPlayerStateNoPlay:
                NSLog(@"Not playing stream");
                break;
        }
    }
}

// Notification of user playing audio and video stream status
// When the user's playing audio and video stream status changes, this callback will be received. If the network is interrupted and causes playing stream abnormality, the SDK will automatically retry.
- (void)onPlayerStateUpdate:(ZegoPlayerState)state errorCode:(int)errorCode extendedData:(NSDictionary *)extendedData streamID:(NSString *)streamID {
    if (errorCode != 0) {
        NSLog(@"Playing stream status error streamID: %@, errorCode:%d", streamID, errorCode);
    } else {
        switch (state) {
            case ZegoPlayerStatePlaying:
                NSLog(@"Playing stream in progress");
                break;
            case ZegoPlayerStatePlayRequesting:
                NSLog(@"Requesting to play stream");
                break;
            case ZegoPlayerStateNoPlay:
                NSLog(@"Not playing stream");
                break;
        }
    }
}