nertc_engine_ex.h

Go to the documentation of this file.

#ifndef NERTC_ENGINE_EX_H
#define NERTC_ENGINE_EX_H

#include "nertc_base.h"
#include "nertc_base_types.h"
#include "nertc_engine_defines.h"
#include "nertc_engine_event_handler.h"
#include "nertc_engine_media_stats_observer.h"
#include "nertc_engine.h"

namespace nertc
{
class IRtcEngineEx : public IRtcEngine
{
public:
    virtual ~IRtcEngineEx() {}

    virtual NERtcConnectionStateType getConnectionState() = 0;

    virtual int muteLocalAudioStream(bool mute) = 0;

    virtual int setAudioProfile(NERtcAudioProfileType profile, NERtcAudioScenarioType scenario) = 0;

    virtual int setAudioEffectPreset(NERtcVoiceChangerType type) = 0;

    virtual int setVoiceBeautifierPreset(NERtcVoiceBeautifierType type) = 0;

    virtual int setLocalVoicePitch(double pitch) = 0;

    virtual int setLocalVoiceEqualization(NERtcVoiceEqualizationBand band_frequency, int band_gain) = 0;

    virtual int subscribeRemoteAudioStream(uid_t uid, bool subscribe) = 0;

    virtual int setVideoConfig(const NERtcVideoConfig& config) = 0;

    virtual int enableDualStreamMode(bool enable) = 0;

    virtual int setupLocalSubStreamVideoCanvas(NERtcVideoCanvas* canvas) = 0;

    virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode) = 0;

    virtual int setLocalSubStreamRenderMode(NERtcVideoScalingMode scaling_mode) = 0;

    virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode) = 0;

    virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;

    virtual int setupRemoteSubStreamVideoCanvas(uid_t uid, NERtcVideoCanvas* canvas) = 0;

    virtual int subscribeRemoteVideoSubStream(uid_t uid, bool subscribe) = 0;

    virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;

    virtual int startVideoPreview() = 0;

    virtual int stopVideoPreview() = 0;

    virtual int muteLocalVideoStream(bool mute) = 0;

    virtual int setParameters(const char* parameters) = 0;

    virtual int setRecordingAudioFrameParameters(NERtcAudioFrameRequestFormat *format) = 0;

    virtual int setPlaybackAudioFrameParameters(NERtcAudioFrameRequestFormat *format) = 0;


    virtual int setMixedAudioFrameParameters(int sample_rate) = 0;

    virtual int setAudioFrameObserver(INERtcAudioFrameObserver *observer) = 0;

    virtual int startAudioDump() = 0;
    virtual int stopAudioDump() = 0;

    virtual int startAudioMixing(NERtcCreateAudioMixingOption *option) = 0;

    virtual int stopAudioMixing() = 0;

    virtual int pauseAudioMixing() = 0;

    virtual int resumeAudioMixing() = 0;

    virtual int setAudioMixingSendVolume(uint32_t volume) = 0;

    virtual int getAudioMixingSendVolume(uint32_t *volume) = 0;

    virtual int setAudioMixingPlaybackVolume(uint32_t volume) = 0;

    virtual int getAudioMixingPlaybackVolume(uint32_t *volume) = 0;

    virtual int getAudioMixingDuration(uint64_t *duration) = 0;

    virtual int getAudioMixingCurrentPosition(uint64_t *position) = 0;

    virtual int setAudioMixingPosition(uint64_t seek_position) = 0;

    virtual int playEffect(uint32_t effect_id, NERtcCreateAudioEffectOption *option) = 0;

    virtual int stopEffect(uint32_t effect_id) = 0;

    virtual int stopAllEffects() = 0;

    virtual int pauseEffect(uint32_t effect_id) = 0;

    virtual int resumeEffect(uint32_t effect_id) = 0;

    virtual int pauseAllEffects() = 0;

    virtual int resumeAllEffects() = 0;

    virtual int setEffectSendVolume(uint32_t effect_id, uint32_t volume) = 0;
    virtual int getEffectSendVolume(uint32_t effect_id, uint32_t *volume) = 0;

    virtual int setEffectPlaybackVolume(uint32_t effect_id, uint32_t volume) = 0;

    virtual int getEffectPlaybackVolume(uint32_t effect_id, uint32_t *volume) = 0;

    virtual int startSystemAudioLoopbackCapture() = 0;

    virtual int stopSystemAudioLoopbackCapture() = 0;

    virtual int setSystemAudioLoopbackCaptureVolume(uint32_t volume) = 0;

    virtual int enableEarback(bool enabled, uint32_t volume) = 0;

    virtual int setEarbackVolume(uint32_t volume) = 0;

    virtual int setStatsObserver(IRtcMediaStatsObserver *observer) = 0;

    virtual int enableAudioVolumeIndication(bool enable, uint64_t interval) = 0;

    virtual int startScreenCaptureByScreenRect(const NERtcRectangle& screen_rect, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;

    virtual int startScreenCaptureByDisplayId(unsigned int display_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;

    virtual int startScreenCaptureByWindowId(void *window_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;

    virtual int updateScreenCaptureRegion(const NERtcRectangle& region_rect) = 0;

    virtual int stopScreenCapture() = 0;

    virtual int pauseScreenCapture() = 0;

    virtual int resumeScreenCapture() = 0;


    virtual int setExternalVideoSource(bool enabled) = 0;

    virtual int pushExternalVideoFrame(NERtcVideoFrame* frame) = 0;


    virtual int setExternalAudioSource(bool enabled, int sample_rate, int channels) = 0;

    virtual int pushExternalAudioFrame(NERtcAudioFrame* frame) = 0;

    virtual int setExternalAudioRender(bool enabled, int sample_rate, int channels) = 0;

    virtual int pullExternalAudioFrame(void* data, int len) = 0;

    virtual const char* getVersion(int* build) = 0;

    virtual const char* getErrorDescription(int error_code) = 0;

    virtual void uploadSdkInfo() = 0;

    virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;

    virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;

    virtual int removeLiveStreamTask(const char* task_id) = 0;

    virtual int sendSEIMsg(const char* data, int length, NERtcStreamChannelType type) = 0;

    virtual int sendSEIMsg(const char* data, int length) = 0;
};

} //namespace nertc

#endif