ZegoAudioRoom
Classes | Typedefs | Enumerations | Variables
AVE Namespace Reference

Classes

class  AudioCaptureCallback
 
struct  AudioCaptureFormat
 
struct  AudioFrame
 
struct  ExtAudioProcSet
 
class  IAudioConverter
 
class  IAudioDataInOutput
 
class  IAudioEffectPlayer
 
class  IAudioSource
 
class  IMediaPlayer
 
class  SupportsAudioCapture
 
struct  VideoDataFormat
 
struct  VideoFrameWithFormat
 
struct  VUI
 

Typedefs

typedef void(* OnAudioProcCallback) (const AudioFrame &inFrame, AudioFrame &outFrame)
 
typedef struct ExtAudioProcSet ExtPrepSet
 
typedef OnAudioProcCallback OnPrepCallback
 
typedef struct ExtAudioProcSet ExtPostpSet
 
typedef void(* OnPostpCallback) (const char *streamId, const AudioFrame &inFrame, AudioFrame &outFrame)
 

Enumerations

enum  AudioBufferType { BufferTypeAudioApp = 0 , BufferTypeAudioMic }
 
enum  FrameType {
  TYPE_PCM = 0x1001 , TYPE_PCM_TS_10MS = 0x1002 , TYPE_PCM_10MS = 0x1003 , TYPE_AAC_STREAM = 0x100A ,
  TYPE_OPUS_STREAM = 0x100B
}
 
enum  VideoPixelFormat {
  PIXEL_FORMAT_UNKNOWN = 0 , PIXEL_FORMAT_I420 = 1 , PIXEL_FORMAT_NV12 = 2 , PIXEL_FORMAT_NV21 = 3 ,
  PIXEL_FORMAT_BGRA32 = 4 , PIXEL_FORMAT_RGBA32 = 5 , PIXEL_FORMAT_ARGB32 = 6 , PIXEL_FORMAT_ABGR32 = 7 ,
  PIXEL_FORMAT_I422 = 8 , PIXEL_FORMAT_AVC_AVCC = 9 , PIXEL_FORMAT_AVC_ANNEXB = 10 , PIXEL_FORMAT_YUY2 = 11 ,
  PIXEL_FORMAT_UYVY = 12 , PIXEL_FORMAT_BGR24 = 13 , PIXEL_FORMAT_RGB24 = 14
}
 
enum  ColorPrimaries {
  COL_PRI_RESERVED0 = 0 , COL_PRI_BT709 = 1 , COL_PRI_UNSPECIFIED = 2 , COL_PRI_RESERVED = 3 ,
  COL_PRI_BT470M = 4 , COL_PRI_BT470BG = 5 , COL_PRI_SMPTE170M = 6 , COL_PRI_SMPTE240M = 7 ,
  COL_PRI_FILM = 8 , COL_PRI_BT2020 = 9 , COL_PRI_SMPTE428 = 10 , COL_PRI_SMPTEST428_1 = COL_PRI_SMPTE428 ,
  COL_PRI_SMPTE431 = 11 , COL_PRI_SMPTE432 = 12 , COL_PRI_JEDEC_P22 = 22 , COL_PRI_NB
}
 
enum  ColorTransferCharacteristic {
  COL_TRC_RESERVED0 = 0 , COL_TRC_BT709 = 1 , COL_TRC_UNSPECIFIED = 2 , COL_TRC_RESERVED = 3 ,
  COL_TRC_GAMMA22 = 4 , COL_TRC_GAMMA28 = 5 , COL_TRC_SMPTE170M = 6 , COL_TRC_SMPTE240M = 7 ,
  COL_TRC_LINEAR = 8 , COL_TRC_LOG = 9 , COL_TRC_LOG_SQRT = 10 , COL_TRC_IEC61966_2_4 = 11 ,
  COL_TRC_BT1361_ECG = 12 , COL_TRC_IEC61966_2_1 = 13 , COL_TRC_BT2020_10 = 14 , COL_TRC_BT2020_12 = 15 ,
  COL_TRC_SMPTE2084 = 16 , COL_TRC_SMPTEST2084 = COL_TRC_SMPTE2084 , COL_TRC_SMPTE428 = 17 , COL_TRC_SMPTEST428_1 = COL_TRC_SMPTE428 ,
  COL_TRC_ARIB_STD_B67 = 18 , COL_TRC_NB
}
 
enum  ColorSpace {
  COL_SPC_RGB = 0 , COL_SPC_BT709 = 1 , COL_SPC_UNSPECIFIED = 2 , COL_SPC_RESERVED = 3 ,
  COL_SPC_FCC = 4 , COL_SPC_BT470BG = 5 , COL_SPC_SMPTE170M = 6 , COL_SPC_SMPTE240M = 7 ,
  COL_SPC_YCGCO = 8 , COL_SPC_YCOCG = COL_SPC_YCGCO , COL_SPC_BT2020_NCL = 9 , COL_SPC_BT2020_CL = 10 ,
  COL_SPC_SMPTE2085 = 11 , COL_SPC_CHROMA_DERIVED_NCL = 12 , COL_SPC_CHROMA_DERIVED_CL = 13 , COL_SPC_ICTCP = 14 ,
  COL_SPC_NB
}
 
enum  ColorRange { COL_RANGE_UNSPECIFIED = 0 , COL_RANGE_MPEG = 1 , COL_RANGE_JPEG = 2 , COL_RANGE_NB }
 

Variables

const int MAX_SAMPLES_IN_FRAME = 3200
 

Typedef Documentation

◆ ExtPostpSet

◆ ExtPrepSet

◆ OnAudioProcCallback

typedef void(* AVE::OnAudioProcCallback)(const AVE::AudioFrame &inFrame, AVE::AudioFrame &outFrame)

音频处理回调函数定义

Parameters
inFrame待处理音频数据
outFrame处理后的音频数据,其中buffer 所指向的内存由 SDK 负责申请和销毁,用户处理后回写的数据的采样率不超过48K
Attention
请确保在当前线程完成,且不要做耗时操作

◆ OnPostpCallback

typedef void(* AVE::OnPostpCallback)(const char *streamId, const AudioFrame &inFrame, AudioFrame &outFrame)

音频后处理回调函数定义

Parameters
streamId流 ID, 当 streamId 为空串时,表明这是混音后的音频数据
inFrame待处理音频数据
outFrame处理后的音频数据,其中 buffer 所指向的内存由 SDK 负责申请和销毁,用户处理后回写的数据的采样率不超过48K
Attention
请确保在当前线程完成,且不要做耗时操作

◆ OnPrepCallback

Enumeration Type Documentation

◆ AudioBufferType

Enumerator
BufferTypeAudioApp 
BufferTypeAudioMic 

◆ ColorPrimaries

Chromaticity coordinates of the source primaries. These values match the ones defined by ISO/IEC 23001-8_2013 § 7.1.

Enumerator
COL_PRI_RESERVED0 
COL_PRI_BT709 

also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B

COL_PRI_UNSPECIFIED 
COL_PRI_RESERVED 
COL_PRI_BT470M 

also FCC Title 47 Code of Federal Regulations 73.682 (a)(20)

COL_PRI_BT470BG 

also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM

COL_PRI_SMPTE170M 

also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC

COL_PRI_SMPTE240M 

functionally identical to above

COL_PRI_FILM 

colour filters using Illuminant C

COL_PRI_BT2020 

ITU-R BT2020.

COL_PRI_SMPTE428 

SMPTE ST 428-1 (CIE 1931 XYZ)

COL_PRI_SMPTEST428_1 
COL_PRI_SMPTE431 

SMPTE ST 431-2 (2011) / DCI P3.

COL_PRI_SMPTE432 

SMPTE ST 432-1 (2010) / P3 D65 / Display P3.

COL_PRI_JEDEC_P22 

JEDEC P22 phosphors.

COL_PRI_NB 

Not part of ABI.

◆ ColorRange

MPEG vs JPEG YUV range.

Enumerator
COL_RANGE_UNSPECIFIED 
COL_RANGE_MPEG 

the normal 219*2^(n-8) "MPEG" YUV ranges

COL_RANGE_JPEG 

the normal 2^n-1 "JPEG" YUV ranges

COL_RANGE_NB 

Not part of ABI.

◆ ColorSpace

YUV colorspace type. These values match the ones defined by ISO/IEC 23001-8_2013 § 7.3.

Enumerator
COL_SPC_RGB 

order of coefficients is actually GBR, also IEC 61966-2-1 (sRGB)

COL_SPC_BT709 

also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B

COL_SPC_UNSPECIFIED 
COL_SPC_RESERVED 
COL_SPC_FCC 

FCC Title 47 Code of Federal Regulations 73.682 (a)(20)

COL_SPC_BT470BG 

also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601

COL_SPC_SMPTE170M 

also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC

COL_SPC_SMPTE240M 

functionally identical to above

COL_SPC_YCGCO 

Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16.

COL_SPC_YCOCG 
COL_SPC_BT2020_NCL 

ITU-R BT2020 non-constant luminance system.

COL_SPC_BT2020_CL 

ITU-R BT2020 constant luminance system.

COL_SPC_SMPTE2085 

SMPTE 2085, Y'D'zD'x.

COL_SPC_CHROMA_DERIVED_NCL 

Chromaticity-derived non-constant luminance system.

COL_SPC_CHROMA_DERIVED_CL 

Chromaticity-derived constant luminance system.

COL_SPC_ICTCP 

ITU-R BT.2100-0, ICtCp.

COL_SPC_NB 

Not part of ABI.

◆ ColorTransferCharacteristic

Color Transfer Characteristic. These values match the ones defined by ISO/IEC 23001-8_2013 § 7.2.

Enumerator
COL_TRC_RESERVED0 
COL_TRC_BT709 

also ITU-R BT1361

COL_TRC_UNSPECIFIED 
COL_TRC_RESERVED 
COL_TRC_GAMMA22 

also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM

COL_TRC_GAMMA28 

also ITU-R BT470BG

COL_TRC_SMPTE170M 

also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC

COL_TRC_SMPTE240M 
COL_TRC_LINEAR 

"Linear transfer characteristics"

COL_TRC_LOG 

"Logarithmic transfer characteristic (100:1 range)"

COL_TRC_LOG_SQRT 

"Logarithmic transfer characteristic (100 * Sqrt(10) : 1 range)"

COL_TRC_IEC61966_2_4 

IEC 61966-2-4.

COL_TRC_BT1361_ECG 

ITU-R BT1361 Extended Colour Gamut.

COL_TRC_IEC61966_2_1 

IEC 61966-2-1 (sRGB or sYCC)

COL_TRC_BT2020_10 

ITU-R BT2020 for 10-bit system.

COL_TRC_BT2020_12 

ITU-R BT2020 for 12-bit system.

COL_TRC_SMPTE2084 

SMPTE ST 2084 for 10-, 12-, 14- and 16-bit systems.

COL_TRC_SMPTEST2084 
COL_TRC_SMPTE428 

SMPTE ST 428-1.

COL_TRC_SMPTEST428_1 
COL_TRC_ARIB_STD_B67 

ARIB STD-B67, known as "Hybrid log-gamma".

COL_TRC_NB 

Not part of ABI.

◆ FrameType

Enumerator
TYPE_PCM 
TYPE_PCM_TS_10MS 
TYPE_PCM_10MS 
TYPE_AAC_STREAM 
TYPE_OPUS_STREAM 

◆ VideoPixelFormat

Enumerator
PIXEL_FORMAT_UNKNOWN 
PIXEL_FORMAT_I420 
PIXEL_FORMAT_NV12 
PIXEL_FORMAT_NV21 
PIXEL_FORMAT_BGRA32 
PIXEL_FORMAT_RGBA32 
PIXEL_FORMAT_ARGB32 
PIXEL_FORMAT_ABGR32 
PIXEL_FORMAT_I422 
PIXEL_FORMAT_AVC_AVCC 
PIXEL_FORMAT_AVC_ANNEXB 
PIXEL_FORMAT_YUY2 
PIXEL_FORMAT_UYVY 
PIXEL_FORMAT_BGR24 
PIXEL_FORMAT_RGB24 

Variable Documentation

◆ MAX_SAMPLES_IN_FRAME

const int AVE::MAX_SAMPLES_IN_FRAME = 3200