Agora Java API Reference for Android
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 
99  unsigned int gopInMs;
100 
105  ORIENTATION_MODE orientationMode;
106 
108  bitrate(800), maxBitrate(960), minBitrate(600), gopInMs(2000),
109  orientationMode(ORIENTATION_MODE_ADAPTIVE) {}
110 };
111 
112 
116 enum RTMP_CONNECTION_ERROR {
120  RTMP_CONNECTION_ERR_OK = 0,
121 
125  RTMP_CONNECTION_ERR_FAILED = 1,
126 
130  RTMP_CONNECTION_ERR_INVALID_URL = 2,
131 
135  RTMP_CONNECTION_ERR_BAD_NAME = 3,
136 };
137 
141 enum RTMP_CONNECTION_STATE {
153  STATE_DISCONNECTED = 1,
154 
166  STATE_CONNECTING = 2,
167 
178  STATE_CONNECTED = 3,
179 
188  STATE_RECONNECTING = 4,
189 
197  STATE_FAILED = 5,
198 
207  STATE_RECONNECTED = 6
208 };
209 
216  bool enableWriteFlvFile;
217  RtmpConnectionConfiguration() : enableWriteFlvFile(false) {}
218 };
219 
227  RTMP_CONNECTION_STATE state;
228 
229  RtmpConnectionInfo() : state(STATE_DISCONNECTED) {}
230 };
231 
232 
237  public:
243  virtual void onConnected(const RtmpConnectionInfo& connectionInfo) = 0;
244 
250  virtual void onDisconnected(const RtmpConnectionInfo& connectionInfo) = 0;
251 
257  virtual void onReconnecting(const RtmpConnectionInfo& connectionInfo) = 0;
258 
264  virtual void onReconnected(const RtmpConnectionInfo& connectionInfo) = 0;
265 
272  virtual void onConnectionFailure(const RtmpConnectionInfo& connectionInfo,
273  RTMP_CONNECTION_ERROR errCode) = 0;
274 
282  virtual void onTransferStatistics(uint64_t video_bitrate, uint64_t audio_bitrate, uint64_t video_frame_rate, uint64_t push_video_frame_cnt, uint64_t pop_video_frame_cnt) = 0;
283 
284  virtual ~IRtmpConnectionObserver() {}
285 };
286 
298  public:
299  ~IRtmpConnection() {};
300 
320  virtual int connect(const char* url) = 0;
321 
329  virtual int disconnect() = 0;
330 
339 
348 
357  virtual int registerObserver(IRtmpConnectionObserver* observer, void(*safeDeleter)(IRtmpConnectionObserver*) = NULL) = 0;
358 
368  virtual int unregisterObserver(IRtmpConnectionObserver* observer) = 0;
369 };
370 
371 } // namespace rtc
372 } // namespace agora
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::IRtmpConnection::registerObserver
virtual int registerObserver(IRtmpConnectionObserver *observer, void(*safeDeleter)(IRtmpConnectionObserver *)=NULL)=0
agora::rtc::RtmpStreamingVideoConfiguration::height
int height
Definition: NGIAgoraRtmpConnection.h:69
agora::rtc::IRtmpConnectionObserver::onReconnected
virtual void onReconnected(const RtmpConnectionInfo &connectionInfo)=0
agora::rtc::RtmpStreamingVideoConfiguration::orientationMode
ORIENTATION_MODE orientationMode
Definition: NGIAgoraRtmpConnection.h:105
agora::rtc::IRtmpConnection
Definition: NGIAgoraRtmpConnection.h:297
agora::rtc::IRtmpConnectionObserver::onReconnecting
virtual void onReconnecting(const RtmpConnectionInfo &connectionInfo)=0
agora::rtc::RtmpConnectionConfiguration
Definition: NGIAgoraRtmpConnection.h:213
agora::rtc::RtmpConnectionInfo
Definition: NGIAgoraRtmpConnection.h:223
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::RtmpStreamingAudioConfiguration
Definition: NGIAgoraRtmpConnection.h:21
agora::rtc::IRtmpConnectionObserver::onConnected
virtual void onConnected(const RtmpConnectionInfo &connectionInfo)=0
agora::rtc::RtmpStreamingAudioConfiguration::numberOfChannels
int numberOfChannels
Definition: NGIAgoraRtmpConnection.h:35
agora::rtc::RtmpConnectionInfo::state
RTMP_CONNECTION_STATE state
Definition: NGIAgoraRtmpConnection.h:227
agora::rtc::IRtmpConnection::disconnect
virtual int disconnect()=0
agora::rtc::RtmpStreamingVideoConfiguration::gopInMs
unsigned int gopInMs
Definition: NGIAgoraRtmpConnection.h:99
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::IRtmpConnectionObserver::onTransferStatistics
virtual void onTransferStatistics(uint64_t video_bitrate, uint64_t audio_bitrate, uint64_t video_frame_rate, uint64_t push_video_frame_cnt, uint64_t pop_video_frame_cnt)=0
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::RtmpStreamingVideoConfiguration::framerate
int framerate
Definition: NGIAgoraRtmpConnection.h:75
agora::rtc::RtmpStreamingAudioConfiguration::bitrate
int bitrate
Definition: NGIAgoraRtmpConnection.h:41
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:236