Skip to content

Commit 8276b0e

Browse files
author
zhaoyongqiang
committed
update english doc link
1 parent 66efc82 commit 8276b0e

32 files changed

Lines changed: 106 additions & 95 deletions

File tree

‎iOS/APIExample/APIExample/Examples/Advanced/AudioMixing/AudioMixing.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ class AudioMixingMain: BaseViewController {
152152
if result != 0 {
153153
// Usually happens with invalid parameters
154154
// Error code description can be found at:
155-
// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
155+
// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
156156
// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
157157
self.showAlert(title: "Error", message: "joinChannel call failed: \(result), please check your params")
158158
}
@@ -302,7 +302,7 @@ extension AudioMixingMain: AgoraRtcEngineDelegate {
302302
/// callback when warning occured for agora sdk, warning can usually be ignored, still it's nice to check out
303303
/// what is happening
304304
/// Warning code description can be found at:
305-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
305+
/// en: https://api-ref.agora.io/en/voice-sdk/ios/3.x/Constants/AgoraWarningCode.html
306306
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
307307
/// @param warningCode warning code of the problem
308308
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurWarning warningCode: AgoraWarningCode) {
@@ -312,7 +312,7 @@ extension AudioMixingMain: AgoraRtcEngineDelegate {
312312
/// callback when error occured for agora sdk, you are recommended to display the error descriptions on demand
313313
/// to let user know something wrong is happening
314314
/// Error code description can be found at:
315-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
315+
/// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
316316
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
317317
/// @param errorCode error code of the problem
318318
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurError errorCode: AgoraErrorCode) {

‎iOS/APIExample/APIExample/Examples/Advanced/ContentInspect/ContentInspect.swift‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,10 @@ class ContentInspectViewController: BaseViewController {
5959
NetworkManager.shared.generateToken(channelName: channelId, success: { token in
6060
let result = self.agoraKit.joinChannel(byToken: token, channelId: channelId, uid: 0, mediaOptions: options)
6161
if result != 0 {
62-
/// Error code description: https://docs.agora.io/en/Interactive%20Broadcast/error_rtc
62+
// Usually happens with invalid parameters
63+
// Error code description can be found at:
64+
// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
65+
// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
6366
self.showAlert(title: "Error", message: "Join channel failed with errorCode: \(result)")
6467
}
6568
})
@@ -109,7 +112,10 @@ extension ContentInspectViewController: AgoraRtcEngineDelegate {
109112
}
110113

111114
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurError errorCode: AgoraErrorCode) {
112-
/// Error code description: https://docs.agora.io/en/Interactive%20Broadcast/error_rtc
115+
// Usually happens with invalid parameters
116+
// Error code description can be found at:
117+
// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
118+
// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
113119
LogUtils.log(message: "Error occur: \(errorCode)", level: .error)
114120
showAlert(title: "Error", message: "Error: \(errorCode.description)")
115121
}

‎iOS/APIExample/APIExample/Examples/Advanced/CreateDataStream/CreateDataStream.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ class CreateDataStreamMain: BaseViewController {
117117
if result != 0 {
118118
// Usually happens with invalid parameters
119119
// Error code description can be found at:
120-
// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
120+
// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
121121
// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
122122
self.showAlert(title: "Error", message: "joinChannel call failed: \(result), please check your params")
123123
}
@@ -179,7 +179,7 @@ extension CreateDataStreamMain: AgoraRtcEngineDelegate {
179179
/// callback when warning occured for agora sdk, warning can usually be ignored, still it's nice to check out
180180
/// what is happening
181181
/// Warning code description can be found at:
182-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
182+
/// en: https://api-ref.agora.io/en/voice-sdk/ios/3.x/Constants/AgoraWarningCode.html
183183
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
184184
/// @param warningCode warning code of the problem
185185
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurWarning warningCode: AgoraWarningCode) {
@@ -189,7 +189,7 @@ extension CreateDataStreamMain: AgoraRtcEngineDelegate {
189189
/// callback when error occured for agora sdk, you are recommended to display the error descriptions on demand
190190
/// to let user know something wrong is happening
191191
/// Error code description can be found at:
192-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
192+
/// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
193193
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
194194
/// @param errorCode error code of the problem
195195
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurError errorCode: AgoraErrorCode) {

‎iOS/APIExample/APIExample/Examples/Advanced/CustomAudioRender/CustomAudioRender.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ class CustomAudioRenderMain: BaseViewController {
100100
if result != 0 {
101101
// Usually happens with invalid parameters
102102
// Error code description can be found at:
103-
// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
103+
// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
104104
// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
105105
self.showAlert(title: "Error", message: "joinChannel call failed: \(result), please check your params")
106106
}
@@ -125,7 +125,7 @@ extension CustomAudioRenderMain: AgoraRtcEngineDelegate {
125125
/// callback when warning occured for agora sdk, warning can usually be ignored, still it's nice to check out
126126
/// what is happening
127127
/// Warning code description can be found at:
128-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
128+
/// en:https://api-ref.agora.io/en/voice-sdk/ios/3.x/Constants/AgoraWarningCode.html
129129
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
130130
/// @param warningCode warning code of the problem
131131
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurWarning warningCode: AgoraWarningCode) {
@@ -135,7 +135,7 @@ extension CustomAudioRenderMain: AgoraRtcEngineDelegate {
135135
/// callback when error occured for agora sdk, you are recommended to display the error descriptions on demand
136136
/// to let user know something wrong is happening
137137
/// Error code description can be found at:
138-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
138+
/// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
139139
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
140140
/// @param errorCode error code of the problem
141141
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurError errorCode: AgoraErrorCode) {

‎iOS/APIExample/APIExample/Examples/Advanced/CustomAudioSource/CustomAudioSource.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ class CustomAudioSourceMain: BaseViewController {
9292
if result != 0 {
9393
// Usually happens with invalid parameters
9494
// Error code description can be found at:
95-
// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
95+
// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
9696
// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
9797
self.showAlert(title: "Error", message: "joinChannel call failed: \(result), please check your params")
9898
}
@@ -118,7 +118,7 @@ extension CustomAudioSourceMain: AgoraRtcEngineDelegate {
118118
/// callback when warning occured for agora sdk, warning can usually be ignored, still it's nice to check out
119119
/// what is happening
120120
/// Warning code description can be found at:
121-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
121+
/// en: https://api-ref.agora.io/en/voice-sdk/ios/3.x/Constants/AgoraWarningCode.html
122122
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
123123
/// @param warningCode warning code of the problem
124124
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurWarning warningCode: AgoraWarningCode) {
@@ -128,7 +128,7 @@ extension CustomAudioSourceMain: AgoraRtcEngineDelegate {
128128
/// callback when error occured for agora sdk, you are recommended to display the error descriptions on demand
129129
/// to let user know something wrong is happening
130130
/// Error code description can be found at:
131-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
131+
/// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
132132
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
133133
/// @param errorCode error code of the problem
134134
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurError errorCode: AgoraErrorCode) {

‎iOS/APIExample/APIExample/Examples/Advanced/CustomPcmAudioSource/CustomPcmAudioSource.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ class CustomPcmAudioSourceMain: BaseViewController {
100100
if result != 0 {
101101
// Usually happens with invalid parameters
102102
// Error code description can be found at:
103-
// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
103+
// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
104104
// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
105105
self.showAlert(title: "Error", message: "joinChannel call failed: \(result), please check your params")
106106
}
@@ -142,7 +142,7 @@ extension CustomPcmAudioSourceMain: AgoraRtcEngineDelegate {
142142
/// callback when warning occured for agora sdk, warning can usually be ignored, still it's nice to check out
143143
/// what is happening
144144
/// Warning code description can be found at:
145-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
145+
/// en: https://api-ref.agora.io/en/voice-sdk/ios/3.x/Constants/AgoraWarningCode.html
146146
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
147147
/// @param warningCode warning code of the problem
148148
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurWarning warningCode: AgoraWarningCode) {
@@ -152,7 +152,7 @@ extension CustomPcmAudioSourceMain: AgoraRtcEngineDelegate {
152152
/// callback when error occured for agora sdk, you are recommended to display the error descriptions on demand
153153
/// to let user know something wrong is happening
154154
/// Error code description can be found at:
155-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
155+
/// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
156156
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
157157
/// @param errorCode error code of the problem
158158
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurError errorCode: AgoraErrorCode) {

‎iOS/APIExample/APIExample/Examples/Advanced/CustomVideoRender/CustomVideoRender.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ class CustomVideoRenderMain: BaseViewController {
113113
if result != 0 {
114114
// Usually happens with invalid parameters
115115
// Error code description can be found at:
116-
// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
116+
// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
117117
// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
118118
self.showAlert(title: "Error", message: "joinChannel call failed: \(result), please check your params")
119119
}
@@ -140,7 +140,7 @@ extension CustomVideoRenderMain: AgoraRtcEngineDelegate {
140140
/// callback when warning occured for agora sdk, warning can usually be ignored, still it's nice to check out
141141
/// what is happening
142142
/// Warning code description can be found at:
143-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
143+
/// en: https://api-ref.agora.io/en/voice-sdk/ios/3.x/Constants/AgoraWarningCode.html
144144
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
145145
/// @param warningCode warning code of the problem
146146
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurWarning warningCode: AgoraWarningCode) {
@@ -150,7 +150,7 @@ extension CustomVideoRenderMain: AgoraRtcEngineDelegate {
150150
/// callback when error occured for agora sdk, you are recommended to display the error descriptions on demand
151151
/// to let user know something wrong is happening
152152
/// Error code description can be found at:
153-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
153+
/// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
154154
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
155155
/// @param errorCode error code of the problem
156156
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurError errorCode: AgoraErrorCode) {

‎iOS/APIExample/APIExample/Examples/Advanced/CustomVideoSourcePush/CustomVideoSourcePush.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ class CustomVideoSourcePushMain: BaseViewController {
126126
if result != 0 {
127127
// Usually happens with invalid parameters
128128
// Error code description can be found at:
129-
// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
129+
// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
130130
// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
131131
self.showAlert(title: "Error", message: "joinChannel call failed: \(result), please check your params")
132132
}
@@ -159,7 +159,7 @@ extension CustomVideoSourcePushMain: AgoraRtcEngineDelegate {
159159
/// callback when warning occured for agora sdk, warning can usually be ignored, still it's nice to check out
160160
/// what is happening
161161
/// Warning code description can be found at:
162-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
162+
/// en: https://api-ref.agora.io/en/voice-sdk/ios/3.x/Constants/AgoraWarningCode.html
163163
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
164164
/// @param warningCode warning code of the problem
165165
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurWarning warningCode: AgoraWarningCode) {
@@ -169,7 +169,7 @@ extension CustomVideoSourcePushMain: AgoraRtcEngineDelegate {
169169
/// callback when error occured for agora sdk, you are recommended to display the error descriptions on demand
170170
/// to let user know something wrong is happening
171171
/// Error code description can be found at:
172-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
172+
/// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
173173
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
174174
/// @param errorCode error code of the problem
175175
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurError errorCode: AgoraErrorCode) {

‎iOS/APIExample/APIExample/Examples/Advanced/CustomVideoSourcePushMulti/CustomVideoSourcePushMulti.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ class CustomVideoSourcePushMultiMain: BaseViewController {
136136
if result != 0 {
137137
// Usually happens with invalid parameters
138138
// Error code description can be found at:
139-
// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
139+
// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
140140
// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
141141
self.showAlert(title: "Error", message: "joinChannel call failed: \(result), please check your params")
142142
}
@@ -202,7 +202,7 @@ extension CustomVideoSourcePushMultiMain: AgoraRtcEngineDelegate {
202202
/// callback when warning occured for agora sdk, warning can usually be ignored, still it's nice to check out
203203
/// what is happening
204204
/// Warning code description can be found at:
205-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
205+
/// en: https://api-ref.agora.io/en/voice-sdk/ios/3.x/Constants/AgoraWarningCode.html
206206
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraWarningCode.html
207207
/// @param warningCode warning code of the problem
208208
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurWarning warningCode: AgoraWarningCode) {
@@ -212,7 +212,7 @@ extension CustomVideoSourcePushMultiMain: AgoraRtcEngineDelegate {
212212
/// callback when error occured for agora sdk, you are recommended to display the error descriptions on demand
213213
/// to let user know something wrong is happening
214214
/// Error code description can be found at:
215-
/// en: https://docs.agora.io/en/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
215+
/// en: https://api-ref.agora.io/en/voice-sdk/macos/3.x/Constants/AgoraErrorCode.html#content
216216
/// cn: https://docs.agora.io/cn/Voice/API%20Reference/oc/Constants/AgoraErrorCode.html
217217
/// @param errorCode error code of the problem
218218
func rtcEngine(_ engine: AgoraRtcEngineKit, didOccurError errorCode: AgoraErrorCode) {

0 commit comments

Comments
 (0)