Skip to content

Commit 030cae7

Browse files
author
Tate Min
committed
更新RADME文件
1 parent c3bf8c4 commit 030cae7

File tree

4 files changed

+14
-9
lines changed

4 files changed

+14
-9
lines changed

Android/MLVB-API-Example/README.en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ You have [signed up for a Tencent Cloud account](https://intl.cloud.tencent.com/
5252
- `SECRETKEY`: left empty by default. Set it to the actual key.
5353
- `LICENSEURL`: a placeholder by default. Set it to the actual license URL.
5454
- `LICENSEURLKEY`: a placeholder by default. Set it to the actual license key.
55-
4. Find and open `MLVB-API-Example/Debug/src/main/java/com/tencent/mlvb/debug/AddressUtils.java`.
56-
5. Set parameters in `AddressUtils.java` as follows:
55+
4. Find and open `MLVB-API-Example/Debug/src/main/java/com/tencent/mlvb/debug/GenerateTestUserSig.java`.
56+
5. Set parameters in `GenerateTestUserSig.java` as follows:
5757
- `PUSH_DOMAIN`: set it to the configured publishing URL.
5858
- `PLAY_DOMAIN`: set it to the configured playback URL.
59-
- `KEY`: set it to the authentication key (if authentication configuration is enabled).
59+
- `LIVE_URL_KEY`: set it to the authentication key (if authentication configuration is enabled).
6060

6161
### Integrating the SDK
6262
You can use JCenter for automatic loading or manually download the AAR file and import it to your project. The demo uses the first method by default.

Android/MLVB-API-Example/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,12 @@ _中文 | [English](README.en.md)_
5252
- `SECRETKEY`:默认为空字符串,请设置为实际的密钥信息;
5353
- `LICENSEURL`:默认为 PLACEHOLDER ,请设置为实际的License Url信息;
5454
- `LICENSEURLKEY`:默认为 PLACEHOLDER ,请设置为实际的License Key信息;
55-
4. 找到并打开`MLVB-API-Example/Debug/src/main/java/com/tencent/mlvb/debug/AddressUtils.java`文件。
56-
5. 设置`AddressUtils.java`文件中的相关参数:
55+
4. 找到并打开`MLVB-API-Example/Debug/src/main/java/com/tencent/mlvb/debug/GenerateTestUserSig.java`文件。
56+
5. 设置`GenerateTestUserSig.java`文件中的相关参数:
5757
- `PUSH_DOMAIN`:配置的推流地址
5858
- `PLAY_DOMAIN`:配置的拉流地址
59-
- `KEY`:如果开通鉴权配置的鉴权Key
59+
- `LIVE_URL_KEY`:非必需,用于生成 txSecret 等鉴权信息.
60+
<img src="https://qcloudimg.tencent-cloud.cn/raw/bb4e9ea8e62489ec908c51bfa0a0132b.png" width=600px>
6061

6162
### 集成 SDK
6263
您可以选择使用 JCenter 自动加载的方式,或者手动下载 aar 再将其导入到您当前的工程项目中,Demo默认采用方法一配置。

iOS/MLVB-API-Example-OC/README.en.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ You have [signed up for a Tencent Cloud account](https://intl.cloud.tencent.com/
4848
- `SECRETKEY`: set it to the secret key obtained in the previous step.
4949
- `LICENSEURL`: a placeholder by default. Set it to the actual license URL.
5050
- `LICENSEURLKEY`: a placeholder by default. Set it to the actual license key.
51-
- `URLKEY`: set it to the authentication key (if authentication configuration is enabled).
51+
- `PUSH_DOMAIN`: set it to the configured publishing URL.
52+
- `PLAY_DOMAIN`: set it to the configured playback URL.
53+
- `LIVE_URL_KEY`: set it to the authentication key (if authentication configuration is enabled).
5254

5355
>!The method for generating `UserSig` described in this document involves configuring `SECRETKEY` in client code. In this method, `SECRETKEY` may be easily decompiled and reversed, and if your key is disclosed, attackers can steal your Tencent Cloud traffic. Therefore, **this method is suitable only for the local execution and debugging of the demo**.
5456
>The correct `UserSig` distribution method is to integrate the calculation code of `UserSig` into your server and provide an application-oriented API. When `UserSig` is needed, your application can send a request to the business server for a dynamic `UserSig`. For more information, please see [How do I calculate UserSig on the server?](https://cloud.tencent.com/document/product/647/17275#Server).

iOS/MLVB-API-Example-OC/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,10 @@
4848
- SECRETKEY:替换该变量值为上一步骤中在页面上看到的密钥。
4949
- LICENSEURL:默认为 PLACEHOLDER ,请设置为实际的License Url信息;
5050
- LICENSEURLKEY:默认为 PLACEHOLDER ,请设置为实际的License Key信息;
51-
- URLKEY: 如果开通鉴权配置的鉴权Key
52-
51+
- PUSH_DOMAIN 中推流地址请设置为您的推流域名的 `CNAME`
52+
- PLAY_DOMAIN 中拉流地址请设置为您的播放域名的 `CNAME`
53+
- LIVE_URL_KEY:非必需,用于生成 txSecret 等鉴权信息。
54+
5355
>!本文提到的生成 UserSig 的方案是在客户端代码中配置 SECRETKEY,该方法中 SECRETKEY 很容易被反编译逆向破解,一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量,因此**该方法仅适合本地跑通 Demo 和功能调试**
5456
>正确的 UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端,并提供面向 App 的接口,在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig。更多详情请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/647/17275#Server)
5557

0 commit comments

Comments
 (0)