Agora RTC Objective-C API Reference  Refactor
Data Structures | Namespaces | Macros | Enumerations | Functions
IAgoraRtcEngine.h File Reference

Go to the source code of this file.

Data Structures

struct  LocalVideoStats
 
struct  RemoteAudioStats
 
struct  RemoteVideoStats
 
struct  VideoCompositingLayout
 
struct  VideoCompositingLayout::Region
 
struct  InjectStreamConfig
 
struct  PublisherConfiguration
 
struct  CameraCapturerConfiguration
 
struct  ScreenCaptureConfiguration
 
struct  AdvancedAudioOptions
 
struct  ImageTrackOptions
 
struct  ChannelMediaOptions
 
struct  LeaveChannelOptions
 
class  IRtcEngineEventHandler
 
class  IVideoDeviceCollection
 
class  IVideoDeviceManager
 
struct  RtcEngineContext
 
class  IMetadataObserver
 
struct  IMetadataObserver::Metadata
 
struct  DirectCdnStreamingStats
 
class  IDirectCdnStreamingEventHandler
 
struct  DirectCdnStreamingMediaOptions
 
struct  ExtensionInfo
 
class  IRtcEngine
 
class  AAudioDeviceManager
 
class  AVideoDeviceManager
 

Namespaces

 agora
 
 agora::rtm
 
 agora::rtc
 

Macros

#define getAgoraRtcEngineVersion   getAgoraSdkVersion
 
#define getAgoraRtcEngineErrorDescription   getAgoraSdkErrorDescription
 

Enumerations

enum  MEDIA_DEVICE_TYPE {
  UNKNOWN_AUDIO_DEVICE = -1, AUDIO_PLAYOUT_DEVICE = 0, AUDIO_RECORDING_DEVICE = 1, VIDEO_RENDER_DEVICE = 2,
  VIDEO_CAPTURE_DEVICE = 3, AUDIO_APPLICATION_PLAYOUT_DEVICE = 4, AUDIO_VIRTUAL_PLAYOUT_DEVICE = 5, AUDIO_VIRTUAL_RECORDING_DEVICE = 6
}
 
enum  AUDIO_MIXING_STATE_TYPE { AUDIO_MIXING_STATE_PLAYING = 710, AUDIO_MIXING_STATE_PAUSED = 711, AUDIO_MIXING_STATE_STOPPED = 713, AUDIO_MIXING_STATE_FAILED = 714 }
 
enum  AUDIO_MIXING_REASON_TYPE {
  AUDIO_MIXING_REASON_CAN_NOT_OPEN = 701, AUDIO_MIXING_REASON_TOO_FREQUENT_CALL = 702, AUDIO_MIXING_REASON_INTERRUPTED_EOF = 703, AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED = 721,
  AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED = 723, AUDIO_MIXING_REASON_STOPPED_BY_USER = 724, AUDIO_MIXING_REASON_RESUMED_BY_USER = 726, AUDIO_MIXING_REASON_OK = 0
}
 
enum  INJECT_STREAM_STATUS {
  INJECT_STREAM_STATUS_START_SUCCESS = 0, INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1, INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2, INJECT_STREAM_STATUS_START_TIMEDOUT = 3,
  INJECT_STREAM_STATUS_START_FAILED = 4, INJECT_STREAM_STATUS_STOP_SUCCESS = 5, INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6, INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7,
  INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8, INJECT_STREAM_STATUS_STOP_FAILED = 9, INJECT_STREAM_STATUS_BROKEN = 10
}
 
enum  AUDIO_EQUALIZATION_BAND_FREQUENCY {
  AUDIO_EQUALIZATION_BAND_31 = 0, AUDIO_EQUALIZATION_BAND_62 = 1, AUDIO_EQUALIZATION_BAND_125 = 2, AUDIO_EQUALIZATION_BAND_250 = 3,
  AUDIO_EQUALIZATION_BAND_500 = 4, AUDIO_EQUALIZATION_BAND_1K = 5, AUDIO_EQUALIZATION_BAND_2K = 6, AUDIO_EQUALIZATION_BAND_4K = 7,
  AUDIO_EQUALIZATION_BAND_8K = 8, AUDIO_EQUALIZATION_BAND_16K = 9
}
 
enum  AUDIO_REVERB_TYPE {
  AUDIO_REVERB_DRY_LEVEL = 0, AUDIO_REVERB_WET_LEVEL = 1, AUDIO_REVERB_ROOM_SIZE = 2, AUDIO_REVERB_WET_DELAY = 3,
  AUDIO_REVERB_STRENGTH = 4
}
 
enum  RTMP_STREAM_LIFE_CYCLE_TYPE { RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL = 1, RTMP_STREAM_LIFE_CYCLE_BIND2OWNER = 2 }
 
enum  CAMERA_DIRECTION { CAMERA_REAR = 0, CAMERA_FRONT = 1 }
 
enum  CLOUD_PROXY_TYPE { NONE_PROXY = 0, UDP_PROXY = 1 }
 
enum  MEDIA_DEVICE_STATE_TYPE {
  MEDIA_DEVICE_STATE_IDLE = 0, MEDIA_DEVICE_STATE_ACTIVE = 1, MEDIA_DEVICE_STATE_DISABLED = 2, MEDIA_DEVICE_STATE_PLUGGED_IN = 3,
  MEDIA_DEVICE_STATE_NOT_PRESENT = 4, MEDIA_DEVICE_STATE_UNPLUGGED = 8
}
 

Functions

AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine ()
 

Macro Definition Documentation

◆ SET_FROM [1/2]

#define SET_FROM (   X)    SetFrom(&X, change.X)

◆ BEGIN_COMPARE [1/2]

#define BEGIN_COMPARE ( )    bool b = true

◆ ADD_COMPARE [1/2]

#define ADD_COMPARE (   X)    b = (b && (X == o.X))

◆ END_COMPARE [1/2]

#define END_COMPARE ( )

◆ REPLACE_BY [1/2]

#define REPLACE_BY (   X)    ReplaceBy(&X, replace.X)

◆ SET_FROM [2/2]

#define SET_FROM (   X)    SetFrom(&X, change.X)

◆ BEGIN_COMPARE [2/2]

#define BEGIN_COMPARE ( )    bool b = true

◆ ADD_COMPARE [2/2]

#define ADD_COMPARE (   X)    b = (b && (X == o.X))

◆ END_COMPARE [2/2]

#define END_COMPARE ( )

◆ REPLACE_BY [2/2]

#define REPLACE_BY (   X)    ReplaceBy(&X, replace.X)

◆ getAgoraRtcEngineVersion

#define getAgoraRtcEngineVersion   getAgoraSdkVersion

Gets the SDK version number.

Parameters
buildBuild number of Agora the SDK.
Returns
String of the SDK version.

◆ getAgoraRtcEngineErrorDescription

#define getAgoraRtcEngineErrorDescription   getAgoraSdkErrorDescription

Creates the RTC engine object and returns the pointer.

Parameters
errError Code.
Returns
Description of the Error Code: agora::ERROR_CODE_TYPE

◆ setAgoraRtcEngineExternalSymbolLoader

#define setAgoraRtcEngineExternalSymbolLoader   setAgoraSdkExternalSymbolLoader