fix macOS engine context issue. make sure destroy engine when switching examples

Xia Ning · Xia Ning · commit 80fa9987c0e7 · 2021-04-07T16:58:46.000+08:00
update readme file, add token related information
diff --git a/Android/APIExample/README.md b/Android/APIExample/README.md
@@ -23,7 +23,7 @@ To build and run the sample application, get an App Id:
 3. Save the **App Id** from the Dashboard for later use.
 4. Generate a temp **Access Token** (valid for 24 hours) from dashboard page with given channel name, save for later use.
 
-5. Open `Android/APIExample` and edit the `app/src/main/res/values/string-config.xml` file. Update `<#Your App Id#>` with your App Id, and change `<#Temp Access Token#>` with the temp Access Token generated from dashboard. Note you can leave the token variable `null` if your project has not turned on security token.
+5. Open `Android/APIExample` and edit the `app/src/main/res/values/string_config.xml` file. Update `<#Your App Id#>` with your App Id, and change `<#Temp Access Token#>` with the temp Access Token generated from dashboard. Note you can leave the token variable `null` if your project has not turned on security token.
 
     ```
     <string name="agora_app_id" translatable="false">YOUR APP ID</string>
@@ -33,6 +33,10 @@ To build and run the sample application, get an App Id:
 
 You are all set. Now connect your Android device and run the project.
 
+> To ensure communication security, Agora uses tokens (dynamic keys) to authenticate users joining a channel.
+>
+> Temporary tokens are for demonstration and testing purposes only and remain valid for 24 hours. In a production environment, you need to deploy your own server for generating tokens. See [Generate a Token](https://docs.agora.io/en/Interactive Broadcast/token_server)for details.
+
 ## Contact Us
 
 - For potential issues, take a look at our [FAQ](https://docs.agora.io/en/faq) first
diff --git a/iOS/README.md b/iOS/README.md
@@ -53,6 +53,10 @@ To build and run the sample application, get an App Id:
 
 You are all set. Now connect your iPhone or iPad device and run the project.
 
+> To ensure communication security, Agora uses tokens (dynamic keys) to authenticate users joining a channel.
+>
+> Temporary tokens are for demonstration and testing purposes only and remain valid for 24 hours. In a production environment, you need to deploy your own server for generating tokens. See [Generate a Token](https://docs.agora.io/en/Interactive Broadcast/token_server)for details.
+
 ## Contact Us
 
 - For potential issues, take a look at our [FAQ](https://docs.agora.io/en/faq) first
diff --git a/iOS/README.zh.md b/iOS/README.zh.md
@@ -50,6 +50,10 @@ pod install
 
 然后你就可以使用 `APIExample.xcworkspace` 编译并运行项目了。
 
+>为提高项目的安全性，Agora 使用 Token（动态密钥）对即将加入频道的用户进行鉴权。
+>
+>临时 Token 仅作为演示和测试用途。在生产环境中，你需要自行部署服务器签发 Token，详见[生成 Token](https://docs.agora.io/cn/Interactive Broadcast/token_server)。
+
 ## 联系我们
 
 - 如果你遇到了困难，可以先参阅 [常见问题](https://docs.agora.io/cn/faq)
diff --git a/macOS/APIExample/Examples/Advanced/AudioMixing/AudioMixing.swift b/macOS/APIExample/Examples/Advanced/AudioMixing/AudioMixing.swift
@@ -363,6 +363,7 @@ class AudioMixing: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/ChannelMediaRelay/ChannelMediaRelay.swift b/macOS/APIExample/Examples/Advanced/ChannelMediaRelay/ChannelMediaRelay.swift
@@ -117,6 +117,7 @@ class ChannelMediaRelay: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/CreateDataStream/CreateDataStream.swift b/macOS/APIExample/Examples/Advanced/CreateDataStream/CreateDataStream.swift
@@ -145,6 +145,7 @@ class CreateDataStream: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/CustomAudioRender/CustomAudioRender.swift b/macOS/APIExample/Examples/Advanced/CustomAudioRender/CustomAudioRender.swift
@@ -137,6 +137,7 @@ class CustomAudioRender: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/CustomAudioSource/CustomAudioSource.swift b/macOS/APIExample/Examples/Advanced/CustomAudioSource/CustomAudioSource.swift
@@ -136,6 +136,7 @@ class CustomAudioSource: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/CustomVideoRender/CustomVideoRender.swift b/macOS/APIExample/Examples/Advanced/CustomVideoRender/CustomVideoRender.swift
@@ -173,6 +173,7 @@ class CustomVideoRender: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/CustomVideoSourceMediaIO/CustomVideoSourceMediaIO.swift b/macOS/APIExample/Examples/Advanced/CustomVideoSourceMediaIO/CustomVideoSourceMediaIO.swift
@@ -196,6 +196,7 @@ class CustomVideoSourceMediaIO: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/CustomVideoSourcePush/CustomVideoSourcePush.swift b/macOS/APIExample/Examples/Advanced/CustomVideoSourcePush/CustomVideoSourcePush.swift
@@ -179,6 +179,7 @@ class CustomVideoSourcePush: BaseViewController {
                 self.remoteVideos[0].uid = nil
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/JoinMultiChannel/JoinMultiChannel.swift b/macOS/APIExample/Examples/Advanced/JoinMultiChannel/JoinMultiChannel.swift
@@ -250,6 +250,7 @@ class JoinMultipleChannel: BaseViewController {
         channel1?.destroy()
         channel2?.leave()
         channel2?.destroy()
+        AgoraRtcEngineKit.destroy()
     }
 
     func getChannelByName(_ channelName: String?) -> AgoraRtcChannel? {
diff --git a/macOS/APIExample/Examples/Advanced/RTMPStreaming/RTMPStreaming.swift b/macOS/APIExample/Examples/Advanced/RTMPStreaming/RTMPStreaming.swift
@@ -149,6 +149,7 @@ class RTMPStreaming: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/RawAudioData/RawAudioData.swift b/macOS/APIExample/Examples/Advanced/RawAudioData/RawAudioData.swift
@@ -138,6 +138,7 @@ class RawAudioData: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/RawMediaData/RawMediaData.swift b/macOS/APIExample/Examples/Advanced/RawMediaData/RawMediaData.swift
@@ -184,6 +184,7 @@ class RawMediaData: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     func registerAgoraMediaDataPlugin() {
diff --git a/macOS/APIExample/Examples/Advanced/ScreenShare/ScreenShare.swift b/macOS/APIExample/Examples/Advanced/ScreenShare/ScreenShare.swift
@@ -355,6 +355,7 @@ class ScreenShare: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/StreamEncryption/StreamEncryption.swift b/macOS/APIExample/Examples/Advanced/StreamEncryption/StreamEncryption.swift
@@ -205,6 +205,7 @@ class StreamEncryption: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Advanced/VoiceChanger/VoiceChanger.swift b/macOS/APIExample/Examples/Advanced/VoiceChanger/VoiceChanger.swift
@@ -491,6 +491,7 @@ class VoiceChanger: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
     
     @IBAction func onJoinPressed(_ sender:Any) {
diff --git a/macOS/APIExample/Examples/Basic/JoinChannelVideo/JoinChannelVideo.swift b/macOS/APIExample/Examples/Basic/JoinChannelVideo/JoinChannelVideo.swift
@@ -371,6 +371,7 @@ class JoinChannelVideoMain: BaseViewController {
                 LogUtils.log(message: "Left channel", level: .info)
             }
         }
+        AgoraRtcEngineKit.destroy()
     }
 }
 
diff --git a/macOS/README.md b/macOS/README.md
@@ -0,0 +1,63 @@
+# API Example macOS
+
+*English | [中文](README.zh.md)*
+
+This project presents you a set of API examples to help you understand how to use Agora APIs.
+
+## Prerequisites
+
+- Xcode 10.0+
+
+## Quick Start
+
+This section shows you how to prepare, build, and run the sample application.
+
+### Prepare Dependencies
+
+Change directory into **macOS** folder, run following command to install project dependencies,
+
+```
+pod install
+```
+
+Verify `APIExample.xcworkspace` has been properly generated.
+
+### Obtain an App Id
+
+To build and run the sample application, get an App Id:
+
+1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the signup process, you will be redirected to the Dashboard.
+2. Navigate in the Dashboard tree on the left to **Projects** > **Project List**.
+3. Save the **App Id** from the Dashboard for later use.
+4. Generate a temp **Access Token** (valid for 24 hours) from dashboard page with given channel name, save for later use.
+
+5. Open `APIExample.xcworkspace` and edit the `KeyCenter.swift` file. In the `KeyCenter` struct, update `<#Your App Id#>` with your App Id, and change `<#Temp Access Token#>` with the temp Access Token generated from dashboard. Note you can leave the token variable `nil` if your project has not turned on security token.
+
+    ``` Swift
+    struct KeyCenter {
+        static let AppId: String = <#Your App Id#>
+        
+        // assign token to nil if you have not enabled app certificate
+        static var Token: String? = <#Temp Access Token#>
+    }
+    ```
+
+You are all set. Now connect your iPhone or iPad device and run the project.
+
+> To ensure communication security, Agora uses tokens (dynamic keys) to authenticate users joining a channel.
+>
+> Temporary tokens are for demonstration and testing purposes only and remain valid for 24 hours. In a production environment, you need to deploy your own server for generating tokens. See [Generate a Token](https://docs.agora.io/en/Interactive Broadcast/token_server)for details.
+
+## Contact Us
+
+- For potential issues, take a look at our [FAQ](https://docs.agora.io/en/faq) first
+- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials
+- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use case
+- Repositories managed by developer communities can be found at [Agora Community](https://github.com/AgoraIO-Community)
+- You can find full API documentation at [Document Center](https://docs.agora.io/en/)
+- If you encounter problems during integration, you can ask question in [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io)
+- You can file bugs about this sample at [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
+
+## License
+
+The MIT License (MIT)
diff --git a/macOS/README.zh.md b/macOS/README.zh.md
@@ -0,0 +1,61 @@
+# API Example macOS
+
+*[English](README.md) | 中文*
+
+这个开源示例项目演示了Agora视频SDK的部分API使用示例，以帮助开发者更好地理解和运用Agora视频SDK的API。
+
+## 环境准备
+
+- XCode 10.0 +
+
+## 运行示例程序
+
+这个段落主要讲解了如何编译和运行实例程序。
+
+### 安装依赖库
+
+切换到 **macOS** 目录，运行以下命令使用CocoaPods安装依赖，Agora视频SDK会在安装后自动完成集成。
+
+```
+pod install
+```
+
+运行后确认 `APIExample.xcworkspace` 正常生成即可。
+
+### 创建Agora账号并获取AppId
+
+在编译和启动实例程序前，你需要首先获取一个可用的App Id:
+
+1. 在[agora.io](https://dashboard.agora.io/signin/)创建一个开发者账号
+2. 前往后台页面，点击左部导航栏的 **项目 > 项目列表** 菜单
+3. 复制后台的 **App Id** 并备注，稍后启动应用时会用到它
+4. 在项目页面生成临时 **Access Token** (24小时内有效)并备注，注意生成的Token只能适用于对应的频道名。
+
+5. 打开 `APIExample.xcworkspace` 并编辑 `KeyCenter.swift`，将你的 AppID 和 Token 分别替换到 `<#Your App Id#>` 与 `<#Temp Access Token#>`
+
+    ```
+    let AppID: String = <#Your App Id#>
+    // 如果你没有打开Token功能，token可以直接给nil
+    let Token: String? = <#Temp Access Token#>
+    ```
+
+然后你就可以使用 `APIExample.xcworkspace` 编译并运行项目了。
+
+> 为提高项目的安全性，Agora 使用 Token（动态密钥）对即将加入频道的用户进行鉴权。
+>
+> 临时 Token 仅作为演示和测试用途。在生产环境中，你需要自行部署服务器签发 Token，详见[生成 Token](https://docs.agora.io/cn/Interactive Broadcast/token_server)。
+
+## 联系我们
+
+- 如果你遇到了困难，可以先参阅 [常见问题](https://docs.agora.io/cn/faq)
+- 如果你想了解更多官方示例，可以参考 [官方SDK示例](https://github.com/AgoraIO)
+- 如果你想了解声网SDK在复杂场景下的应用，可以参考 [官方场景案例](https://github.com/AgoraIO-usecase)
+- 如果你想了解声网的一些社区开发者维护的项目，可以查看 [社区](https://github.com/AgoraIO-Community)
+- 完整的 API 文档见 [文档中心](https://docs.agora.io/cn/)
+- 若遇到问题需要开发者帮助，你可以到 [开发者社区](https://rtcdeveloper.com/) 提问
+- 如果需要售后技术支持, 你可以在 [Agora Dashboard](https://dashboard.agora.io) 提交工单
+- 如果发现了示例代码的 bug，欢迎提交 [issue](https://github.com/AgoraIO/Basic-Video-Call/issues)
+
+## 代码许可
+
+The MIT License (MIT)
diff --git a/windows/README.md b/windows/README.md
@@ -30,7 +30,12 @@ To build and run the sample application, get an App ID:
     #AppID=xxxxxxxxxxxxxxxxxxx
     ```
 
+> To ensure communication security, Agora uses tokens (dynamic keys) to authenticate users joining a channel.
+>
+> Temporary tokens are for demonstration and testing purposes only and remain valid for 24 hours. In a production environment, you need to deploy your own server for generating tokens. See [Generate a Token](https://docs.agora.io/en/Interactive Broadcast/token_server)for details.
+
 ### Build the application
+
 **This open source sample project uses the Agora RTC SDK,DirectShow SDK, and MeidaPlayer SDK.**
 
 You can directly run `APIExample/installThirdParty.bat` to automatically environment configuration.Once the configuration is complete, open the project with VS2017, select the x86 version to compile and run.
diff --git a/windows/README.zh.md b/windows/README.zh.md
@@ -36,7 +36,12 @@
     AppID=xxxxxxxxxxxxxxxxxxx
     ```
 
+> 为提高项目的安全性，Agora 使用 Token（动态密钥）对即将加入频道的用户进行鉴权。
+>
+> 临时 Token 仅作为演示和测试用途。在生产环境中，你需要自行部署服务器签发 Token，详见[生成 Token](https://docs.agora.io/cn/Interactive Broadcast/token_server)。
+
 ### 编译项目
+
 **这个开源示例项目使用了Agora RTC SDK,DirectShow SDK,MeidaPlayer SDK。**
 
 你可以通过直接运行`APIExample/installThirdParty.bat`来自动进行依赖下载与环境配置。配置完成后使用vs2017打开项目，选择x86版本进行编译就可以运行了。 

Original file line number	Diff line number	Diff line change
`@@ -363,6 +363,7 @@ class AudioMixing: BaseViewController {`
`363`	`363`	`LogUtils.log(message: "Left channel", level: .info)`
`364`	`364`	`}`
`365`	`365`	`}`
	`366`	`+ AgoraRtcEngineKit.destroy()`
`366`	`367`	`}`
`367`	`368`
`368`	`369`	`@IBAction func onJoinPressed(_ sender:Any) {`
Original file line number	Diff line number	Diff line change
`@@ -117,6 +117,7 @@ class ChannelMediaRelay: BaseViewController {`
`117`	`117`	`LogUtils.log(message: "Left channel", level: .info)`
`118`	`118`	`}`
`119`	`119`	`}`
	`120`	`+ AgoraRtcEngineKit.destroy()`
`120`	`121`	`}`
`121`	`122`
`122`	`123`	`@IBAction func onJoinPressed(_ sender:Any) {`
Original file line number	Diff line number	Diff line change
`@@ -145,6 +145,7 @@ class CreateDataStream: BaseViewController {`
`145`	`145`	`LogUtils.log(message: "Left channel", level: .info)`
`146`	`146`	`}`
`147`	`147`	`}`
	`148`	`+ AgoraRtcEngineKit.destroy()`
`148`	`149`	`}`
`149`	`150`
`150`	`151`	`@IBAction func onJoinPressed(_ sender:Any) {`
Original file line number	Diff line number	Diff line change
`@@ -137,6 +137,7 @@ class CustomAudioRender: BaseViewController {`
`137`	`137`	`LogUtils.log(message: "Left channel", level: .info)`
`138`	`138`	`}`
`139`	`139`	`}`
	`140`	`+ AgoraRtcEngineKit.destroy()`
`140`	`141`	`}`
`141`	`142`
`142`	`143`	`@IBAction func onJoinPressed(_ sender:Any) {`
Original file line number	Diff line number	Diff line change
`@@ -136,6 +136,7 @@ class CustomAudioSource: BaseViewController {`
`136`	`136`	`LogUtils.log(message: "Left channel", level: .info)`
`137`	`137`	`}`
`138`	`138`	`}`
	`139`	`+ AgoraRtcEngineKit.destroy()`
`139`	`140`	`}`
`140`	`141`
`141`	`142`	`@IBAction func onJoinPressed(_ sender:Any) {`
Original file line number	Diff line number	Diff line change
`@@ -173,6 +173,7 @@ class CustomVideoRender: BaseViewController {`
`173`	`173`	`LogUtils.log(message: "Left channel", level: .info)`
`174`	`174`	`}`
`175`	`175`	`}`
	`176`	`+ AgoraRtcEngineKit.destroy()`
`176`	`177`	`}`
`177`	`178`
`178`	`179`	`@IBAction func onJoinPressed(_ sender:Any) {`
Original file line number	Diff line number	Diff line change
`@@ -196,6 +196,7 @@ class CustomVideoSourceMediaIO: BaseViewController {`
`196`	`196`	`LogUtils.log(message: "Left channel", level: .info)`
`197`	`197`	`}`
`198`	`198`	`}`
	`199`	`+ AgoraRtcEngineKit.destroy()`
`199`	`200`	`}`
`200`	`201`
`201`	`202`	`@IBAction func onJoinPressed(_ sender:Any) {`