Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
AgoraMediaBase.h
1// Agora Engine SDK
2//
3// Created by Sting Feng in 2017-11.
4// Copyright (c) 2017 Agora.io. All rights reserved.
5
6#pragma once // NOLINT(build/header_guard)
7
8#include <cstring>
9#include <stdint.h>
10#include <limits>
11#include <stddef.h>
12
13#ifndef OPTIONAL_ENUM_SIZE_T
14#if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
15#define OPTIONAL_ENUM_SIZE_T enum : size_t
16#else
17#define OPTIONAL_ENUM_SIZE_T enum
18#endif
19#endif
20
21#if !defined(__APPLE__)
22#define __deprecated
23#endif
24
25namespace agora {
26namespace rtc {
27
28typedef unsigned int uid_t;
29typedef unsigned int track_id_t;
30typedef unsigned int conn_id_t;
31typedef unsigned int video_track_id_t;
32
33static const unsigned int INVALID_TRACK_ID = 0xffffffff;
34static const unsigned int DEFAULT_CONNECTION_ID = 0;
35static const unsigned int DUMMY_CONNECTION_ID = (std::numeric_limits<unsigned int>::max)();
36
47 bool isValid;
55 const char *providerName;
59 const char *extensionName;
61};
62
63
147
185
239
249
257
276
277} // namespace rtc
278
279namespace media {
345
346namespace base {
347
348typedef void* view_t;
349
350typedef const char* user_id_t;
351
352static const uint8_t kMaxCodecNameLength = 50;
353
362 uint32_t timestamp;
363 // Audio level indication.
366};
367
371
376 uint64_t sendTs;
380 uint8_t codec;
382};
383
392 // Stereo, 32 kHz, 60 ms (2 * 32 * 60)
400 kMaxDataSizeSamples = 3840,
402 kMaxDataSizeBytes = kMaxDataSizeSamples * sizeof(int16_t),
403 };
404
432 int16_t data_[kMaxDataSizeSamples];
433
439
441 if (this == &src) {
442 return *this;
443 }
444
451 this->audio_track_number_ = src.audio_track_number_;
452
453 size_t length = src.samples_per_channel_ * src.num_channels_;
454 if (length > kMaxDataSizeSamples) {
455 length = kMaxDataSizeSamples;
456 }
457
458 memcpy(data_, src.data_, length * sizeof(int16_t));
459
460 return *this;
461 }
462
467 num_channels_(0),
469 bytes_per_sample(rtc::TWO_BYTES_PER_SAMPLE),
470 is_stereo_(false) {
471 memset(data_, 0, sizeof(data_));
472 }
473
482 size_t length = src.samples_per_channel_ * src.num_channels_;
483 if (length > kMaxDataSizeSamples) {
484 length = kMaxDataSizeSamples;
485 }
486
487 memcpy(this->data_, src.data_, length * sizeof(int16_t));
488 }
489};
490
515
552 /*
553 12: pixel format for iOS CVPixelBuffer NV12
554 */
556 /*
557 13: pixel format for iOS CVPixelBuffer I420
558 */
560 /*
561 14: pixel format for iOS CVPixelBuffer BGRA
562 */
583};
584
604 RENDER_MODE_ADAPTIVE __deprecated = 3,
605};
606
624
630 public:
635 virtual const char* getMetaInfoStr(META_INFO_KEY key) const = 0;
636};
637
640 // The indices are equal to the values specified in T-REC H.273 Table 2.
645 PRIMARYID_SMPTE170M = 6, // Identical to BT601
652 PRIMARYID_JEDECP22 = 22, // Identical to EBU3213-E
653 };
654
655 enum RangeID {
656 // The indices are equal to the values specified at
657 // https://www.webmproject.org/docs/container/#colour for the element Range.
659 // Limited Rec. 709 color range with RGB values ranging from 16 to 235.
661 // Full RGB color range with RGB valees from 0 to 255.
663 // Range is defined by MatrixCoefficients/TransferCharacteristics.
665 };
666
684
705
710
714
720};
721
795
821
822
1017
1029 width(0),
1030 height(0),
1031 yStride(0),
1032 uStride(0),
1033 vStride(0),
1034 yBuffer(NULL),
1035 uBuffer(NULL),
1036 vBuffer(NULL),
1037 rotation(0),
1038 renderTimeMs(0),
1039 avsync_type(0),
1040 metadata_buffer(NULL),
1041 metadata_size(0),
1042 sharedContext(0),
1043 textureId(0),
1044 d3d11Texture2d(NULL),
1045 alphaBuffer(NULL),
1047 pixelBuffer(NULL),
1048 metaInfo(NULL){
1049 memset(matrix, 0, sizeof(matrix));
1050 }
1051
1084 uint8_t* yBuffer;
1088 uint8_t* uBuffer;
1092 uint8_t* vBuffer;
1136 float matrix[16];
1146 uint8_t* alphaBuffer;
1160
1165
1171};
1172
1177 public:
1188 virtual void onFrame(const VideoFrame* frame) = 0;
1190 virtual bool isExternal() { return true; }
1218};
1219
1239
1272
1273} // namespace base
1274
1277#define MAX_CONTENT_INSPECT_MODULE_COUNT 32
1283
1309
1335
1345 const char* extraInfo;
1351 const char* serverConfig;
1359 ContentInspectModule modules[MAX_CONTENT_INSPECT_MODULE_COUNT];
1367 extraInfo = rth.extraInfo;
1370 memcpy(&modules, &rth.modules, MAX_CONTENT_INSPECT_MODULE_COUNT * sizeof(ContentInspectModule));
1371 return *this;
1372 }
1374};
1375
1398
1403 public:
1416};
1417
1422 public:
1432 enum { MAX_HANDLE_TIME_CNT = 10 };
1505
1524
1556
1563
1568
1573
1575 : sample_rate(0),
1576 channels(0),
1577 mode(rtc::RAW_AUDIO_FRAME_OP_MODE_READ_ONLY),
1578 samples_per_call(0) {}
1579 AudioParams(int samplerate, int channel, rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE type,
1580 int samplesPerCall)
1581 : sample_rate(samplerate),
1582 channels(channel),
1583 mode(type),
1584 samples_per_call(samplesPerCall) {}
1585 };
1586
1587 public:
1589
1615 virtual bool onRecordAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0;
1641 virtual bool onPlaybackAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0;
1667 virtual bool onMixedAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0;
1693 virtual bool onEarMonitoringAudioFrame(AudioFrame& audioFrame) = 0;
1704 virtual bool onPlaybackAudioFrameBeforeMixing(const char* channelId, base::user_id_t userId,
1705 AudioFrame& audioFrame) {
1706 (void)channelId;
1707 (void)userId;
1708 (void)audioFrame;
1709 return true;
1710 }
1711
1742
1761
1780
1799
1818};
1819
1824 public:
1836 virtual bool onPlaybackAudioFrameBeforeMixing(const char* channelId, rtc::uid_t uid,
1837 AudioFrame& audioFrame) = 0;
1838};
1839
1849 const float* audioSpectrumData;
1854
1856 AudioSpectrumData(const float* data, int length) : audioSpectrumData(data), dataLength(length) {}
1857};
1858
1877
1882 public:
1884
1901 virtual bool onLocalAudioSpectrum(const AudioSpectrumData& data) = 0;
1921 virtual bool onRemoteAudioSpectrum(const UserAudioSpectrumInfo* spectrums,
1922 unsigned int spectrumNumber) = 0;
1923};
1924
1929 public:
1950 const char* channelId, rtc::uid_t uid, const uint8_t* imageBuffer, size_t length,
1951 const rtc::EncodedVideoFrameInfo& videoEncodedFrameInfo) = 0;
1952
1954};
1955
1960 public:
1970 PROCESS_MODE_READ_ONLY, // Observer works as a pure renderer and will not modify the original
1971 // frame.
1976 PROCESS_MODE_READ_WRITE, // Observer works as a filter that will process the video frame and
1977 // affect the following frame processing in SDK.
1978 };
1979
1980 public:
1982
2027 VideoFrame& videoFrame) = 0;
2028
2067 VideoFrame& videoFrame) = 0;
2068
2092 virtual bool onMediaPlayerVideoFrame(VideoFrame& videoFrame, int mediaPlayerId) = 0;
2093
2134 virtual bool onRenderVideoFrame(const char* channelId, rtc::uid_t remoteUid,
2135 VideoFrame& videoFrame) = 0;
2136
2137 virtual bool onTranscodedVideoFrame(VideoFrame& videoFrame) = 0;
2138
2152
2169
2195 virtual bool getRotationApplied() { return false; }
2196
2224 virtual bool getMirrorApplied() { return false; }
2225
2259
2267 virtual bool isExternal() { return true; }
2268};
2269
2283
2295
2314
2333
2361
2376 const char* storagePath;
2414 int fps;
2435
2437 : storagePath(NULL),
2440 maxDurationMs(120000),
2442 width(1280),
2443 height(720),
2444 fps(30),
2445 sample_rate(48000),
2446 channel_num(1),
2447 videoSourceType(rtc::VIDEO_SOURCE_CAMERA_PRIMARY) {}
2449 MediaRecorderStreamType type, int duration, int interval)
2450 : storagePath(path),
2451 containerFormat(format),
2452 streamType(type),
2453 maxDurationMs(duration),
2455 width(1280),
2456 height(720),
2457 fps(30),
2458 sample_rate(48000),
2459 channel_num(1),
2460 videoSourceType(rtc::VIDEO_SOURCE_CAMERA_PRIMARY) {}
2461};
2462
2467 public:
2510 virtual bool onFaceInfo(const char* outFaceInfo) = 0;
2511
2513};
2514
2524 const char* fileName;
2528 unsigned int durationMs;
2532 unsigned int fileSize;
2533
2535 RecorderInfo(const char* name, unsigned int dur, unsigned int size)
2536 : fileName(name), durationMs(dur), fileSize(size) {}
2537};
2538
2543 public:
2559 virtual void onRecorderStateChanged(const char* channelId, rtc::uid_t uid, RecorderState state,
2560 RecorderReasonCode reason) = 0;
2577 virtual void onRecorderInfoUpdated(const char* channelId, rtc::uid_t uid,
2578 const RecorderInfo& info) = 0;
2579
2581};
2582
2583} // namespace media
2584} // namespace agora
Definition AgoraMediaBase.h:1421
virtual int getObservedAudioFramePosition()=0
Sets the frame position for the video observer.
virtual bool onPlaybackAudioFrame(const char *channelId, AudioFrame &audioFrame)=0
Gets the raw audio frame for playback.
virtual ~IAudioFrameObserverBase()
Definition AgoraMediaBase.h:1588
virtual bool onEarMonitoringAudioFrame(AudioFrame &audioFrame)=0
Gets the in-ear monitoring audio frame.
@ MAX_HANDLE_TIME_CNT
Definition AgoraMediaBase.h:1432
AUDIO_FRAME_TYPE
Audio frame type.
Definition AgoraMediaBase.h:1426
@ FRAME_TYPE_PCM16
Definition AgoraMediaBase.h:1430
virtual bool onRecordAudioFrame(const char *channelId, AudioFrame &audioFrame)=0
Gets the captured audio frame.
virtual AudioParams getPlaybackAudioParams()=0
Sets the audio format for the onPlaybackAudioFrame callback.
virtual AudioParams getMixedAudioParams()=0
Sets the audio format for the onMixedAudioFrame callback.
virtual AudioParams getEarMonitoringAudioParams()=0
Sets the audio format for the onEarMonitoringAudioFrame callback.
AUDIO_FRAME_POSITION
Definition AgoraMediaBase.h:1506
@ AUDIO_FRAME_POSITION_BEFORE_MIXING
Definition AgoraMediaBase.h:1519
@ AUDIO_FRAME_POSITION_RECORD
Definition AgoraMediaBase.h:1513
@ AUDIO_FRAME_POSITION_PLAYBACK
Definition AgoraMediaBase.h:1510
@ AUDIO_FRAME_POSITION_MIXED
Definition AgoraMediaBase.h:1516
@ AUDIO_FRAME_POSITION_NONE
Definition AgoraMediaBase.h:1507
@ AUDIO_FRAME_POSITION_EAR_MONITORING
Definition AgoraMediaBase.h:1522
virtual AudioParams getRecordAudioParams()=0
Sets the audio format for the onRecordAudioFrame callback.
virtual bool onMixedAudioFrame(const char *channelId, AudioFrame &audioFrame)=0
Retrieves the mixed captured and playback audio frame.
virtual bool onPlaybackAudioFrameBeforeMixing(const char *channelId, base::user_id_t userId, AudioFrame &audioFrame)
Retrieves the audio frame before mixing of subscribed remote users.
Definition AgoraMediaBase.h:1704
Definition AgoraMediaBase.h:1823
virtual bool onPlaybackAudioFrameBeforeMixing(const char *channelId, rtc::uid_t uid, AudioFrame &audioFrame)=0
Retrieves the audio frame before mixing of subscribed remote users.
Definition AgoraMediaBase.h:1402
virtual ~IAudioPcmFrameSink()
Definition AgoraMediaBase.h:1415
virtual void onFrame(agora::media::base::AudioPcmFrame *frame)=0
Occurs each time the player receives an audio frame.
Definition AgoraMediaBase.h:1881
virtual bool onRemoteAudioSpectrum(const UserAudioSpectrumInfo *spectrums, unsigned int spectrumNumber)=0
Gets the remote audio spectrum.
virtual ~IAudioSpectrumObserver()
Definition AgoraMediaBase.h:1883
virtual bool onLocalAudioSpectrum(const AudioSpectrumData &data)=0
Gets the statistics of a local audio spectrum.
The IFaceInfoObserver class.
Definition AgoraMediaBase.h:2466
virtual ~IFaceInfoObserver()
Definition AgoraMediaBase.h:2512
virtual bool onFaceInfo(const char *outFaceInfo)=0
Occurs when the facial information processed by speech driven extension is received.
The IMediaRecorderObserver class.
Definition AgoraMediaBase.h:2542
virtual void onRecorderStateChanged(const char *channelId, rtc::uid_t uid, RecorderState state, RecorderReasonCode reason)=0
Callback when the recording state changes.
virtual ~IMediaRecorderObserver()
Definition AgoraMediaBase.h:2580
virtual void onRecorderInfoUpdated(const char *channelId, rtc::uid_t uid, const RecorderInfo &info)=0
Callback for recording information updates.
Definition AgoraMediaBase.h:1928
virtual ~IVideoEncodedFrameObserver()
Definition AgoraMediaBase.h:1953
virtual bool onEncodedVideoFrameReceived(const char *channelId, rtc::uid_t uid, const uint8_t *imageBuffer, size_t length, const rtc::EncodedVideoFrameInfo &videoEncodedFrameInfo)=0
Reports that the receiver has received the to-be-decoded video frame sent by the remote end.
The IVideoFrameObserver class.
Definition AgoraMediaBase.h:1959
virtual bool onMediaPlayerVideoFrame(VideoFrame &videoFrame, int mediaPlayerId)=0
virtual bool isExternal()
Definition AgoraMediaBase.h:2267
virtual bool onRenderVideoFrame(const char *channelId, rtc::uid_t remoteUid, VideoFrame &videoFrame)=0
Occurs each time the SDK receives a video frame sent by the remote user.
VIDEO_FRAME_PROCESS_MODE
The process mode of the video frame:
Definition AgoraMediaBase.h:1965
@ PROCESS_MODE_READ_ONLY
Definition AgoraMediaBase.h:1970
@ PROCESS_MODE_READ_WRITE
Definition AgoraMediaBase.h:1976
virtual ~IVideoFrameObserver()
Definition AgoraMediaBase.h:1981
virtual bool onPreEncodeVideoFrame(agora::rtc::VIDEO_SOURCE_TYPE sourceType, VideoFrame &videoFrame)=0
Occurs each time the SDK receives a pre-encoded video frame.
virtual base::VIDEO_PIXEL_FORMAT getVideoFormatPreference()
Definition AgoraMediaBase.h:2168
virtual bool onCaptureVideoFrame(agora::rtc::VIDEO_SOURCE_TYPE sourceType, VideoFrame &videoFrame)=0
Occurs each time the SDK receives a video frame captured by local devices.
virtual uint32_t getObservedFramePosition()
Sets the frame position for the video observer.
Definition AgoraMediaBase.h:2256
virtual bool onTranscodedVideoFrame(VideoFrame &videoFrame)=0
media::base::VideoFrame VideoFrame
Definition AgoraMediaBase.h:1961
virtual VIDEO_FRAME_PROCESS_MODE getVideoFrameProcessMode()
Occurs each time the SDK receives a video frame and prompts you to set the process mode of the video ...
Definition AgoraMediaBase.h:2151
virtual bool getMirrorApplied()
Occurs each time the SDK receives a video frame and prompts you whether or not to mirror the captured...
Definition AgoraMediaBase.h:2224
virtual bool getRotationApplied()
Occurs each time the SDK receives a video frame, and prompts you whether to rotate the captured video...
Definition AgoraMediaBase.h:2195
Definition AgoraMediaBase.h:629
META_INFO_KEY
Definition AgoraMediaBase.h:631
@ KEY_FACE_CAPTURE
Definition AgoraMediaBase.h:632
virtual ~IVideoFrameMetaInfo()
Definition AgoraMediaBase.h:634
virtual const char * getMetaInfoStr(META_INFO_KEY key) const =0
The IVideoFrameObserver class.
Definition AgoraMediaBase.h:1176
virtual ~IVideoFrameObserver()
Definition AgoraMediaBase.h:1189
virtual bool isExternal()
Definition AgoraMediaBase.h:1190
virtual VIDEO_PIXEL_FORMAT getVideoFormatPreference()
Sets the format of the raw video data output by the SDK.
Definition AgoraMediaBase.h:1217
virtual void onFrame(const VideoFrame *frame)=0
Occurs each time the player receives a video frame.
Definition IAgoraService.h:73
Definition NGIAgoraAudioDeviceManager.h:16
CAMERA_VIDEO_SOURCE_TYPE
Definition AgoraMediaBase.h:610
@ CAMERA_SOURCE_BACK
Definition AgoraMediaBase.h:618
@ CAMERA_SOURCE_FRONT
Definition AgoraMediaBase.h:614
@ VIDEO_SOURCE_UNSPECIFIED
Definition AgoraMediaBase.h:622
static const uint8_t kMaxCodecNameLength
Definition AgoraMediaBase.h:352
VIDEO_MODULE_POSITION
The frame position of the video observer.
Definition AgoraMediaBase.h:1243
@ POSITION_PRE_RENDERER
Definition AgoraMediaBase.h:1254
@ POSITION_POST_CAPTURER
Definition AgoraMediaBase.h:1249
@ POSITION_PRE_ENCODER
Definition AgoraMediaBase.h:1264
@ POSITION_POST_CAPTURER_ORIGIN
Definition AgoraMediaBase.h:1270
RENDER_MODE_TYPE
Video display modes.
Definition AgoraMediaBase.h:588
@ RENDER_MODE_HIDDEN
Definition AgoraMediaBase.h:593
@ __deprecated
Definition AgoraMediaBase.h:604
@ RENDER_MODE_FIT
Definition AgoraMediaBase.h:599
AUDIO_DUAL_MONO_MODE
The channel mode.
Definition AgoraMediaBase.h:494
@ AUDIO_DUAL_MONO_MIX
Definition AgoraMediaBase.h:513
@ AUDIO_DUAL_MONO_L
Definition AgoraMediaBase.h:503
@ AUDIO_DUAL_MONO_STEREO
Definition AgoraMediaBase.h:498
@ AUDIO_DUAL_MONO_R
Definition AgoraMediaBase.h:508
const char * user_id_t
Definition AgoraMediaBase.h:350
void * view_t
Definition AgoraMediaBase.h:348
VIDEO_PIXEL_FORMAT
The video pixel format.
Definition AgoraMediaBase.h:519
@ VIDEO_TEXTURE_OES
Definition AgoraMediaBase.h:551
@ VIDEO_PIXEL_I010
Definition AgoraMediaBase.h:582
@ VIDEO_PIXEL_DEFAULT
Definition AgoraMediaBase.h:523
@ VIDEO_CVPIXEL_BGRA
Definition AgoraMediaBase.h:563
@ VIDEO_CVPIXEL_I420
Definition AgoraMediaBase.h:559
@ VIDEO_TEXTURE_2D
Definition AgoraMediaBase.h:547
@ VIDEO_TEXTURE_ID3D11TEXTURE2D
Definition AgoraMediaBase.h:577
@ VIDEO_PIXEL_BGRA
Definition AgoraMediaBase.h:531
@ VIDEO_PIXEL_I420
Definition AgoraMediaBase.h:527
@ VIDEO_PIXEL_NV21
Definition AgoraMediaBase.h:535
@ VIDEO_PIXEL_I422
Definition AgoraMediaBase.h:571
@ VIDEO_CVPIXEL_P010
Definition AgoraMediaBase.h:567
@ VIDEO_CVPIXEL_NV12
Definition AgoraMediaBase.h:555
@ VIDEO_PIXEL_NV12
Definition AgoraMediaBase.h:543
@ VIDEO_PIXEL_RGBA
Definition AgoraMediaBase.h:539
MEDIA_PLAYER_SOURCE_TYPE
Definition AgoraMediaBase.h:1220
@ MEDIA_PLAYER_SOURCE_SIMPLE
Definition AgoraMediaBase.h:1237
@ MEDIA_PLAYER_SOURCE_DEFAULT
Definition AgoraMediaBase.h:1226
@ MEDIA_PLAYER_SOURCE_FULL_FEATURED
Definition AgoraMediaBase.h:1232
ALPHA_STITCH_MODE
The relative position of alphaBuffer and video frames.
Definition AgoraMediaBase.h:799
@ ALPHA_STITCH_BELOW
Definition AgoraMediaBase.h:811
@ NO_ALPHA_STITCH
Definition AgoraMediaBase.h:803
@ ALPHA_STITCH_UP
Definition AgoraMediaBase.h:807
@ ALPHA_STITCH_LEFT
Definition AgoraMediaBase.h:815
@ ALPHA_STITCH_RIGHT
Definition AgoraMediaBase.h:819
Definition content_inspect_i.h:15
CONTENT_INSPECT_TYPE
The type of video content moderation module.
Definition AgoraMediaBase.h:1287
@ CONTENT_INSPECT_IMAGE_MODERATION
Definition AgoraMediaBase.h:1307
@ __deprecated
Definition AgoraMediaBase.h:1296
@ CONTENT_INSPECT_SUPERVISION
Definition AgoraMediaBase.h:1301
@ CONTENT_INSPECT_INVALID
Definition AgoraMediaBase.h:1291
MEDIA_SOURCE_TYPE
Media source type.
Definition AgoraMediaBase.h:283
@ SPEECH_DRIVEN_VIDEO_SOURCE
Definition AgoraMediaBase.h:339
@ PRIMARY_SCREEN_SOURCE
Definition AgoraMediaBase.h:303
@ AUDIO_RECORDING_SOURCE
Definition AgoraMediaBase.h:291
@ RTC_IMAGE_JPEG_SOURCE
Definition AgoraMediaBase.h:323
@ REMOTE_VIDEO_SOURCE
Definition AgoraMediaBase.h:331
@ RTC_IMAGE_PNG_SOURCE
Definition AgoraMediaBase.h:319
@ SECONDARY_CAMERA_SOURCE
Definition AgoraMediaBase.h:299
@ CUSTOM_VIDEO_SOURCE
Definition AgoraMediaBase.h:311
@ PRIMARY_CAMERA_SOURCE
Definition AgoraMediaBase.h:295
@ TRANSCODED_VIDEO_SOURCE
Definition AgoraMediaBase.h:335
@ MEDIA_PLAYER_SOURCE
Definition AgoraMediaBase.h:315
@ RTC_IMAGE_GIF_SOURCE
Definition AgoraMediaBase.h:327
@ AUDIO_PLAYOUT_SOURCE
Definition AgoraMediaBase.h:287
@ SECONDARY_SCREEN_SOURCE
Definition AgoraMediaBase.h:307
@ UNKNOWN_MEDIA_SOURCE
Definition AgoraMediaBase.h:343
CONTENT_INSPECT_RESULT
Definition AgoraMediaBase.h:1278
@ CONTENT_INSPECT_NEUTRAL
Definition AgoraMediaBase.h:1279
@ CONTENT_INSPECT_SEXY
Definition AgoraMediaBase.h:1280
@ CONTENT_INSPECT_PORN
Definition AgoraMediaBase.h:1281
MediaRecorderStreamType
The recording content.
Definition AgoraMediaBase.h:2300
@ STREAM_TYPE_AUDIO
Definition AgoraMediaBase.h:2304
@ STREAM_TYPE_VIDEO
Definition AgoraMediaBase.h:2308
@ STREAM_TYPE_BOTH
Definition AgoraMediaBase.h:2312
RecorderState
The current recording state.
Definition AgoraMediaBase.h:2319
@ RECORDER_STATE_START
Definition AgoraMediaBase.h:2327
@ RECORDER_STATE_ERROR
Definition AgoraMediaBase.h:2323
@ RECORDER_STATE_STOP
Definition AgoraMediaBase.h:2331
MediaRecorderContainerFormat
Format of the recording file.
Definition AgoraMediaBase.h:2289
@ FORMAT_MP4
Definition AgoraMediaBase.h:2293
EXTERNAL_VIDEO_SOURCE_TYPE
The external video frame encoding type.
Definition AgoraMediaBase.h:2273
@ ENCODED_VIDEO_FRAME
Definition AgoraMediaBase.h:2281
@ VIDEO_FRAME
Definition AgoraMediaBase.h:2277
RecorderReasonCode
The reason for the state change.
Definition AgoraMediaBase.h:2338
@ RECORDER_REASON_NO_STREAM
Definition AgoraMediaBase.h:2351
@ RECORDER_REASON_OVER_MAX_DURATION
Definition AgoraMediaBase.h:2355
@ RECORDER_REASON_WRITE_FAILED
Definition AgoraMediaBase.h:2346
@ RECORDER_REASON_NONE
Definition AgoraMediaBase.h:2342
@ RECORDER_REASON_CONFIG_CHANGED
Definition AgoraMediaBase.h:2359
Definition AgoraExtensions.h:5
unsigned int video_track_id_t
Definition AgoraMediaBase.h:31
AUDIO_SOURCE_TYPE
The audio source type.
Definition AgoraMediaBase.h:151
@ AUDIO_SOURCE_UNKNOWN
Definition AgoraMediaBase.h:183
@ AUDIO_SOURCE_REMOTE_CHANNEL
Definition AgoraMediaBase.h:178
@ AUDIO_SOURCE_MICROPHONE
Definition AgoraMediaBase.h:155
@ AUDIO_SOURCE_REMOTE_USER
Definition AgoraMediaBase.h:174
@ AUDIO_SOURCE_LOOPBACK_RECORDING
Definition AgoraMediaBase.h:167
@ AUDIO_SOURCE_MIXED_STREAM
Definition AgoraMediaBase.h:170
@ AUDIO_SOURCE_CUSTOM
Definition AgoraMediaBase.h:159
@ AUDIO_SOURCE_MEDIA_PLAYER
Definition AgoraMediaBase.h:163
unsigned int track_id_t
Definition AgoraMediaBase.h:29
BYTES_PER_SAMPLE
Definition AgoraMediaBase.h:243
@ TWO_BYTES_PER_SAMPLE
Definition AgoraMediaBase.h:247
static const unsigned int INVALID_TRACK_ID
Definition AgoraMediaBase.h:33
unsigned int uid_t
Definition AgoraMediaBase.h:28
unsigned int conn_id_t
Definition AgoraMediaBase.h:30
static const unsigned int DUMMY_CONNECTION_ID
Definition AgoraMediaBase.h:35
VIDEO_SOURCE_TYPE
The type of the video source.
Definition AgoraMediaBase.h:67
@ VIDEO_SOURCE_CAMERA_PRIMARY
Definition AgoraMediaBase.h:71
@ VIDEO_SOURCE_RTC_IMAGE_JPEG
Definition AgoraMediaBase.h:107
@ VIDEO_SOURCE_CUSTOM
Definition AgoraMediaBase.h:95
@ VIDEO_SOURCE_RTC_IMAGE_GIF
Definition AgoraMediaBase.h:111
@ VIDEO_SOURCE_CAMERA_THIRD
Definition AgoraMediaBase.h:124
@ VIDEO_SOURCE_SCREEN_THIRD
Definition AgoraMediaBase.h:132
@ VIDEO_SOURCE_CAMERA
Definition AgoraMediaBase.h:75
@ VIDEO_SOURCE_SCREEN_PRIMARY
Definition AgoraMediaBase.h:83
@ VIDEO_SOURCE_REMOTE
Definition AgoraMediaBase.h:115
@ VIDEO_SOURCE_SCREEN_FOURTH
Definition AgoraMediaBase.h:136
@ VIDEO_SOURCE_CAMERA_FOURTH
Definition AgoraMediaBase.h:128
@ VIDEO_SOURCE_SPEECH_DRIVEN
Definition AgoraMediaBase.h:140
@ VIDEO_SOURCE_CAMERA_SECONDARY
Definition AgoraMediaBase.h:79
@ VIDEO_SOURCE_SCREEN_SECONDARY
Definition AgoraMediaBase.h:91
@ VIDEO_SOURCE_UNKNOWN
Definition AgoraMediaBase.h:145
@ VIDEO_SOURCE_MEDIA_PLAYER
Definition AgoraMediaBase.h:99
@ VIDEO_SOURCE_SCREEN
Definition AgoraMediaBase.h:87
@ VIDEO_SOURCE_TRANSCODED
Definition AgoraMediaBase.h:119
@ VIDEO_SOURCE_RTC_IMAGE_PNG
Definition AgoraMediaBase.h:103
AudioRoute
The type of the audio route.
Definition AgoraMediaBase.h:189
@ ROUTE_HEADSET
Definition AgoraMediaBase.h:197
@ ROUTE_DISPLAYPORT
Definition AgoraMediaBase.h:229
@ ROUTE_SPEAKERPHONE
Definition AgoraMediaBase.h:209
@ ROUTE_HEADSETNOMIC
Definition AgoraMediaBase.h:205
@ ROUTE_EARPIECE
Definition AgoraMediaBase.h:201
@ ROUTE_AIRPLAY
Definition AgoraMediaBase.h:233
@ ROUTE_DEFAULT
Definition AgoraMediaBase.h:193
@ ROUTE_LOUDSPEAKER
Definition AgoraMediaBase.h:213
@ ROUTE_HDMI
Definition AgoraMediaBase.h:225
@ ROUTE_BLUETOOTH_DEVICE_HFP
Definition AgoraMediaBase.h:217
@ ROUTE_USB
Definition AgoraMediaBase.h:221
@ ROUTE_BLUETOOTH_DEVICE_A2DP
Definition AgoraMediaBase.h:237
RAW_AUDIO_FRAME_OP_MODE_TYPE
The use mode of the audio data.
Definition AgoraMediaBase.h:261
@ RAW_AUDIO_FRAME_OP_MODE_READ_WRITE
Definition AgoraMediaBase.h:274
@ RAW_AUDIO_FRAME_OP_MODE_READ_ONLY
Definition AgoraMediaBase.h:267
static const unsigned int DEFAULT_CONNECTION_ID
Definition AgoraMediaBase.h:34
Definition AgoraAtomicOps.h:21
Definition video_node_i.h:28
The audio spectrum data.
Definition AgoraMediaBase.h:1843
AudioSpectrumData(const float *data, int length)
Definition AgoraMediaBase.h:1856
AudioSpectrumData()
Definition AgoraMediaBase.h:1855
const float * audioSpectrumData
Definition AgoraMediaBase.h:1849
int dataLength
Definition AgoraMediaBase.h:1853
const char * serverConfig
Definition AgoraMediaBase.h:1351
ContentInspectModule modules[MAX_CONTENT_INSPECT_MODULE_COUNT]
Definition AgoraMediaBase.h:1359
ContentInspectConfig()
Definition AgoraMediaBase.h:1373
ContentInspectConfig & operator=(const ContentInspectConfig &rth)
Definition AgoraMediaBase.h:1366
const char * extraInfo
Definition AgoraMediaBase.h:1345
int moduleCount
Definition AgoraMediaBase.h:1365
ContentInspectModule class, a structure used to configure the frequency of video screenshot and uploa...
Definition AgoraMediaBase.h:1314
unsigned int interval
Definition AgoraMediaBase.h:1324
base::VIDEO_MODULE_POSITION position
Definition AgoraMediaBase.h:1328
ContentInspectModule()
Definition AgoraMediaBase.h:1329
CONTENT_INSPECT_TYPE type
Definition AgoraMediaBase.h:1318
Raw audio data.
Definition AgoraMediaBase.h:1436
AudioFrame()
Definition AgoraMediaBase.h:1492
int64_t presentationMs
Definition AgoraMediaBase.h:1482
uint32_t rtpTimestamp
Definition AgoraMediaBase.h:1490
int channels
Definition AgoraMediaBase.h:1454
int samplesPerChannel
Definition AgoraMediaBase.h:1444
int samplesPerSec
Definition AgoraMediaBase.h:1458
int avsync_type
Definition AgoraMediaBase.h:1475
void * buffer
Definition AgoraMediaBase.h:1464
int audioTrackNumber
Definition AgoraMediaBase.h:1486
AUDIO_FRAME_TYPE type
Definition AgoraMediaBase.h:1440
agora::rtc::BYTES_PER_SAMPLE bytesPerSample
Definition AgoraMediaBase.h:1448
int64_t renderTimeMs
Definition AgoraMediaBase.h:1471
Audio data format.
Definition AgoraMediaBase.h:1546
int samples_per_call
Definition AgoraMediaBase.h:1572
int sample_rate
Definition AgoraMediaBase.h:1555
AudioParams(int samplerate, int channel, rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE type, int samplesPerCall)
Definition AgoraMediaBase.h:1579
AudioParams()
Definition AgoraMediaBase.h:1574
int channels
Definition AgoraMediaBase.h:1562
rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE mode
Definition AgoraMediaBase.h:1567
const char * storagePath
Definition AgoraMediaBase.h:2376
agora::rtc::VIDEO_SOURCE_TYPE videoSourceType
Definition AgoraMediaBase.h:2434
int sample_rate
Definition AgoraMediaBase.h:2420
MediaRecorderStreamType streamType
Definition AgoraMediaBase.h:2384
int maxDurationMs
Definition AgoraMediaBase.h:2388
MediaRecorderContainerFormat containerFormat
Definition AgoraMediaBase.h:2380
int width
Definition AgoraMediaBase.h:2401
MediaRecorderConfiguration()
Definition AgoraMediaBase.h:2436
int fps
Definition AgoraMediaBase.h:2414
MediaRecorderConfiguration(const char *path, MediaRecorderContainerFormat format, MediaRecorderStreamType type, int duration, int interval)
Definition AgoraMediaBase.h:2448
int recorderInfoUpdateInterval
Definition AgoraMediaBase.h:2394
int height
Definition AgoraMediaBase.h:2408
int channel_num
Definition AgoraMediaBase.h:2428
Information about the recording file.
Definition AgoraMediaBase.h:2520
RecorderInfo(const char *name, unsigned int dur, unsigned int size)
Definition AgoraMediaBase.h:2535
unsigned int fileSize
Definition AgoraMediaBase.h:2532
RecorderInfo()
Definition AgoraMediaBase.h:2534
const char * fileName
Definition AgoraMediaBase.h:2524
unsigned int durationMs
Definition AgoraMediaBase.h:2528
const char * filePath
Definition AgoraMediaBase.h:1387
SnapshotConfig()
Definition AgoraMediaBase.h:1396
media::base::VIDEO_MODULE_POSITION position
Definition AgoraMediaBase.h:1395
Audio spectrum information of the remote user.
Definition AgoraMediaBase.h:1862
UserAudioSpectrumInfo(agora::rtc::uid_t uid, const float *data, int length)
Definition AgoraMediaBase.h:1874
struct AudioSpectrumData spectrumData
Definition AgoraMediaBase.h:1870
agora::rtc::uid_t uid
Definition AgoraMediaBase.h:1866
UserAudioSpectrumInfo()
Definition AgoraMediaBase.h:1872
uint64_t sendTs
Definition AgoraMediaBase.h:376
AudioEncodedFrameInfo()
Definition AgoraMediaBase.h:381
uint8_t codec
Definition AgoraMediaBase.h:380
The parameters of the audio frame in PCM format.
Definition AgoraMediaBase.h:387
int audio_track_number_
Definition AgoraMediaBase.h:424
bool is_stereo_
Definition AgoraMediaBase.h:438
rtc::BYTES_PER_SAMPLE bytes_per_sample
Definition AgoraMediaBase.h:428
AudioPcmFrame()
Definition AgoraMediaBase.h:463
int sample_rate_hz_
Definition AgoraMediaBase.h:416
size_t num_channels_
Definition AgoraMediaBase.h:420
size_t samples_per_channel_
Definition AgoraMediaBase.h:412
int64_t capture_timestamp
Definition AgoraMediaBase.h:408
int16_t data_[kMaxDataSizeSamples]
Definition AgoraMediaBase.h:432
OPTIONAL_ENUM_SIZE_T
Definition AgoraMediaBase.h:391
AudioPcmFrame & operator=(const AudioPcmFrame &src)
Definition AgoraMediaBase.h:440
AudioPcmFrame(const AudioPcmFrame &src)
Definition AgoraMediaBase.h:474
Definition AgoraMediaBase.h:638
RangeID range
Definition AgoraMediaBase.h:709
MatrixID matrix
Definition AgoraMediaBase.h:708
RangeID
Definition AgoraMediaBase.h:655
@ RANGEID_FULL
Definition AgoraMediaBase.h:662
@ RANGEID_DERIVED
Definition AgoraMediaBase.h:664
@ RANGEID_INVALID
Definition AgoraMediaBase.h:658
@ RANGEID_LIMITED
Definition AgoraMediaBase.h:660
ColorSpace()
Definition AgoraMediaBase.h:711
bool validate() const
Definition AgoraMediaBase.h:715
MatrixID
Definition AgoraMediaBase.h:667
@ MATRIXID_CDNCLS
Definition AgoraMediaBase.h:680
@ MATRIXID_UNSPECIFIED
Definition AgoraMediaBase.h:671
@ MATRIXID_RGB
Definition AgoraMediaBase.h:669
@ MATRIXID_SMPTE240M
Definition AgoraMediaBase.h:675
@ MATRIXID_BT2100_ICTCP
Definition AgoraMediaBase.h:682
@ MATRIXID_CDCLS
Definition AgoraMediaBase.h:681
@ MATRIXID_SMPTE170M
Definition AgoraMediaBase.h:674
@ MATRIXID_BT2020_CL
Definition AgoraMediaBase.h:678
@ MATRIXID_YCOCG
Definition AgoraMediaBase.h:676
@ MATRIXID_FCC
Definition AgoraMediaBase.h:672
@ MATRIXID_BT2020_NCL
Definition AgoraMediaBase.h:677
@ MATRIXID_BT470BG
Definition AgoraMediaBase.h:673
@ MATRIXID_BT709
Definition AgoraMediaBase.h:670
@ MATRIXID_SMPTE2085
Definition AgoraMediaBase.h:679
PrimaryID primaries
Definition AgoraMediaBase.h:706
TransferID transfer
Definition AgoraMediaBase.h:707
TransferID
Definition AgoraMediaBase.h:685
@ TRANSFERID_SMPTEST428
Definition AgoraMediaBase.h:702
@ TRANSFERID_BT1361_ECG
Definition AgoraMediaBase.h:697
@ TRANSFERID_BT2020_10
Definition AgoraMediaBase.h:699
@ TRANSFERID_SMPTE240M
Definition AgoraMediaBase.h:692
@ TRANSFERID_LINEAR
Definition AgoraMediaBase.h:693
@ TRANSFERID_LOG
Definition AgoraMediaBase.h:694
@ TRANSFERID_SMPTEST2084
Definition AgoraMediaBase.h:701
@ TRANSFERID_GAMMA28
Definition AgoraMediaBase.h:690
@ TRANSFERID_GAMMA22
Definition AgoraMediaBase.h:689
@ TRANSFERID_UNSPECIFIED
Definition AgoraMediaBase.h:688
@ TRANSFERID_LOG_SQRT
Definition AgoraMediaBase.h:695
@ TRANSFERID_IEC61966_2_4
Definition AgoraMediaBase.h:696
@ TRANSFERID_IEC61966_2_1
Definition AgoraMediaBase.h:698
@ TRANSFERID_BT2020_12
Definition AgoraMediaBase.h:700
@ TRANSFERID_BT709
Definition AgoraMediaBase.h:687
@ TRANSFERID_ARIB_STD_B67
Definition AgoraMediaBase.h:703
@ TRANSFERID_SMPTE170M
Definition AgoraMediaBase.h:691
PrimaryID
Definition AgoraMediaBase.h:639
@ PRIMARYID_SMPTEST432
Definition AgoraMediaBase.h:651
@ PRIMARYID_FILM
Definition AgoraMediaBase.h:647
@ PRIMARYID_BT470M
Definition AgoraMediaBase.h:643
@ PRIMARYID_BT709
Definition AgoraMediaBase.h:641
@ PRIMARYID_SMPTE170M
Definition AgoraMediaBase.h:645
@ PRIMARYID_SMPTEST428
Definition AgoraMediaBase.h:649
@ PRIMARYID_UNSPECIFIED
Definition AgoraMediaBase.h:642
@ PRIMARYID_BT2020
Definition AgoraMediaBase.h:648
@ PRIMARYID_SMPTEST431
Definition AgoraMediaBase.h:650
@ PRIMARYID_JEDECP22
Definition AgoraMediaBase.h:652
@ PRIMARYID_BT470BG
Definition AgoraMediaBase.h:644
@ PRIMARYID_SMPTE240M
Definition AgoraMediaBase.h:646
long long fenceObject
Definition AgoraMediaBase.h:952
Hdr10MetadataInfo hdr10MetadataInfo
Definition AgoraMediaBase.h:1009
EGL_CONTEXT_TYPE
Definition AgoraMediaBase.h:854
@ EGL_CONTEXT14
Definition AgoraMediaBase.h:862
@ EGL_CONTEXT10
Definition AgoraMediaBase.h:858
int cropTop
Definition AgoraMediaBase.h:912
VIDEO_PIXEL_FORMAT format
Definition AgoraMediaBase.h:890
int cropLeft
Definition AgoraMediaBase.h:908
void * d3d11Texture2d
Definition AgoraMediaBase.h:998
int cropRight
Definition AgoraMediaBase.h:916
uint8_t * metadataBuffer
Definition AgoraMediaBase.h:962
bool fillAlphaBuffer
Definition AgoraMediaBase.h:987
int stride
Definition AgoraMediaBase.h:900
uint8_t * alphaBuffer
Definition AgoraMediaBase.h:975
void * buffer
Definition AgoraMediaBase.h:895
EGL_CONTEXT_TYPE eglType
Definition AgoraMediaBase.h:942
int cropBottom
Definition AgoraMediaBase.h:920
int height
Definition AgoraMediaBase.h:904
ExternalVideoFrame()
Definition AgoraMediaBase.h:827
long long timestamp
Definition AgoraMediaBase.h:930
int metadataSize
Definition AgoraMediaBase.h:967
VIDEO_BUFFER_TYPE
The video buffer type.
Definition AgoraMediaBase.h:868
@ VIDEO_BUFFER_RAW_DATA
Definition AgoraMediaBase.h:872
@ VIDEO_BUFFER_ARRAY
Definition AgoraMediaBase.h:876
@ VIDEO_BUFFER_TEXTURE
Definition AgoraMediaBase.h:880
int textureId
Definition AgoraMediaBase.h:947
ALPHA_STITCH_MODE alphaStitchMode
Definition AgoraMediaBase.h:992
void * eglContext
Definition AgoraMediaBase.h:938
int rotation
Definition AgoraMediaBase.h:925
VIDEO_BUFFER_TYPE type
Definition AgoraMediaBase.h:886
float matrix[16]
Definition AgoraMediaBase.h:956
ColorSpace colorSpace
Definition AgoraMediaBase.h:1015
int textureSliceIndex
Definition AgoraMediaBase.h:1004
Definition AgoraMediaBase.h:725
uint16_t bluePrimaryY
Definition AgoraMediaBase.h:749
uint16_t redPrimaryY
Definition AgoraMediaBase.h:733
bool validate() const
Definition AgoraMediaBase.h:789
uint16_t bluePrimaryX
Definition AgoraMediaBase.h:745
uint16_t redPrimaryX
Definition AgoraMediaBase.h:729
uint16_t whitePointY
Definition AgoraMediaBase.h:757
uint16_t greenPrimaryX
Definition AgoraMediaBase.h:737
Hdr10MetadataInfo()
Definition AgoraMediaBase.h:775
uint16_t whitePointX
Definition AgoraMediaBase.h:753
unsigned int minMasteringLuminance
Definition AgoraMediaBase.h:765
uint16_t maxFrameAverageLightLevel
Definition AgoraMediaBase.h:773
uint16_t greenPrimaryY
Definition AgoraMediaBase.h:741
uint16_t maxContentLightLevel
Definition AgoraMediaBase.h:769
unsigned int maxMasteringLuminance
Definition AgoraMediaBase.h:761
PacketOptions()
Definition AgoraMediaBase.h:365
uint32_t timestamp
Definition AgoraMediaBase.h:362
uint8_t audioLevelIndication
Definition AgoraMediaBase.h:364
Configurations of the video frame.
Definition AgoraMediaBase.h:1026
int uStride
Definition AgoraMediaBase.h:1074
ColorSpace colorSpace
Definition AgoraMediaBase.h:1170
int rotation
Definition AgoraMediaBase.h:1097
VideoFrame()
Definition AgoraMediaBase.h:1027
Hdr10MetadataInfo hdr10MetadataInfo
Definition AgoraMediaBase.h:1164
VIDEO_PIXEL_FORMAT type
Definition AgoraMediaBase.h:1054
int vStride
Definition AgoraMediaBase.h:1080
float matrix[16]
Definition AgoraMediaBase.h:1136
uint8_t * alphaBuffer
Definition AgoraMediaBase.h:1146
int avsync_type
Definition AgoraMediaBase.h:1106
void * d3d11Texture2d
Definition AgoraMediaBase.h:1131
uint8_t * vBuffer
Definition AgoraMediaBase.h:1092
int metadata_size
Definition AgoraMediaBase.h:1118
void * pixelBuffer
Definition AgoraMediaBase.h:1155
int textureId
Definition AgoraMediaBase.h:1126
uint8_t * metadata_buffer
Definition AgoraMediaBase.h:1112
uint8_t * yBuffer
Definition AgoraMediaBase.h:1084
void * sharedContext
Definition AgoraMediaBase.h:1122
int yStride
Definition AgoraMediaBase.h:1068
int height
Definition AgoraMediaBase.h:1062
int width
Definition AgoraMediaBase.h:1058
IVideoFrameMetaInfo * metaInfo
Definition AgoraMediaBase.h:1159
uint8_t * uBuffer
Definition AgoraMediaBase.h:1088
int64_t renderTimeMs
Definition AgoraMediaBase.h:1102
ALPHA_STITCH_MODE alphaStitchMode
Definition AgoraMediaBase.h:1151
size_t channels
Definition AgoraMediaBase.h:252
int sample_rate
Definition AgoraMediaBase.h:251
AudioParameters()
Definition AgoraMediaBase.h:255
size_t frames_per_buffer
Definition AgoraMediaBase.h:253
Information about externally encoded video frames.
Definition AgoraBase.h:1821
uid_t uid
Definition AgoraMediaBase.h:51
const char * providerName
Definition AgoraMediaBase.h:55
bool isValid
Definition AgoraMediaBase.h:47
const char * extensionName
Definition AgoraMediaBase.h:59
ExtensionContext()
Definition AgoraMediaBase.h:60