Agora C++ API Reference for All Platforms
agora::media Namespace Reference

Classes

struct  ExternalVideoFrame
 
struct  ExternalVideoRenerContext
 
class  IAudioFrameObserver
 
class  IExternalVideoRender
 
class  IExternalVideoRenderCallback
 
class  IExternalVideoRenderFactory
 
class  IMediaEngine
 
class  IVideoEncodedFrameObserver
 
class  IVideoFrame
 
class  IVideoFrameObserver
 
struct  VideoEncodedFrame
 

Enumerations

enum  MEDIA_SOURCE_TYPE { AUDIO_PLAYOUT_SOURCE = 0 , AUDIO_RECORDING_SOURCE = 1 }
 
enum  AUDIO_MIXING_DUAL_MONO_MODE { AUDIO_MIXING_DUAL_MONO_AUTO = 0 , AUDIO_MIXING_DUAL_MONO_L = 1 , AUDIO_MIXING_DUAL_MONO_R = 2 , AUDIO_MIXING_DUAL_MONO_MIX = 3 }
 
enum  AUDIO_EXTERNAL_SOURCE_POSITION { AUDIO_EXTERNAL_PLAYOUT_SOURCE = 0 , AUDIO_EXTERNAL_RECORD_SOURCE_PRE_PROCESS = 1 , AUDIO_EXTERNAL_RECORD_SOURCE_POST_PROCESS = 2 }
 
enum  CODEC_VIDEO_FRAME_TYPE {
  CODEC_VIDEO_FRAME_TYPE_BLANK_FRAME = 0 , CODEC_VIDEO_FRAME_TYPE_KEY_FRAME = 3 , CODEC_VIDEO_FRAME_TYPE_DELTA_FRAME = 4 , CODEC_VIDEO_FRAME_TYPE_B_FRAME = 5 ,
  CODEC_VIDEO_FRAME_TYPE_UNKNOW
}
 
enum  VIDEO_ROTATION { VIDEO_ROTATION_0 = 0 , VIDEO_ROTATION_90 = 90 , VIDEO_ROTATION_180 = 180 , VIDEO_ROTATION_270 = 270 }
 
enum  VIDEO_CODEC_TYPE { VIDEO_CODEC_VP8 = 1 , VIDEO_CODEC_H264 = 2 , VIDEO_CODEC_EVP = 3 , VIDEO_CODEC_E264 = 4 }
 

Enumeration Type Documentation

◆ MEDIA_SOURCE_TYPE

Deprecated:
Type of audio device.
Enumerator
AUDIO_PLAYOUT_SOURCE 

Audio playback device.

AUDIO_RECORDING_SOURCE 

Microphone.

◆ AUDIO_MIXING_DUAL_MONO_MODE

The channel mode. Set in setAudioMixingDualMonoMode.

Since
v3.5.1
Enumerator
AUDIO_MIXING_DUAL_MONO_AUTO 

0: Original mode.

AUDIO_MIXING_DUAL_MONO_L 

1: Left channel mode. This mode replaces the audio of the right channel with the audio of the left channel, which means the user can only hear the audio of the left channel.

AUDIO_MIXING_DUAL_MONO_R 

2: Right channel mode. This mode replaces the audio of the left channel with the audio of the right channel, which means the user can only hear the audio of the right channel.

AUDIO_MIXING_DUAL_MONO_MIX 

3: Mixed channel mode. This mode mixes the audio of the left channel and the right channel, which means the user can hear the audio of the left channel and the right channel at the same time.

◆ AUDIO_EXTERNAL_SOURCE_POSITION

The push position of the external audio frame. Set in pushAudioFrame or setExternalAudioSourceVolume.

Since
v3.5.1
Enumerator
AUDIO_EXTERNAL_PLAYOUT_SOURCE 

0: The position before local playback. If you need to play the external audio frame on the local client, set this position.

AUDIO_EXTERNAL_RECORD_SOURCE_PRE_PROCESS 

1: The position after audio capture and before audio pre-processing. If you need the audio module of the SDK to process the external audio frame, set this position.

AUDIO_EXTERNAL_RECORD_SOURCE_POST_PROCESS 

2: The position after audio pre-processing and before audio encoding. If you do not need the audio module of the SDK to process the external audio frame, set this position.

◆ CODEC_VIDEO_FRAME_TYPE

The video frame type.

Since
v3.4.5
Enumerator
CODEC_VIDEO_FRAME_TYPE_BLANK_FRAME 

0: (Default) A black frame

CODEC_VIDEO_FRAME_TYPE_KEY_FRAME 

3: The keyframe

CODEC_VIDEO_FRAME_TYPE_DELTA_FRAME 

4: The delta frame

CODEC_VIDEO_FRAME_TYPE_B_FRAME 

5: The B-frame

CODEC_VIDEO_FRAME_TYPE_UNKNOW 

Unknown frame

◆ VIDEO_ROTATION

The clockwise rotation angle of the video frame.

Since
v3.4.5
Enumerator
VIDEO_ROTATION_0 

0: 0 degree

VIDEO_ROTATION_90 

90: 90 degrees

VIDEO_ROTATION_180 

180: 180 degrees

VIDEO_ROTATION_270 

270: 270 degrees

◆ VIDEO_CODEC_TYPE

The video codec type.

Since
v3.4.5
Enumerator
VIDEO_CODEC_VP8 

1: VP8

VIDEO_CODEC_H264 

2: (Default) H.264

VIDEO_CODEC_EVP 

3: Enhanced VP8

VIDEO_CODEC_E264 

4: Enhanced H.264