iOS SDK Guide

Install, join a channel, publish/subscribe, screen sharing and permission notes.

Interface sections generated from the public SDK definitions

Version v1.1.0 · Updated 2026-10-26 · revision 1

The iOS surface is a native engine with Objective-C selector shapes: an AgoraRtcEngineKit singleton plus AgoraRtcEngineDelegate callbacks. Method names match the frozen Agora iOS SDK reference version symbol by symbol (the SDK interface definition; for apiVersion see "Platform and public interface definition" on this page).

Prerequisites#

• Xcode 16+, an iOS 15+ deployment target, Swift 5.9+ (Objective-C is supported too).
• Info.plist must contain NSCameraUsageDescription and NSMicrophoneUsageDescription, otherwise the system rejects capture outright (with no prompt).
• Screen sharing needs a separate Broadcast Upload Extension (ReplayKit) with an App Group configured.
• You already have an appId and a token service (see Enable services and get credentials).

Install#

# Podfile (planned coordinate; not yet published to the public CocoaPods codebase)
pod 'NimeetRtc', :path => '../sdk/ios'

Swift Package and Carthage forms will be published together in the release notes.

Get a token#

The client must not hold customerSecret. The recommended setup has the host app's own backend issue tokens, injected through the callback form of RtcTokenProvider (the same concept as on Android):

let provider = FallbackTokenProvider(providers: [
    CallbackTokenProvider { channel, uid, role, completion in
        authClient.fetchRtcToken(channel: channel, uid: uid, role: role, completion: completion)
    },
    StaticTokenProvider(token: ProcessInfo.processInfo.environment["NIMEET_TEST_TOKEN"] ?? "")
])

Join a channel#

import NimeetRtc

final class MeetingController: NSObject, AgoraRtcEngineDelegate {
    private var engine: AgoraRtcEngineKit?

    func start(appId: String, token: String, localView: UIView) {
        let config = AgoraRtcEngineConfig()
        config.appId = appId
        engine = AgoraRtcEngineKit.sharedEngine(withAppId: appId, delegate: self)
        engine?.setChannelProfile(.liveBroadcasting)
        engine?.enableVideo()
        let canvas = AgoraRtcVideoCanvas()
        canvas.view = localView
        engine?.setupLocalVideo(canvas)
        engine?.startPreview()

        let options = AgoraRtcChannelMediaOptions()
        options.clientRoleType = .broadcaster
        engine?.joinChannel(byToken: token,
                            channelId: "weekly-sync",
                            uid: 10001,
                            mediaOptions: options,
                            joinSuccess: { channel, uid, elapsed in
            print("joined \(channel) uid=\(uid) elapsed=\(elapsed)")
        })
    }

    func rtcEngine(_ engine: AgoraRtcEngineKit, didJoinedOfUid uid: UInt, elapsed: Int) {
        // A remote user joined: allocate the remote video container
    }

    func rtcEngine(_ engine: AgoraRtcEngineKit, didOfflineOfUid uid: UInt, reason: AgoraUserOfflineReason) {
        // A remote user left
    }

    func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurError errorCode: AgoraErrorCode) {
        // Route by error number; see the error handling section
    }
}

Publish and subscribe#

The native surface has no publish(track): AgoraRtcChannelMediaOptions decides what is published when joining, and switches control it afterwards.

engine?.muteLocalAudioStream(true)        // mute the microphone
engine?.muteLocalVideoStream(true)        // turn off the camera video
engine?.updateChannelMediaOptions(options) // switch roles / change the subscription scope

Screen sharing uses ReplayKit: the host app starts a Broadcast Upload Extension, and the extension calls startScreenCapture: to feed sample buffers to the SDK.

Events#

Error handling#

• Synchronous methods return Int32: 0 means success, and a negative value is an Agora error number.
• Asynchronous errors go through didOccurError.
• Unimplemented capabilities return -4 (ERR_NOT_SUPPORTED) and fail explicitly.

Troubleshooting#

Next steps#

• Full interfaces and overloads: API reference for this platform
• Error codes and troubleshooting: Error code table, FAQ
• Issue tokens on your server: Token authentication

Platform information

The public interfaces are aligned with the Agora ios API; installation and runtime requirements are listed under Prerequisites above.

Availability

This platform's SDK: Generally available. The examples use the public API; runtime capability follows the published SDK package.

join-channel flow

The method names, parameter types and return values match the API reference for the same platform. Where a method has several overloads, the most common one is shown here; see the API reference for all overloads.

enableVideo(): int
joinChannelByToken:channelId:info:uid:joinSuccess:(token?: NSString*, channelId: NSString*, info?: NSString*, uid: NSUInteger, joinSuccessBlock?: void(^ )(NSString*channel,NSUInteger uid,NSInteger elapsed)): int
leaveChannel:(leaveChannelBlock?: void(^ )(AgoraChannelStats*stat)): int
sharedEngineWithAppId:delegate:(appId: NSString*, delegate?: id): instancetype

Events and callbacks

This SDK has no event callbacks.

Error codes

the platform REST layer uses REST error codes；the SDK layer maps connection/authentication failures to Agora error numbers, for the mapping table see SDK error identifiers per platform。