agoraio/review-case

review-case — APIExample-OC

Review Dimensions (in priority order)

1. Engine Lifecycle

Check:

• [AgoraRtcEngineKit sharedEngineWithConfig:delegate:] called in viewDidLoad (not in Entry VC)
• [self.agoraKit leaveChannel:] + [AgoraRtcEngineKit destroy] called when leaving
• Cleanup triggered by isMovingFromParentViewController in viewDidDisappear:, or in dealloc

Correct:

- (void)viewDidDisappear:(BOOL)animated {
    [super viewDidDisappear:animated];
    if (self.isMovingFromParentViewController) {
        [self.agoraKit leaveChannel:nil];
        [AgoraRtcEngineKit destroy];
    }
}

Wrong:

// Missing destroy — engine leaks
- (void)viewDidDisappear:(BOOL)animated {
    [self.agoraKit leaveChannel:nil];
}

---

2. Thread Safety

All AgoraRtcEngineDelegate callbacks may arrive on a background thread.

Check:

• Every UI update inside a delegate callback is wrapped in dispatch_async(dispatch_get_main_queue(), ^{ })
• No UIView or other UIKit objects mutated directly in callbacks

Correct:

- (void)rtcEngine:(AgoraRtcEngineKit *)engine didJoinedOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed {
    dispatch_async(dispatch_get_main_queue(), ^{
        [self setupRemoteVideoWithUid:uid];
    });
}

Wrong:

- (void)rtcEngine:(AgoraRtcEngineKit *)engine didJoinedOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed {
    [self setupRemoteVideoWithUid:uid];  // UI update on background thread
}

---

3. Memory Management

Check:

• __weak typeof(self) weakSelf = self used in all blocks that capture self
• Delegate property on AgoraRtcEngineKit is weak (it is by SDK design, but verify no strong cycle)
• No __unsafe_unretained used for delegate or view references

Correct:

__weak typeof(self) weakSelf = self;
[[NetworkManager shared] generateTokenWithChannelName:channelName success:^(NSString *token) {
    [weakSelf.agoraKit joinChannelByToken:token ...];
}];

---

4. Permissions

Check:

• Camera permission requested before joinChannelByToken: for video cases
• Microphone permission requested before joinChannelByToken: for all cases
• joinChannelByToken: called only inside the permission grant callback

---

5. Error Handling

Check:

• Return value of joinChannelByToken: checked (non-zero = error)
• rtcEngine:didOccurError: delegate method implemented and logged
• Token expiry handled via rtcEngine:tokenPrivilegeWillExpire: if token is used

---

6. Code Conventions

Check:

• Entry class inherits UIViewController, Main class inherits BaseViewController
• Class names follow <ExampleName>Entry / <ExampleName>Main pattern
• configs dictionary (NSDictionary) used to pass data from Entry to Main
• File placed under Examples/Basic/ or Examples/Advanced/ matching the MenuItem section
• Both .h and .m files present; public interface minimal in .h

---

7. API Usage Correctness

Check:

• setVideoEncoderConfiguration: called before joinChannelByToken:
• setupLocalVideo: called before startPreview and joinChannelByToken:
• enableVideo called before setupLocalVideo: for video cases
• setClientRole: called before joinChannelByToken: for live streaming cases

---

8. Resource Cleanup

Check:

• Audio files / custom audio tracks stopped and released on exit
• External video sources unregistered on exit
• Media player destroyed if created ([self.agoraKit destroyMediaPlayer:player])
• Screen capture stopped if started
• Multi-camera capture stopped if started

---

Review Output Format

[SEVERITY] file/line — issue description
Suggestion: how to fix

Severity levels:

• [CRITICAL] — crash, leak, or incorrect behavior
• [WARNING] — convention violation or subtle bug risk
• [INFO] — style or minor improvement

---

OC-Specific Checks

• Verify NS_ASSUME_NONNULL_BEGIN/END wraps the header to reduce nullability warnings
• Verify IBOutlet properties are weak (Xcode default, but worth confirming)
• isMovingFromParentViewController is the correct guard in viewDidDisappear: for navigation-based cleanup — do NOT use isBeingDismissed (that's for modal presentation)
• ARC is enabled — no manual retain/release calls should appear