Skip to content

Commit 10afcd3

Browse files
author
zhangwei
committed
docs: refresh RTC documentation links
1 parent 2cf62f6 commit 10afcd3

188 files changed

Lines changed: 707 additions & 708 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Android/APIExample-Audio/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ You are all set. Now connect your Android device and run the project.
4040
4141
## Contact Us
4242
43-
- For potential issues, take a look at our [FAQ](https://docs.agora.io/en/faq) first
43+
- For potential issues, take a look at our [FAQ](https://docs.agora.io/en/api-reference/faq) first
4444
- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials
4545
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use case
4646
- Repositories managed by developer communities can be found at [Agora Community](https://github.com/AgoraIO-Community)

‎Android/APIExample-Audio/README.zh.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
4040
## 联系我们
4141
42-
- 如果你遇到了困难，可以先参阅 [常见问题](https://docs.agora.io/cn/faq)
42+
- 如果你遇到了困难，可以先参阅 [常见问题](https://doc.shengwang.cn/faq/list)
4343
- 如果你想了解更多官方示例，可以参考 [官方SDK示例](https://github.com/AgoraIO)
4444
- 如果你想了解 Agora SDK 在复杂场景下的应用，可以参考 [官方场景案例](https://github.com/AgoraIO-usecase)
4545
- 如果你想了解 Agora 的一些社区开发者维护的项目，可以查看 [社区](https://github.com/AgoraIO-Community)

‎Android/APIExample-Audio/app/src/main/java/io/agora/api/example/examples/advanced/PlayAudioFiles.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ public void onActivityCreated(@Nullable Bundle savedInstanceState) {
158158
*/
159159
config.mContext = context.getApplicationContext();
160160
/**
161-
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/Agora%20Platform/token#get-an-app-id"> How to get the App ID</a>
161+
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/realtime-media/setup-service-and-credentials"> How to get the App ID</a>
162162
*/
163163
config.mAppId = getAgoraAppId();
164164
/** The channel profile.
@@ -335,9 +335,9 @@ private void joinChannel(String channelId) {
335335

336336
/**
337337
* A temporary token generated in Console. A temporary token is valid for 24 hours. For details, see
338-
* https://docs.agora.io/en/Agora%20Platform/token?platform=All%20Platforms#get-a-temporary-token
338+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/authentication-workflow/android
339339
* A token generated at the server. This applies to scenarios with high-security requirements. For details, see
340-
* https://docs.agora.io/en/cloud-recording/token_server_java?platform=Java*/
340+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/deploy-token-server*/
341341
TokenUtils.gen(requireContext(), channelId, 0, ret -> {
342342
/** Allows a user to join a channel.
343343
if you do not specify the uid, we will generate the uid for you*/
@@ -348,8 +348,8 @@ private void joinChannel(String channelId) {
348348
if (res != 0) {
349349
// Usually happens with invalid parameters
350350
// Error code description can be found at:
351-
// en: https://docs.agora.io/en/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
352-
// cn: https://docs.agora.io/cn/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
351+
// en: https://docs.agora.io/en/realtime-media/rtc/reference/error-codes
352+
// cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
353353
showAlert(RtcEngine.getErrorDescription(Math.abs(res)));
354354
Log.e(TAG, RtcEngine.getErrorDescription(Math.abs(res)));
355355
return;
@@ -367,7 +367,7 @@ private void joinChannel(String channelId) {
367367
/**
368368
* Error code description can be found at:
369369
* en: https://api-ref.agora.io/en/voice-sdk/android/4.x/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
370-
* cn: https://docs.agora.io/cn/voice-call-4.x/API%20Reference/java_ng/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
370+
* cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
371371
*/
372372
@Override
373373
public void onError(int err) {

‎Android/APIExample-Audio/app/src/main/java/io/agora/api/example/examples/advanced/PreCallTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ public void onActivityCreated(@Nullable Bundle savedInstanceState) {
8080
*/
8181
config.mContext = context.getApplicationContext();
8282
/**
83-
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/Agora%20Platform/token#get-an-app-id"> How to get the App ID</a>
83+
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/realtime-media/setup-service-and-credentials"> How to get the App ID</a>
8484
*/
8585
config.mAppId = getAgoraAppId();
8686
/** The channel profile.
@@ -213,7 +213,7 @@ else if(num >= MAX_COUNT_DOWN) {
213213
/**
214214
* Error code description can be found at:
215215
* en: https://api-ref.agora.io/en/voice-sdk/android/4.x/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
216-
* cn: https://docs.agora.io/cn/voice-call-4.x/API%20Reference/java_ng/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
216+
* cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
217217
*/
218218
@Override
219219
public void onError(int err) {

‎Android/APIExample-Audio/app/src/main/java/io/agora/api/example/examples/advanced/ProcessAudioRawData.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ public void onActivityCreated(@Nullable Bundle savedInstanceState) {
147147
*/
148148
config.mContext = context.getApplicationContext();
149149
/**
150-
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/Agora%20Platform/token#get-an-app-id"> How to get the App ID</a>
150+
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/realtime-media/setup-service-and-credentials"> How to get the App ID</a>
151151
*/
152152
config.mAppId = getAgoraAppId();
153153
/** The channel profile.
@@ -273,9 +273,9 @@ private void joinChannel(String channelId) {
273273

274274
/**
275275
* A temporary token generated in Console. A temporary token is valid for 24 hours. For details, see
276-
* https://docs.agora.io/en/Agora%20Platform/token?platform=All%20Platforms#get-a-temporary-token
276+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/authentication-workflow/android
277277
* A token generated at the server. This applies to scenarios with high-security requirements. For details, see
278-
* https://docs.agora.io/en/cloud-recording/token_server_java?platform=Java*/
278+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/deploy-token-server*/
279279
TokenUtils.gen(requireContext(), channelId, 0, ret -> {
280280
ChannelMediaOptions option = new ChannelMediaOptions();
281281
option.autoSubscribeAudio = true;
@@ -284,8 +284,8 @@ private void joinChannel(String channelId) {
284284
if (res != 0) {
285285
// Usually happens with invalid parameters
286286
// Error code description can be found at:
287-
// en: https://docs.agora.io/en/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
288-
// cn: https://docs.agora.io/cn/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
287+
// en: https://docs.agora.io/en/realtime-media/rtc/reference/error-codes
288+
// cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
289289
showAlert(RtcEngine.getErrorDescription(Math.abs(res)));
290290
Log.e(TAG, RtcEngine.getErrorDescription(Math.abs(res)));
291291
return;
@@ -370,7 +370,7 @@ public AudioParams getEarMonitoringAudioParams() {
370370
/**
371371
* Error code description can be found at:
372372
* en: https://api-ref.agora.io/en/voice-sdk/android/4.x/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
373-
* cn: https://docs.agora.io/cn/voice-call-4.x/API%20Reference/java_ng/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
373+
* cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
374374
*/
375375
@Override
376376
public void onError(int err) {

‎Android/APIExample-Audio/app/src/main/java/io/agora/api/example/examples/advanced/RhythmPlayer.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ public void onActivityCreated(@Nullable Bundle savedInstanceState) {
100100
*/
101101
config.mContext = context.getApplicationContext();
102102
/**
103-
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/Agora%20Platform/token#get-an-app-id"> How to get the App ID</a>
103+
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/realtime-media/setup-service-and-credentials"> How to get the App ID</a>
104104
*/
105105
config.mAppId = getAgoraAppId();
106106
/** The channel profile.
@@ -232,9 +232,9 @@ private void joinChannel(String channelId) {
232232

233233
/**
234234
* A temporary token generated in Console. A temporary token is valid for 24 hours. For details, see
235-
* https://docs.agora.io/en/Agora%20Platform/token?platform=All%20Platforms#get-a-temporary-token
235+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/authentication-workflow/android
236236
* A token generated at the server. This applies to scenarios with high-security requirements. For details, see
237-
* https://docs.agora.io/en/cloud-recording/token_server_java?platform=Java*/
237+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/deploy-token-server*/
238238
TokenUtils.gen(requireContext(), channelId, 0, accessToken -> {
239239
/** Allows a user to join a channel.
240240
if you do not specify the uid, we will generate the uid for you*/
@@ -251,8 +251,8 @@ private void joinChannel(String channelId) {
251251
if (res != 0) {
252252
// Usually happens with invalid parameters
253253
// Error code description can be found at:
254-
// en: https://docs.agora.io/en/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
255-
// cn: https://docs.agora.io/cn/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
254+
// en: https://docs.agora.io/en/realtime-media/rtc/reference/error-codes
255+
// cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
256256
showAlert(RtcEngine.getErrorDescription(Math.abs(res)));
257257
Log.e(TAG, RtcEngine.getErrorDescription(Math.abs(res)));
258258
return;
@@ -270,7 +270,7 @@ private void joinChannel(String channelId) {
270270
/**
271271
* Error code description can be found at:
272272
* en: https://api-ref.agora.io/en/voice-sdk/android/4.x/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
273-
* cn: https://docs.agora.io/cn/voice-call-4.x/API%20Reference/java_ng/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
273+
* cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
274274
*/
275275
@Override
276276
public void onError(int err) {

‎Android/APIExample-Audio/app/src/main/java/io/agora/api/example/examples/advanced/SpatialSound.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ public void onActivityCreated(@Nullable Bundle savedInstanceState) {
100100
try {
101101
/*Creates an RtcEngine instance.
102102
* @param context The context of Android Activity
103-
* @param appId The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/Agora%20Platform/token#get-an-app-id">
103+
* @param appId The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/realtime-media/setup-service-and-credentials">
104104
* How to get the App ID</a>
105105
* @param handler IRtcEngineEventHandler is an abstract class providing default implementation.
106106
* The SDK uses this class to report to the app on SDK runtime events.*/
@@ -221,9 +221,9 @@ private void joinChannel() {
221221

222222
/*
223223
* A temporary token generated in Console. A temporary token is valid for 24 hours. For details, see
224-
* https://docs.agora.io/en/Agora%20Platform/token?platform=All%20Platforms#get-a-temporary-token
224+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/authentication-workflow/android
225225
* A token generated at the server. This applies to scenarios with high-security requirements. For details, see
226-
* https://docs.agora.io/en/cloud-recording/token_server_java?platform=Java*/
226+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/deploy-token-server*/
227227
TokenUtils.gen(requireContext(), channelId, 0, ret -> {
228228

229229
ChannelMediaOptions option = new ChannelMediaOptions();
@@ -235,8 +235,8 @@ private void joinChannel() {
235235
if (res != 0) {
236236
// Usually happens with invalid parameters
237237
// Error code description can be found at:
238-
// en: https://docs.agora.io/en/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
239-
// cn: https://docs.agora.io/cn/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
238+
// en: https://docs.agora.io/en/realtime-media/rtc/reference/error-codes
239+
// cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
240240
showAlert(RtcEngine.getErrorDescription(Math.abs(res)));
241241
Log.e(TAG, RtcEngine.getErrorDescription(Math.abs(res)));
242242
return;
@@ -621,7 +621,7 @@ public void onJoinChannelSuccess(String channel, int uid, int elapsed) {
621621
/**
622622
* Error code description can be found at:
623623
* en: https://api-ref.agora.io/en/video-sdk/android/4.x/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
624-
* cn: https://docs.agora.io/cn/video-call-4.x/API%20Reference/java_ng/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
624+
* cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
625625
*/
626626
@Override
627627
public void onError(int err) {

‎Android/APIExample-Audio/app/src/main/java/io/agora/api/example/examples/advanced/VoiceEffects.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ public void onActivityCreated(@Nullable Bundle savedInstanceState) {
247247
*/
248248
config.mContext = context.getApplicationContext();
249249
/*
250-
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/Agora%20Platform/token#get-an-app-id"> How to get the App ID</a>
250+
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/realtime-media/setup-service-and-credentials"> How to get the App ID</a>
251251
*/
252252
config.mAppId = getAgoraAppId();
253253
/* The channel profile.
@@ -402,9 +402,9 @@ private void joinChannel(String channelId) {
402402

403403
/*
404404
* A temporary token generated in Console. A temporary token is valid for 24 hours. For details, see
405-
* https://docs.agora.io/en/Agora%20Platform/token?platform=All%20Platforms#get-a-temporary-token
405+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/authentication-workflow/android
406406
* A token generated at the server. This applies to scenarios with high-security requirements. For details, see
407-
* https://docs.agora.io/en/cloud-recording/token_server_java?platform=Java*/
407+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/deploy-token-server*/
408408
TokenUtils.gen(requireContext(), channelId, 0, accessToken -> {
409409
/* Allows a user to join a channel.
410410
if you do not specify the uid, we will generate the uid for you*/
@@ -416,8 +416,8 @@ private void joinChannel(String channelId) {
416416
if (res != 0) {
417417
// Usually happens with invalid parameters
418418
// Error code description can be found at:
419-
// en: https://docs.agora.io/en/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
420-
// cn: https://docs.agora.io/cn/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
419+
// en: https://docs.agora.io/en/realtime-media/rtc/reference/error-codes
420+
// cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
421421
showAlert(RtcEngine.getErrorDescription(Math.abs(res)));
422422
Log.e(TAG, RtcEngine.getErrorDescription(Math.abs(res)));
423423
return;
@@ -435,7 +435,7 @@ private void joinChannel(String channelId) {
435435
/**
436436
* Error code description can be found at:
437437
* en: https://api-ref.agora.io/en/video-sdk/android/4.x/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
438-
* cn: https://docs.agora.io/cn/video-call-4.x/API%20Reference/java_ng/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
438+
* cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
439439
*/
440440
@Override
441441
public void onError(int err) {

‎Android/APIExample-Audio/app/src/main/java/io/agora/api/example/examples/advanced/customaudio/CustomAudioRender.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public void onActivityCreated(@Nullable Bundle savedInstanceState) {
104104
*/
105105
config.mContext = context.getApplicationContext();
106106
/*
107-
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/Agora%20Platform/token#get-an-app-id"> How to get the App ID</a>
107+
* The App ID issued to you by Agora. See <a href="https://docs.agora.io/en/realtime-media/setup-service-and-credentials"> How to get the App ID</a>
108108
*/
109109
config.mAppId = getAgoraAppId();
110110
/* The channel profile.
@@ -238,9 +238,9 @@ private void joinChannel(String channelId) {
238238

239239
/*
240240
* A temporary token generated in Console. A temporary token is valid for 24 hours. For details, see
241-
* https://docs.agora.io/en/Agora%20Platform/token?platform=All%20Platforms#get-a-temporary-token
241+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/authentication-workflow/android
242242
* A token generated at the server. This applies to scenarios with high-security requirements. For details, see
243-
* https://docs.agora.io/en/cloud-recording/token_server_java?platform=Java*/
243+
* https://docs.agora.io/en/realtime-media/rtc/build/authenticate-users/deploy-token-server*/
244244
TokenUtils.gen(requireContext(), channelId, 0, ret -> {
245245

246246
ChannelMediaOptions option = new ChannelMediaOptions();
@@ -255,8 +255,8 @@ private void joinChannel(String channelId) {
255255
if (res != 0) {
256256
// Usually happens with invalid parameters
257257
// Error code description can be found at:
258-
// en: https://docs.agora.io/en/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
259-
// cn: https://docs.agora.io/cn/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler_1_1_error_code.html
258+
// en: https://docs.agora.io/en/realtime-media/rtc/reference/error-codes
259+
// cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
260260
showAlert(RtcEngine.getErrorDescription(Math.abs(res)));
261261
return;
262262
}
@@ -274,7 +274,7 @@ private void joinChannel(String channelId) {
274274

275275
/**
276276
* en: https://api-ref.agora.io/en/video-sdk/android/4.x/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
277-
* cn: https://docs.agora.io/cn/video-call-4.x/API%20Reference/java_ng/API/class_irtcengineeventhandler.html#callback_irtcengineeventhandler_onerror
277+
* cn: https://doc.shengwang.cn/api-ref/rtc/android/error-code
278278
*/
279279
@Override
280280
public void onError(int err) {

0 commit comments

Comments
 (0)