live_ctrl_interface.h

浏览该文件的文档.

// Copyright (c) 2022 NetEase, Inc. All rights reserved.
// Use of this source code is governed by a MIT license that can be
// found in the LICENSE file.
 
#ifndef LIVE_CTRL_INTERFACE_H
#define LIVE_CTRL_INTERFACE_H
 
#include "base_ctrl_interface.h"
#include "base_type_defines.h"
#include "error_code_defines.h"
 
namespace neroom {
 
typedef enum tagNERoomLiveStreamAudioSampleRate {
    kRate32000 = 32000, 
    kRate44100 = 44100, 
    kRate48000 = 48000  
} NERoomLiveStreamAudioSampleRate;
 
typedef enum tagNERoomLiveStreamMode {
    kModeVideo, 
    kModeAudio  
} NERoomLiveStreamMode;
 
typedef enum tagNERoomLiveStreamAudioCodecProfile {
    kProfileLCAAC = 0, 
    kProfileHEAAC = 1  
} NERoomLiveStreamAudioCodecProfile;
 
typedef enum tagNERoomLiveStreamVideoScaleMode {
    kScaleFit = 0, 
    kScaleCropFill = 1 
} NERoomLiveStreamVideoScaleMode;
 
typedef struct tagNERoomLiveStreamImageInfo {
    std::string url; 
    int width = 0;   
    int height = 0;  
    int x = 0;       
    int y = 0;       
} NERoomLiveStreamImageInfo;
 
typedef struct tagNERoomLiveStreamUserTranscoding {
    std::string userUuid;  
    bool audioPush = true; 
    bool videoPush = true; 
    int width = 0;         
    int height = 0;        
    int x = 0;             
    int y = 0;             
    int zOrder = 0;        
    NERoomLiveStreamVideoScaleMode adaption = kScaleFit; 
} NERoomLiveStreamUserTranscoding;
 
typedef struct tagNERoomLiveStreamLayout {
    int backgroundColor =
        0; 
    NERoomLiveStreamImageInfo* backgroundImg = nullptr; 
    int width = 0;  
    int height = 0; 
    std::vector<NERoomLiveStreamUserTranscoding> userTranscodingList; 
} NERoomLiveStreamLayout;
 
typedef struct tagNERoomLiveConfig {
    bool singleVideoPassThrough = false;                                 
    int audioBitrate = 0;                                                
    int channels = 2;                                                    
    NERoomLiveStreamAudioCodecProfile audioCodecProfile = kProfileLCAAC; 
    NERoomLiveStreamAudioSampleRate sampleRate = kRate48000;             
} NERoomLiveConfig;
 
typedef struct tagNERoomLiveStreamTaskInfo {
    NERoomLiveConfig config;                
    std::string extraInfo;                  
    NERoomLiveStreamLayout layout;          
    NERoomLiveStreamMode mode = kModeVideo; 
    bool serverRecordEnabled = false;       
    std::string streamUrl;                  
    std::string taskId;                     
} NERoomLiveStreamTaskInfo;
 
class INERoomLiveController : public INEBaseController {
public:
    using NEStartLiveCallback = NECallback<>;
    using NEUpdateLiveCallback = NEStartLiveCallback;
    using NEStopLiveCallback = NEStartLiveCallback;
    using NEGetLiveBackgroundInfoCallback = NECallback<NERoomLiveBackgroundInfo>;
    using NEUpdateLiveBackgroundCallback = NECallback<time_t>;
 
public:
    virtual ~INERoomLiveController() = default;
 
    virtual NERoomLiveInfo getLiveInfo() = 0;
 
    virtual void startLive(const NERoomLiveRequest& live, const NECallback<NERoomLiveInfo>& callback) = 0;
 
    virtual void updateLive(const NERoomLiveRequest& live, const NEUpdateLiveCallback& callback) = 0;
 
    virtual void stopLive(const NEStopLiveCallback& callback) = 0;
 
    virtual void addLiveStreamTask(const NERoomLiveStreamTaskInfo& taskInfo, const NEEmptyCallback& callback) = 0;
 
    virtual void updateLiveStreamTask(const NERoomLiveStreamTaskInfo& taskInfo, const NEEmptyCallback& callback) = 0;
 
    virtual void removeLiveStreamTask(const std::string& taskId, const NEEmptyCallback& callback) = 0;
 
    virtual void getBackgroundInfo(const NEGetLiveBackgroundInfoCallback& callback) const = 0;
 
    virtual void updateBackgroundInfo(const NERoomLiveBackgroundParam& info, const NEUpdateLiveBackgroundCallback& callback) = 0;
};
 
}  // namespace neroom
#endif  // LIVE_CTRL_INTERFACE_H