curated a big chunk of AgoraRtcEngineKit

AgoraRtcKit.docc/AgoraRtcEngineKit.md

@@ -0,0 +1,80 @@
+# ``AgoraRtcKit/AgoraRtcEngineKit``
+
+## Topics
+
+### Initialise and Destruct
+
+- ``sharedEngine(withAppId:delegate:)``
+- ``sharedEngine(with:delegate:)``
+- ``destroy()``
+
+### Channel Management
+
+- ``joinChannel(byToken:channelId:info:uid:joinSuccess:)``
+- ``joinChannel(byToken:channelId:uid:mediaOptions:joinSuccess:)``
+- ``updateChannel(with:)``
+- ``leaveChannel(_:)``
+- ``leaveChannel(_:leaveChannelBlock:)``
+- ``renewToken(_:)``
+- ``setClientRole(_:options:)``
+- ``setClientRole(_:)``
+- ``getConnectionState()``
+
+### Channel Events
+
+Check out ``AgoraRtcEngineDelegate`` for channel events.
+
+### Audio Management
+
+- ``enableAudio()``
+- ``disableAudio()``
+- ``enableLocalAudio(_:)``
+- ``setAudioProfile(_:)``
+- ``setAudioProfile(_:scenario:)``
+- ``setAudioScenario(_:)``
+- ``muteLocalAudioStream(_:)``
+- ``muteRemoteAudioStream(_:mute:)``
+- ``muteAllRemoteAudioStreams(_:)``
+- ``setAudioSessionOperationRestriction(_:)``
+- ``adjustRecordingSignalVolume(_:)``
+- ``adjustUserPlaybackSignalVolume(_:volume:)``
+- ``adjustCustomAudioPublishVolume(_:volume:)``
+
+### Video Management
+
+- ``enableVideo()``
+- ``disableVideo()``
+- ``enableLocalVideo(_:)``
+<!--- ``setRenderMode``-->
+<!--- ``setView``-->
+- ``setVideoEncoderConfiguration(_:)``
+- ``startPreview()``
+- ``stopPreview()``
+- ``setupLocalVideo(_:)``
+- ``setupRemoteVideo(_:)``
+- ``setLocalRenderMode(_:mirror:)``
+- ``setRemoteRenderMode(_:mode:mirror:)``
+- ``setRemoteVideoStream(_:type:)``
+- ``muteLocalVideoStream(_:)``
+- ``muteRemoteVideoStream(_:mute:)``
+- ``muteAllRemoteVideoStreams(_:)``
+- ``enableInstantMediaRendering()``
+- ``startMediaRenderingTracing()``
+
+### Capture screenshots
+
+- ``takeSnapshot(_:filePath:)``
+
+See also: ``AgoraRtcEngineDelegate/rtcEngine(_:snapshotTaken:filePath:width:height:errCode:)``
+
+### Subscribing to and publishing audio and video streams
+
+- ``setSubscribeAudioBlocklist(_:)``
+- ``setSubscribeAudioAllowlist(_:)``
+- ``setSubscribeVideoBlocklist(_:)``
+- ``setSubscribeVideoAllowlist(_:)``
+
+### Multi-device capture
+
+- ``startSecondaryCameraCapture()``
+- ``stopSecondaryCameraCapture()``

AgoraRtcKit.docc/AgoraRtcKit.md

@@ -24,7 +24,7 @@ AgoraRtcKit is designed to be flexible and customizable, allowing developers to
 
 ### Core Classes
 
-- ``AgoraRtcEngineKit``
+- ``AgoraRtcKit/AgoraRtcEngineKit``
 - ``AgoraRtcVideoCanvas``
 - ``AgoraRtcEngineDelegate``
 - ``AgoraRtcEngineConfig``