Agora RTC Objective-C API Reference Refactor

Data Structures | Namespaces | Macros | Typedefs | 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

## Typedefs
using | RtcEngineReleaseCallback = void(*)()

## Enumerations
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 | CLOUD_PROXY_TYPE { NONE_PROXY = 0, UDP_PROXY = 1 }
enum | DIRECT_CDN_STREAMING_REASON { DIRECT_CDN_STREAMING_REASON_OK = 0, DIRECT_CDN_STREAMING_REASON_FAILED = 1, DIRECT_CDN_STREAMING_REASON_AUDIO_PUBLICATION = 2, DIRECT_CDN_STREAMING_REASON_VIDEO_PUBLICATION = 3, DIRECT_CDN_STREAMING_REASON_NET_CONNECT = 4, DIRECT_CDN_STREAMING_REASON_BAD_NAME = 5 }
enum | DIRECT_CDN_STREAMING_STATE { DIRECT_CDN_STREAMING_STATE_IDLE = 0, DIRECT_CDN_STREAMING_STATE_RUNNING = 1, DIRECT_CDN_STREAMING_STATE_STOPPED = 2, DIRECT_CDN_STREAMING_STATE_FAILED = 3, DIRECT_CDN_STREAMING_STATE_RECOVERING = 4 }

## 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

  build | Build 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

  err | Error Code.

Returns
  Description of the Error Code: agora::ERROR_CODE_TYPE

## ◆ setAgoraRtcEngineExternalSymbolLoader

#define setAgoraRtcEngineExternalSymbolLoader setAgoraSdkExternalSymbolLoader