API Reference

Documentation


On-premise Recording
Agora.io Community


Agora Recording C++ API Reference
Index IRecordingEngine IRecordingEngineEventHandler Warning Codes Error Codes
 #ifndef _IAGORA_RECORDINGENGINE_H_
 #define _IAGORA_RECORDINGENGINE_H_
 #include "IAgoraLinuxSdkCommon.h"
 
 namespace agora {
 namespace recording {
 class IRecordingEngineEventHandler {
 
 public:
     virtual ~IRecordingEngineEventHandler() {}
     
     virtual void onError(int error, agora::linuxsdk::STAT_CODE_TYPE stat_code) = 0;
 
     virtual void onWarning(int warn) = 0;
    
     virtual void onJoinChannelSuccess(const char * channelId, uid_t uid) = 0;
    
     virtual void onLeaveChannel(agora::linuxsdk::LEAVE_PATH_CODE code) = 0;
 
     virtual void onUserJoined(uid_t uid, agora::linuxsdk::UserJoinInfos &infos) = 0;
    
     virtual void onUserOffline(uid_t uid, agora::linuxsdk::USER_OFFLINE_REASON_TYPE reason) = 0;
 
     virtual void audioFrameReceived(unsigned int uid, const agora::linuxsdk::AudioFrame *frame) const = 0;
 
     virtual void videoFrameReceived(unsigned int uid, const agora::linuxsdk::VideoFrame *frame) const = 0;
 
     virtual void onActiveSpeaker(uid_t uid)  = 0;
 };
 
 typedef struct RecordingConfig {
     bool isAudioOnly;
     bool isVideoOnly;
     bool isMixingEnabled;
     agora::linuxsdk::MIXED_AV_CODEC_TYPE mixedVideoAudio;
     char * mixResolution;
     char * decryptionMode;
     char * secret;
     char * appliteDir;
     char * recordFileRootDir;
     char * cfgFilePath;
     agora::linuxsdk::VIDEO_FORMAT_TYPE decodeVideo;
     agora::linuxsdk::AUDIO_FORMAT_TYPE decodeAudio;
     int lowUdpPort;
     int highUdpPort;
     int idleLimitSec;
     int captureInterval;
     int audioIndicationInterval;
     agora::linuxsdk::CHANNEL_PROFILE_TYPE channelProfile;
     agora::linuxsdk::REMOTE_VIDEO_STREAM_TYPE streamType;
     agora::linuxsdk::TRIGGER_MODE_TYPE triggerMode;
     agora::linuxsdk::LANGUAGE_TYPE lang;
     char * proxyServer;
     agora::linuxsdk::AUDIO_PROFILE_TYPE audioProfile;
     char * defaultVideoBg;
     char * defaultUserBg;
 
 
     RecordingConfig(): channelProfile(agora::linuxsdk::CHANNEL_PROFILE_COMMUNICATION),
         isAudioOnly(false),
         isVideoOnly(false),
         isMixingEnabled(false),
         mixResolution(NULL),
         decryptionMode(NULL),
         secret(NULL),
         idleLimitSec(300),
         appliteDir(NULL),
         recordFileRootDir(NULL),
         cfgFilePath(NULL),
         lowUdpPort(0),
         highUdpPort(0),
         captureInterval(5),
         decodeAudio(agora::linuxsdk::AUDIO_FORMAT_DEFAULT_TYPE),
         decodeVideo(agora::linuxsdk::VIDEO_FORMAT_DEFAULT_TYPE),
         mixedVideoAudio(agora::linuxsdk::MIXED_AV_DEFAULT),
         streamType(agora::linuxsdk::REMOTE_VIDEO_STREAM_HIGH),
         triggerMode(agora::linuxsdk::AUTOMATICALLY_MODE),
         lang(agora::linuxsdk::CPP_LANG),
         proxyServer(NULL),
         audioProfile(agora::linuxsdk::AUDIO_PROFILE_DEFAULT),
         defaultVideoBg(NULL),
         defaultUserBg(NULL)
     {}
 
     virtual ~RecordingConfig() {}
 } RecordingConfig;
 
 typedef struct RecordingEngineProperties {
     char* storageDir;
     RecordingEngineProperties(): storageDir(NULL)
                           {}
 }RecordingEngineProperties;
 
 class IRecordingEngine {
 public:
 
     static IRecordingEngine* createAgoraRecordingEngine(const char * appId, IRecordingEngineEventHandler *eventHandler);
 
     virtual ~IRecordingEngine() {}
 
     virtual int joinChannel(const char * channelKey, const char *channelId, uid_t uid, const RecordingConfig &config) = 0;
 
     virtual int setVideoMixingLayout(const agora::linuxsdk::VideoMixingLayout &layout) = 0;
    
     virtual int stoppedOnError() = 0;
 
     virtual int leaveChannel() = 0;
 
     virtual int release() = 0;
 
     virtual const RecordingEngineProperties* getProperties() = 0;
 
     virtual int startService() = 0;
 
     virtual int stopService() = 0;
      
     virtual int setUserBackground(uid_t uid, const char* img_path) = 0;
 
     virtual int setLogLevel(agora::linuxsdk::agora_log_level level) = 0;
 
 };
 
 }
 }
 
 #endif