Agora RTC Native SDK API Examples

The APIExample-SwiftUI project contains a wide range of sample implementations for the Agora RTC Native SDK, categorized into Basic and Advanced examples.

Basic Examples

• JoinChannelVideo: Basic video call using joinChannel(), setupLocalVideo(), and setupRemoteVideo().
• JoinChannelVideo(Token): Video call using token authentication via joinChannel(byToken:).
• JoinChannelVideo(Recorder): Local and remote stream recording using createMediaRecorder().
• JoinChannelAudio: Basic audio call with profile and volume controls using setAudioProfile(), setAudioScenario(), and adjustRecordingSignalVolume().

Advanced Examples (Selected)

• LiveStreaming: Interactive streaming with setClientRole() and setVideoScenario().
• RTMPStream: Pushing streams to a CDN using startRtmpStream().
• VoiceChanger: Audio effects using setVoiceBeautifierPreset() and setAudioEffectPreset().
• CustomPCMAudioSource: Pushing custom PCM audio via pushExternalAudioFrameRawData().
• ScreenShare: Using ReplayKit via startScreenCapture().
• VideoProcess: Beauty effects and virtual backgrounds via setBeautyEffectOptions() and enableVirtualBackground().
• Simulcast: Publishing multiple quality layers with setSimulcastConfig().

The APIExample-OC project contains various sample implementations for the Agora RTC Native SDK in Objective-C. The cases are categorized into Basic and Advanced functionality. Use this index to find specific implementation patterns for features like video calling, live streaming, RTMP streaming, custom audio/video sources, and more.

| Case | Path | Key APIs | Description |
|------|------|----------|-------------|
| JoinChannelVideo | `Examples/Basic/JoinChannelVideo/JoinChannelVideo.m` | `joinChannelByToken:`, `setupLocalVideo:`, `setupRemoteVideo:` | Basic video call — join channel and render local/remote video |
| JoinChannelVideo(Token) | `Examples/Basic/JoinChannelVideo(Token)/JoinChannelVideoToken.m` | `joinChannelByToken:`, `setupLocalVideo:`, `setupRemoteVideo:` | Video call with token authentication |
| JoinChannelVideo(Recorder) | `Examples/Basic/JoinChannelVideo(Recorder)/JoinChannelVideoRecorder.m` | `createMediaRecorder:`, `joinChannelByToken:`, `setupLocalVideo:` | Local and remote stream recording |
| JoinChannelAudio | `Examples/Basic/JoinChannelAudio/JoinChannelAudio.m` | `joinChannelByToken:`, `setAudioProfile:`, `enableAudioVolumeIndication:` | Basic audio call |
| LiveStreaming | `Examples/Advanced/LiveStreaming/LiveStreaming.m` | `setClientRole:`, `setVideoScenario:`, `preloadChannelByToken:`, `enableInstantMediaRendering` | Interactive live streaming with role switching |
| RTMPStreaming | `Examples/Advanced/RTMPStreaming/RTMPStreaming.m` | `startRtmpStreamWithoutTranscoding:`, `startRtmpStreamWithTranscoding:`, `updateRtmpTranscoding:`, `stopRtmpStream:` | Push stream to CDN with optional transcoding |
| VideoMetadata | `Examples/Advanced/VideoMetadata/VideoMetadata.m` | `setMediaMetadataDataSource:withType:`, `setMediaMetadataDelegate:withType:` | Send and receive metadata attached to video stream |
| VoiceChanger | `Examples/Advanced/VoiceChanger/VoiceChanger.m` | `setVoiceBeautifierPreset:`, `setAudioEffectPreset:`, `setVoiceConversionPreset:` | Voice beautifier, effects, and conversion presets |
| CustomPcmAudioSource | `Examples/Advanced/CustomPcmAudioSource/CustomPcmAudioSource.m` | `createCustomAudioTrack:config:`, `enableCustomAudioLocalPlayback:enabled:`, `pushExternalAudioFrameRawData:` | Push custom PCM audio frames as external audio source |
| CustomAudioRender | `Examples/Advanced/CustomAudioRender/CustomAudioRender.m` | `enableExternalAudioSink:sampleRate:channels:`, `pullPlaybackAudioFrameRawData:lengthInByte:` | Pull audio frames for custom rendering |
| CustomVideoSourcePush | `Examples/Advanced/CustomVideoSourcePush/CustomVideoSourcePush.m` | `setExternalVideoSource:useTexture:sourceType:`, `pushExternalVideoFrame:videoTrackId:` | Push external video frames as custom video source |
| CustomVideoRender | `Examples/Advanced/CustomVideoRender/CustomVideoRender.m` | `setVideoFrameDelegate:` | Custom rendering of remote video frames via delegate |
| RawAudioData | `Examples/Advanced/RawAudioData/RawAudioData.m` | `setAudioFrameDelegate:` | Capture raw audio PCM data via delegate |
| RawVideoData | `Examples/Advanced/RawVideoData/RawVideoData.m` | `setVideoFrameDelegate:` | Capture raw video frames via delegate |
| SimpleFilter | `Examples/Advanced/SimpleFilter/SimpleFilter.m` | `enableExtensionWithVendor:extension:enabled:`, `setExtensionPropertyWithVendor:extension:key:value:` | Apply audio/video filter via Agora Extension API |
| JoinMultiChannel | `Examples/Advanced/JoinMultiChannel/JoinMultiChannel.m` | `joinChannelExByToken:connection:delegate:mediaOptions:` | Join multiple channels simultaneously via ex connection |
| StreamEncryption | `Examples/Advanced/StreamEncryption/StreamEncryption.m` | `enableEncryption:encryptionConfig:` | Built-in and custom stream encryption |
| AudioMixing | `Examples/Advanced/AudioMixing/AudioMixing.m` | `startAudioMixing:loopback:cycle:`, `adjustAudioMixingVolume:`, `setEffectsVolume:` | Mix local audio file with microphone input |
| MediaPlayer | `Examples/Advanced/MediaPlayer/MediaPlayer.m` | `createMediaPlayerWithDelegate:`, `updateChannelExWithMediaOptions:connection:` | Play media files and publish to channel via media player |
| ScreenShare | `Examples/Advanced/ScreenShare/ScreenShare.m` | `startScreenCapture:`, `updateScreenCapture:`, `stopScreenCapture` | Screen capture and sharing via ReplayKit extension |
| LocalCompositeGraph | `Examples/Advanced/LocalCompositeGraph/LocalCompositeGraph.m` | `startLocalVideoTranscoder:`, `startCameraCapture:config:`, `enableVirtualBackground:backData:segData:` | Composite multiple video sources locally before publishing |
| VideoProcess | `Examples/Advanced/VideoProcess/VideoProcess.m` | `setBeautyEffectOptions:options:`, `enableVirtualBackground:backData:segData:`, `enableExtensionWithVendor:` | Built-in beauty, virtual background, and video enhancement |
| RhythmPlayer | `Examples/Advanced/RhythmPlayer/RhythmPlayer.m` | `startRhythmPlayer:sound2:config:`, `stopRhythmPlayer` | Play metronome-style rhythm audio |
| CreateDataStream | `Examples/Advanced/CreateDataStream/CreateDataStream.m` | `createDataStream:config:`, `sendStreamMessage:data:` | Create and send data stream messages between users |
| MediaChannelRelay | `Examples/Advanced/MediaChannelRelay/MediaChannelRelay.m` | `startOrUpdateChannelMediaRelay:`, `stopChannelMediaRelay`, `pauseAllChannelMediaRelay`, `resumeAllChannelMediaRelay` | Relay media stream to multiple destination channels |
| SpatialAudio | `Examples/Advanced/SpatialAudio/SpatialAudio.m` | `createMediaPlayerWithDelegate:`, `updateChannelWithMediaOptions:` | 3D spatial audio with media player integration |
| ContentInspect | `Examples/Advanced/ContentInspect/ContentInspect.m` | `enableContentInspect:config:`, `switchCamera` | Moderate content in video stream |
| MutliCamera | `Examples/Advanced/MutliCamera/MutliCamera.m` | `enableMultiCamera:config:`, `startCameraCapture:config:`, `stopCameraCapture:` | Capture from front and back cameras simultaneously (iOS 13+) |
| PictureInPicture | `Examples/Advanced/PictureInPicture/PictureInPicture.m` | `setVideoFrameDelegate:`, `AVPictureInPictureController` | Picture-in-Picture using AVKit (iOS 15+) |
| Simulcast | `Examples/Advanced/Simulcast/Simulcast.m` | `setSimulcastConfig:`, `setRemoteVideoStream:type:` | Publish multiple video quality layers simultaneously |
| Multipath | `Examples/Advanced/Multipath/Multipath.m` | `updateChannelWithMediaOptions:` | Multi-path network transmission configuration |

The APIExample project contains a wide range of implementation examples for the Agora RTC Native SDK on iOS. Use the following index to find specific implementation patterns based on your requirements:

Basic Functionality

• JoinChannelVideo: Basic video call using joinChannel(), setupLocalVideo(), and setupRemoteVideo().
• JoinChannelVideo(Token): Video call with token authentication using joinChannel(byToken:).
• JoinChannelVideo(Recorder): Local and remote stream recording using createMediaRecorder().
• JoinChannelAudio: Basic audio call with volume and in-ear monitoring using setAudioProfile() and enableAudioVolumeIndication().

Advanced Media & Streaming

• LiveStreaming: Interactive live streaming with role switching (setClientRole()) and camera features (enableCameraCenterStage()).
• RTMPStreaming: Push stream to CDN with optional transcoding using startRtmpStream(withTranscoding:).
• VideoMetadata: Send/receive metadata attached to video streams via setMediaMetadataDataSource().
• VoiceChanger: Audio beautification and AI noise suppression using setVoiceBeautifierPreset() and setAINSMode().
• ScreenShare: Screen capture via ReplayKit using startScreenCapture().
• Simulcast: Publish multiple video quality layers simultaneously using setSimulcastConfig().

Custom Audio & Video Sources

• CustomPcmAudioSource: Push custom PCM audio frames using pushExternalAudioFrameRawData().
• CustomVideoSourcePush: Push external video frames using setExternalVideoSource() and pushExternalVideoFrame().
• CustomVideoSourcePushMulti: Multi-track custom video source with encoded frame push using pushExternalEncodedVideoFrame().
• ARKit: Push ARKit face tracking frames as a custom video source.

Data & Control

• CreateDataStream: Send data stream messages between users using createDataStream() and sendStreamMessage().
• MediaChannelRelay: Relay media streams to multiple destination channels using startOrUpdateChannelMediaRelay().
• StreamEncryption: Enable built-in or custom stream encryption via enableEncryption().
• ContentInspect: Moderate content in video streams using enableContentInspect().

This repository contains sample projects for the Agora RTC Native SDK across multiple platforms. Use the following directory mapping to find the specific implementation and SDK version you need:

Android

• Java (Video): /Android/APIExample using RTC Java Video SDK
• Kotlin (Compose/Video): /Android/APIExample-Compose using RTC Java Video SDK
• Java (Audio): /Android/APIExample-Audio using RTC Java Audio SDK

iOS

• Swift (Video): /iOS/APIExample using RTC Objective-C Video SDK
• Objective-C (Video): /iOS/APIExample-OC using RTC Objective-C Video SDK
• Swift (Audio): /iOS/APIExample-Audio using RTC Objective-C Audio SDK

macOS

• Swift (Video): /macOS using RTC Objective-C Video SDK

Windows

• C++ (Video): /windows using RTC C++ Video SDK

The APIExample project is organized to demonstrate various Agora RTC capabilities through a modular, annotation-driven architecture.

Key components include:

• app/src/main/java/io/agora/api/example/examples/: The core directory where all functional use cases reside, categorized into basic and advanced groups.
• app/src/main/java/io/agora/api/example/annotation/: Contains the @Example annotation used to register new use cases.
• app/src/main/java/io/agora/api/example/common/: Provides shared infrastructure, including BaseFragment (the required base class for all example fragments), UI widgets (like VideoReportLayout), and models.
• app/src/main/java/io/agora/api/example/utils/: Contains helper utilities such as ClassUtils (for auto-discovering examples), TokenUtils (for RTC token fetching), and PermissionUtils.
• gradle.properties: Contains configuration flags for the SDK version and optional modules like agora-simple-filter or agora-stream-encrypt.
• app/src/main/assets/: Stores sample audio/video files and beauty resources used by the examples.

The APIExample project provides a comprehensive collection of sample implementations for the Agora RTC Native SDK on Android. These examples are categorized into BASIC and ADVANCED use cases, covering everything from simple one-to-one video calls to complex scenarios like custom audio/video sources, media metadata, and video enhancement.

Key Capabilities Covered:

• Basic Streaming: One-to-one audio/video calling with token verification.
• Advanced Media Control: Custom audio/video sources (YUV, external frames), raw data processing (audio/video observers), and media metadata.
• Enhanced Audio/Video: Voice beautifiers, AI noise suppression, virtual backgrounds, and video filters.
• Specialized Features: Screen sharing, Picture-in-Picture, RTMP streaming to CDN, and spatial audio.
• Network & Quality: Multi-path transmission, simulcast, and pre-call network/echo testing.

The APIExample project is organized into several functional areas to separate core logic, shared utilities, and specific SDK feature demonstrations:

• APIExample/ (Root): Contains the main project files, including Podfile for CocoaPods dependencies (like AgoraRtcEngine_iOS), and optional third-party beauty SDK resources (ByteEffectLib, FULib, SenseLib).
• APIExample/Common/: Contains shared infrastructure used by all examples, such as KeyCenter.swift (App ID/Certificate), GlobalSettings.swift (runtime config), VideoView.swift (reusable rendering), and NetworkManager/ (token requests).
• APIExample/Examples/: The core of the project, divided into:
  • Basic/: Simple use cases like JoinChannelVideo or JoinChannelAudio.
  • Advanced/: Complex features like LiveStreaming, RTMPStreaming, CustomVideoSourcePush, and ScreenShare.
• libs/: Local SDK frameworks used if CocoaPods is not employed.