Agora C++ API Reference for All Platforms
local_user_i.h
1 //
2 // Agora Media SDK
3 //
4 // Created by Sting Feng in 2015-05.
5 // Copyright (c) 2015 Agora IO. All rights reserved.
6 //
7 #pragma once
8 
9 #include <string>
10 #include <vector>
11 
12 #include "IAgoraService.h"
13 #include "NGIAgoraLocalUser.h"
14 #include "api2/NGIAgoraRtcConnection.h"
15 
16 #include "channel_capability_i.h"
17 #include "audio_options_i.h"
18 
19 namespace agora {
20 namespace rtc {
21 
22 struct TConnectionInfo;
23 
24 struct audio_packet_t;
25 struct SAudioFrame;
26 struct video_packet_t;
27 struct control_broadcast_packet_t;
28 struct CallBillInfo;
29 class IMetadataObserver;
30 
32  public:
34  virtual int onAudioPacket(const agora::rtc::TConnectionInfo& connectionInfo,
35  const audio_packet_t& p) = 0;
36  virtual int onVideoPacket(const agora::rtc::TConnectionInfo& connectionInfo,
37  const video_packet_t& p) = 0;
38  virtual int onControlBroadcastPacket(const agora::rtc::TConnectionInfo& connectionInfo,
40  virtual int onDataStreamPacket(const agora::rtc::TConnectionInfo& connectionInfo,
41  uint16_t streamId, const char* data,
42  size_t length) = 0;
43 };
44 
45 // Audio frame dump position for sending.
46 extern const std::string AUDIO_PIPELINE_POS_RECORD_ORIGIN;
47 extern const std::string AUDIO_PIPELINE_POS_PRE_APM_PROC;
48 extern const std::string AUDIO_PIPELINE_POS_APM;
49 extern const std::string AUDIO_PIPELINE_POS_PRE_SEND_PROC;
50 extern const std::string AUDIO_PIPELINE_POS_FILTER;
51 extern const std::string AUDIO_PIPELINE_POS_ENC;
52 extern const std::string AUDIO_PIPELINE_POS_TX_MIXER;
53 extern const std::string AUDIO_PIPELINE_POS_AT_RECORD;
54 extern const std::string AUDIO_PIPELINE_POS_ATW_RECORD;
55 
56 // Audio frame dump position for receiving.
57 extern const std::string AUDIO_PIPELINE_POS_DEC;
58 extern const std::string AUDIO_PIPELINE_POS_MIXED;
59 extern const std::string AUDIO_PIPELINE_POS_PLAY;
60 extern const std::string AUDIO_PIPELINE_POS_RX_MIXER;
61 extern const std::string AUDIO_PIPELINE_POS_PLAYBACK_MIXER;
62 extern const std::string AUDIO_PIPELINE_POS_PCM_SOURCE_PLAYBAC_MIXER;
63 extern const std::string AUDIO_PIPELINE_POS_PRE_PLAY_PROC;
64 extern const std::string AUDIO_PIPELINE_POS_AT_PLAYOUT;
65 extern const std::string AUDIO_PIPELINE_POS_ATW_PLAYOUT;
66 
68 const int64_t AUDIO_FRAME_DUMP_MAX_DURATION_MS = 150000;
69 
71 public:
72  virtual ~IAudioFrameDumpObserver() = default;
73  virtual void OnAudioFrameDumpCompleted(const std::string& location, const std::string& uuid,
74  const std::vector<std::string>& files) = 0;
75 };
76 
77 class ILocalUserEx : public rtc::ILocalUser {
78  public:
79  virtual int initialize() = 0;
80  // We should deprecate sendAudioPacket.
81  virtual int sendAudioPacket(const audio_packet_t& packet, int delay = 0) = 0;
82 
83  virtual int sendAudioFrame(const SAudioFrame& frame, int delay = 0) = 0;
84  virtual int sendVideoPacket(const video_packet_t& packet) = 0;
86 
87  virtual int sendDataStreamPacket(uint16_t streamId, const char* data, size_t length) = 0;
88 
89  // No-thread safe, it must be called before joinChannel().
90  // No unregister method provided to simplify internal logic.
92 
93  // internal usage
94  virtual int setAudioOptions(const rtc::AudioOptions& options) = 0;
95  virtual int getAudioOptions(rtc::AudioOptions* options) = 0;
96  virtual int setAdvancedAudioOptions(const rtc::AudioOptions& options, int sourceType) = 0;
97  virtual int getAecDelay(int sourceType, int* aecDelay) = 0;
98  virtual void getBillInfo(CallBillInfo* bill_info) = 0;
99 
100  virtual void forceDisableChannelCapability(capability::CapabilityType, uint8_t capability) = 0;
101  virtual void forceDeviceScore(const int32_t deviceScore) = 0;
102  virtual int setPrerendererSmoothing(bool enabled) = 0;
103  virtual int setDtx(bool enabled) = 0;
104  virtual int setCustomAudioBitrate(int bitrate) = 0;
105  virtual int setAudioFrameSizeMs(int sizeMs) = 0;
106  virtual int setAudioCC(bool value) = 0;
107 
110 
111  virtual int startAudioFrameDump(const std::string& location, const std::string& uuid,
112  const std::string& passwd, int64_t duration_ms,
113  bool auto_upload) = 0;
114  virtual int stopAudioFrameDump(const std::string& location) = 0;
115 
116  virtual int setPlayoutUserAnonymous(rtc::uid_t uid, bool anonymous) = 0;
117  virtual int enableAudioPlayout(bool enabled) = 0;
118 
121 
123 
124  virtual int setAVSyncPeer(rtc::uid_t uid) = 0;
125  virtual int getOnlySubscribeEncodedVideoFrame(user_id_t peerUid, bool& subscribe) = 0;
126  virtual void setMinPlayoutDelay(int delay) = 0;
127  virtual int setAllowSubscribeSelf(bool allow) = 0;
128  virtual int adjustRecordingSignalVolume(int volume) = 0;
129  virtual int getRecordingSignalVolume(int* volume) = 0;
130  virtual bool ForcePeriodicKeyFrame() = 0;
131 };
132 
133 } // namespace rtc
134 } // namespace agora
agora::rtc::ILocalUserEx::getRecordingSignalVolume
virtual int getRecordingSignalVolume(int *volume)=0
agora::rtc::AUDIO_PIPELINE_POS_MIXED
const std::string AUDIO_PIPELINE_POS_MIXED
agora::rtc::ILocalUserEx::enableAudioPlayout
virtual int enableAudioPlayout(bool enabled)=0
agora::rtc::AUDIO_PIPELINE_POS_PLAY
const std::string AUDIO_PIPELINE_POS_PLAY
agora::rtc::AudioOptions
Definition: audio_options_i.h:46
agora::rtc::AUDIO_PIPELINE_POS_DEC
const std::string AUDIO_PIPELINE_POS_DEC
agora::rtc::AUDIO_PIPELINE_POS_PRE_SEND_PROC
const std::string AUDIO_PIPELINE_POS_PRE_SEND_PROC
agora::rtc::AUDIO_PIPELINE_POS_FILTER
const std::string AUDIO_PIPELINE_POS_FILTER
agora::rtc::IAudioFrameDumpObserver
Definition: local_user_i.h:70
agora::rtc::ILocalUserEx::setAudioFrameSizeMs
virtual int setAudioFrameSizeMs(int sizeMs)=0
agora::rtc::ILocalUserEx::setDtx
virtual int setDtx(bool enabled)=0
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::ILocalUserEx::registerAudioFrameDumpObserver
virtual int registerAudioFrameDumpObserver(IAudioFrameDumpObserver *observer)=0
agora::rtc::AUDIO_PIPELINE_POS_ATW_RECORD
const std::string AUDIO_PIPELINE_POS_ATW_RECORD
agora::rtc::ILocalUserEx::setPlayoutUserAnonymous
virtual int setPlayoutUserAnonymous(rtc::uid_t uid, bool anonymous)=0
agora::rtc::ILocalUserEx::setCustomAudioBitrate
virtual int setCustomAudioBitrate(int bitrate)=0
agora::rtc::ITransportPacketObserver::onAudioPacket
virtual int onAudioPacket(const agora::rtc::TConnectionInfo &connectionInfo, const audio_packet_t &p)=0
agora::rtc::ILocalUserEx::getAudioOptions
virtual int getAudioOptions(rtc::AudioOptions *options)=0
agora::rtc::ILocalUserEx::registerVideoMetadataObserver
virtual void registerVideoMetadataObserver(IMetadataObserver *observer)=0
agora::rtc::AUDIO_PIPELINE_POS_RECORD_ORIGIN
const std::string AUDIO_PIPELINE_POS_RECORD_ORIGIN
agora::rtc::ILocalUserEx::sendAudioFrame
virtual int sendAudioFrame(const SAudioFrame &frame, int delay=0)=0
agora::rtc::AUDIO_PIPELINE_POS_PCM_SOURCE_PLAYBAC_MIXER
const std::string AUDIO_PIPELINE_POS_PCM_SOURCE_PLAYBAC_MIXER
agora::user_id_t
const char * user_id_t
Definition: AgoraBase.h:782
agora::rtc::ILocalUserEx::forceDisableChannelCapability
virtual void forceDisableChannelCapability(capability::CapabilityType, uint8_t capability)=0
agora::capability::CapabilityType
CapabilityType
Definition: channel_capability_i.h:113
agora::rtc::ILocalUserEx::getOnlySubscribeEncodedVideoFrame
virtual int getOnlySubscribeEncodedVideoFrame(user_id_t peerUid, bool &subscribe)=0
agora::rtc::AUDIO_PIPELINE_POS_ENC
const std::string AUDIO_PIPELINE_POS_ENC
agora::rtc::ILocalUserEx::setPrerendererSmoothing
virtual int setPrerendererSmoothing(bool enabled)=0
agora::rtc::IMetadataObserver
Definition: IAgoraRtcEngine.h:2646
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::ITransportPacketObserver::onDataStreamPacket
virtual int onDataStreamPacket(const agora::rtc::TConnectionInfo &connectionInfo, uint16_t streamId, const char *data, size_t length)=0
agora::rtc::ILocalUserEx::initialize
virtual int initialize()=0
agora::rtc::ILocalUserEx::setAudioOptions
virtual int setAudioOptions(const rtc::AudioOptions &options)=0
agora::rtc::AUDIO_PIPELINE_POS_AT_RECORD
const std::string AUDIO_PIPELINE_POS_AT_RECORD
agora::rtc::AUDIO_FRAME_DUMP_MIN_DURATION_MS
const int64_t AUDIO_FRAME_DUMP_MIN_DURATION_MS
Definition: local_user_i.h:67
agora::rtc::ILocalUserEx::sendDataStreamPacket
virtual int sendDataStreamPacket(uint16_t streamId, const char *data, size_t length)=0
agora::rtc::ILocalUserEx::ForcePeriodicKeyFrame
virtual bool ForcePeriodicKeyFrame()=0
agora::rtc::TConnectionInfo
Definition: NGIAgoraRtcConnection.h:25
agora::rtc::IAudioFrameDumpObserver::~IAudioFrameDumpObserver
virtual ~IAudioFrameDumpObserver()=default
agora::rtc::ILocalUserEx::adjustRecordingSignalVolume
virtual int adjustRecordingSignalVolume(int volume)=0
agora::rtc::AUDIO_PIPELINE_POS_RX_MIXER
const std::string AUDIO_PIPELINE_POS_RX_MIXER
agora::rtc::AUDIO_FRAME_DUMP_MAX_DURATION_MS
const int64_t AUDIO_FRAME_DUMP_MAX_DURATION_MS
Definition: local_user_i.h:68
agora::rtc::video_packet_t
Definition: packet_i.h:135
agora::rtc::ILocalUserEx::getBillInfo
virtual void getBillInfo(CallBillInfo *bill_info)=0
agora::rtc::ILocalUserEx::setMinPlayoutDelay
virtual void setMinPlayoutDelay(int delay)=0
agora::rtc::ILocalUserEx::forceDeviceScore
virtual void forceDeviceScore(const int32_t deviceScore)=0
agora::rtc::SAudioFrame
Definition: packet_i.h:49
agora::rtc::ITransportPacketObserver
Definition: local_user_i.h:31
agora::rtc::ILocalUser
Definition: NGIAgoraLocalUser.h:51
agora::rtc::ILocalUserEx
Definition: local_user_i.h:77
agora::rtc::AUDIO_PIPELINE_POS_TX_MIXER
const std::string AUDIO_PIPELINE_POS_TX_MIXER
agora::rtc::audio_packet_t
Definition: packet_i.h:125
agora::rtc::ILocalUserEx::sendControlBroadcastPacket
virtual int sendControlBroadcastPacket(control_broadcast_packet_t &packet)=0
agora::rtc::ILocalUserEx::setAdvancedAudioOptions
virtual int setAdvancedAudioOptions(const rtc::AudioOptions &options, int sourceType)=0
agora::rtc::control_broadcast_packet_t
Definition: packet_i.h:245
agora::rtc::ILocalUserEx::getRemoteVideoTrack
virtual agora_refptr< IRemoteVideoTrack > getRemoteVideoTrack(rtc::uid_t uid)=0
agora::rtc::AUDIO_PIPELINE_POS_ATW_PLAYOUT
const std::string AUDIO_PIPELINE_POS_ATW_PLAYOUT
agora::rtc::ILocalUserEx::startAudioFrameDump
virtual int startAudioFrameDump(const std::string &location, const std::string &uuid, const std::string &passwd, int64_t duration_ms, bool auto_upload)=0
agora::rtc::ILocalUserEx::registerTransportPacketObserver
virtual int registerTransportPacketObserver(ITransportPacketObserver *observer)=0
agora::rtc::ITransportPacketObserver::onControlBroadcastPacket
virtual int onControlBroadcastPacket(const agora::rtc::TConnectionInfo &connectionInfo, control_broadcast_packet_t &p)=0
agora::rtc::ITransportPacketObserver::onVideoPacket
virtual int onVideoPacket(const agora::rtc::TConnectionInfo &connectionInfo, const video_packet_t &p)=0
agora::rtc::AUDIO_PIPELINE_POS_PRE_PLAY_PROC
const std::string AUDIO_PIPELINE_POS_PRE_PLAY_PROC
agora::rtc::AUDIO_PIPELINE_POS_APM
const std::string AUDIO_PIPELINE_POS_APM
agora::rtc::AUDIO_PIPELINE_POS_AT_PLAYOUT
const std::string AUDIO_PIPELINE_POS_AT_PLAYOUT
agora::rtc::ILocalUserEx::sendVideoPacket
virtual int sendVideoPacket(const video_packet_t &packet)=0
agora::rtc::ILocalUserEx::setAVSyncPeer
virtual int setAVSyncPeer(rtc::uid_t uid)=0
agora::rtc::ILocalUserEx::getAecDelay
virtual int getAecDelay(int sourceType, int *aecDelay)=0
agora::rtc::AUDIO_PIPELINE_POS_PLAYBACK_MIXER
const std::string AUDIO_PIPELINE_POS_PLAYBACK_MIXER
agora::rtc::ILocalUserEx::unregisterVideoMetadataObserver
virtual void unregisterVideoMetadataObserver(IMetadataObserver *observer)=0
agora::rtc::ILocalUserEx::setAudioCC
virtual int setAudioCC(bool value)=0
agora::rtc::ILocalUserEx::unregisterAudioFrameDumpObserver
virtual int unregisterAudioFrameDumpObserver(IAudioFrameDumpObserver *observer)=0
agora::rtc::uid_t
unsigned int uid_t
Definition: AgoraMediaBase.h:29
agora::rtc::IAudioFrameDumpObserver::OnAudioFrameDumpCompleted
virtual void OnAudioFrameDumpCompleted(const std::string &location, const std::string &uuid, const std::vector< std::string > &files)=0
agora::rtc::ITransportPacketObserver::~ITransportPacketObserver
virtual ~ITransportPacketObserver()
Definition: local_user_i.h:33
agora::rtc::AUDIO_PIPELINE_POS_PRE_APM_PROC
const std::string AUDIO_PIPELINE_POS_PRE_APM_PROC
agora::rtc::ILocalUserEx::sendAudioPacket
virtual int sendAudioPacket(const audio_packet_t &packet, int delay=0)=0
agora::rtc::ILocalUserEx::setAllowSubscribeSelf
virtual int setAllowSubscribeSelf(bool allow)=0
agora::rtc::ILocalUserEx::stopAudioFrameDump
virtual int stopAudioFrameDump(const std::string &location)=0
rtc
Definition: video_node_i.h:25