Agora C++ API Reference for All Platforms
NGIAgoraRtmpConnection.h
1 //
2 // Agora RTMP connection
3 //
4 // Created by Haonong Yu in 2020-02.
5 // Copyright (c) 2020 Agora.io. All rights reserved.
6 //
7 
8 #pragma once // NOLINT(build/header_guard)
9 
10 #include "AgoraBase.h"
11 #include "AgoraRefPtr.h"
12 
13 namespace agora {
14 namespace rtc {
15 
16 class IRtmpLocalUser;
17 
26 
31 
36 
41  int bitrate;
42 
44  numberOfChannels(1), bitrate(48000) {}
45 };
46 
59  int width;
60 
69  int height;
70 
75  int framerate;
76 
81  int bitrate;
82 
88 
94 
100 
102  bitrate(800), maxBitrate(960), minBitrate(600),
104 };
105 
106 
115 
120 
125 };
126 
143 
156 
168 
178 
186  STATE_FAILED = 5
187 };
188 
197 };
198 
207 
209 };
210 
211 
216  public:
222  virtual void onConnected(const RtmpConnectionInfo& connectionInfo) = 0;
223 
229  virtual void onDisconnected(const RtmpConnectionInfo& connectionInfo) = 0;
230 
236  virtual void onReconnecting(const RtmpConnectionInfo& connectionInfo) = 0;
237 
244  virtual void onConnectionFailure(const RtmpConnectionInfo& connectionInfo,
245  RTMP_CONNECTION_ERROR errCode) = 0;
246 
254  virtual void onTransferStatistics(uint64_t video_bitrate, uint64_t audio_bitrate, uint64_t video_frame_rate) = 0;
255 
257 };
258 
270  public:
272 
292  virtual int connect(const char* url) = 0;
293 
301  virtual int disconnect() = 0;
302 
311 
320 
329  virtual int registerObserver(IRtmpConnectionObserver* observer, void(*safeDeleter)(IRtmpConnectionObserver*) = NULL) = 0;
330 
340  virtual int unregisterObserver(IRtmpConnectionObserver* observer) = 0;
341 };
342 
343 } // namespace rtc
344 } // namespace agora
agora::rtc::STATE_RECONNECTING
@ STATE_RECONNECTING
Definition: NGIAgoraRtmpConnection.h:177
agora::rtc::IRtmpConnection::unregisterObserver
virtual int unregisterObserver(IRtmpConnectionObserver *observer)=0
agora::rtc::RtmpStreamingAudioConfiguration::bytesPerSample
int bytesPerSample
Definition: NGIAgoraRtmpConnection.h:30
agora::rtc::IRtmpConnection::getRtmpLocalUser
virtual IRtmpLocalUser * getRtmpLocalUser()=0
agora::rtc::RTMP_CONNECTION_ERR_INVALID_URL
@ RTMP_CONNECTION_ERR_INVALID_URL
Definition: NGIAgoraRtmpConnection.h:124
agora::rtc::IRtmpConnection::registerObserver
virtual int registerObserver(IRtmpConnectionObserver *observer, void(*safeDeleter)(IRtmpConnectionObserver *)=NULL)=0
agora::rtc::ORIENTATION_MODE
ORIENTATION_MODE
Definition: AgoraBase.h:1334
agora::rtc::RtmpStreamingVideoConfiguration::height
int height
Definition: NGIAgoraRtmpConnection.h:69
agora::rtc::STATE_FAILED
@ STATE_FAILED
Definition: NGIAgoraRtmpConnection.h:186
agora::rtc::IRtmpConnection::~IRtmpConnection
~IRtmpConnection()
Definition: NGIAgoraRtmpConnection.h:271
agora::rtc::RtmpConnectionInfo::RtmpConnectionInfo
RtmpConnectionInfo()
Definition: NGIAgoraRtmpConnection.h:208
agora::rtc::RtmpStreamingVideoConfiguration::orientationMode
ORIENTATION_MODE orientationMode
Definition: NGIAgoraRtmpConnection.h:99
agora::rtc::RtmpConnectionConfiguration::videoConfig
RtmpStreamingVideoConfiguration videoConfig
Definition: NGIAgoraRtmpConnection.h:194
agora::rtc::IRtmpConnection
Definition: NGIAgoraRtmpConnection.h:269
agora::rtc::IRtmpConnectionObserver::onReconnecting
virtual void onReconnecting(const RtmpConnectionInfo &connectionInfo)=0
agora::rtc::RtmpConnectionConfiguration
Definition: NGIAgoraRtmpConnection.h:192
agora::rtc::RtmpConnectionInfo
Definition: NGIAgoraRtmpConnection.h:202
agora::rtc::RTMP_CONNECTION_ERR_OK
@ RTMP_CONNECTION_ERR_OK
Definition: NGIAgoraRtmpConnection.h:114
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::RTMP_CONNECTION_STATE
RTMP_CONNECTION_STATE
Definition: NGIAgoraRtmpConnection.h:130
agora::rtc::RtmpStreamingVideoConfiguration::minBitrate
int minBitrate
Definition: NGIAgoraRtmpConnection.h:93
agora::rtc::RtmpStreamingVideoConfiguration::width
int width
Definition: NGIAgoraRtmpConnection.h:59
agora::rtc::RtmpStreamingVideoConfiguration
Definition: NGIAgoraRtmpConnection.h:50
agora::rtc::RtmpStreamingAudioConfiguration::sampleRateHz
int sampleRateHz
Definition: NGIAgoraRtmpConnection.h:25
agora::rtc::IRtmpConnectionObserver::onDisconnected
virtual void onDisconnected(const RtmpConnectionInfo &connectionInfo)=0
agora::rtc::IRtmpConnectionObserver::onTransferStatistics
virtual void onTransferStatistics(uint64_t video_bitrate, uint64_t audio_bitrate, uint64_t video_frame_rate)=0
agora::rtc::RtmpStreamingAudioConfiguration::RtmpStreamingAudioConfiguration
RtmpStreamingAudioConfiguration()
Definition: NGIAgoraRtmpConnection.h:43
agora::rtc::RtmpStreamingVideoConfiguration::RtmpStreamingVideoConfiguration
RtmpStreamingVideoConfiguration()
Definition: NGIAgoraRtmpConnection.h:101
agora::rtc::RtmpStreamingAudioConfiguration
Definition: NGIAgoraRtmpConnection.h:21
agora::rtc::IRtmpConnectionObserver::onConnected
virtual void onConnected(const RtmpConnectionInfo &connectionInfo)=0
agora::rtc::ORIENTATION_MODE_ADAPTIVE
@ ORIENTATION_MODE_ADAPTIVE
Definition: AgoraBase.h:1342
agora::rtc::STATE_CONNECTING
@ STATE_CONNECTING
Definition: NGIAgoraRtmpConnection.h:155
agora::rtc::RtmpStreamingAudioConfiguration::numberOfChannels
int numberOfChannels
Definition: NGIAgoraRtmpConnection.h:35
agora::rtc::RtmpConnectionInfo::state
RTMP_CONNECTION_STATE state
Definition: NGIAgoraRtmpConnection.h:206
agora::rtc::IRtmpConnection::disconnect
virtual int disconnect()=0
agora::rtc::RtmpConnectionConfiguration::enableWriteFlvFile
bool enableWriteFlvFile
Definition: NGIAgoraRtmpConnection.h:195
agora::rtc::RtmpConnectionConfiguration::RtmpConnectionConfiguration
RtmpConnectionConfiguration()
Definition: NGIAgoraRtmpConnection.h:196
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::STATE_CONNECTED
@ STATE_CONNECTED
Definition: NGIAgoraRtmpConnection.h:167
agora::rtc::RTMP_CONNECTION_ERR_FAILED
@ RTMP_CONNECTION_ERR_FAILED
Definition: NGIAgoraRtmpConnection.h:119
agora::rtc::IRtmpConnection::connect
virtual int connect(const char *url)=0
agora::rtc::IRtmpConnection::getConnectionInfo
virtual RtmpConnectionInfo getConnectionInfo()=0
agora::rtc::IRtmpLocalUser
Definition: NGIAgoraRtmpLocalUser.h:97
agora::rtc::STATE_DISCONNECTED
@ STATE_DISCONNECTED
Definition: NGIAgoraRtmpConnection.h:142
agora::rtc::RtmpStreamingVideoConfiguration::framerate
int framerate
Definition: NGIAgoraRtmpConnection.h:75
agora::rtc::RtmpStreamingAudioConfiguration::bitrate
int bitrate
Definition: NGIAgoraRtmpConnection.h:41
agora::rtc::IRtmpConnectionObserver::~IRtmpConnectionObserver
virtual ~IRtmpConnectionObserver()
Definition: NGIAgoraRtmpConnection.h:256
agora::rtc::RtmpConnectionConfiguration::audioConfig
RtmpStreamingAudioConfiguration audioConfig
Definition: NGIAgoraRtmpConnection.h:193
agora::rtc::RtmpStreamingVideoConfiguration::bitrate
int bitrate
Definition: NGIAgoraRtmpConnection.h:81
agora::rtc::RtmpStreamingVideoConfiguration::maxBitrate
int maxBitrate
Definition: NGIAgoraRtmpConnection.h:87
agora::rtc::IRtmpConnectionObserver::onConnectionFailure
virtual void onConnectionFailure(const RtmpConnectionInfo &connectionInfo, RTMP_CONNECTION_ERROR errCode)=0
agora::rtc::IRtmpConnectionObserver
Definition: NGIAgoraRtmpConnection.h:215
rtc
Definition: video_node_i.h:27
agora::rtc::RTMP_CONNECTION_ERROR
RTMP_CONNECTION_ERROR
Definition: NGIAgoraRtmpConnection.h:110