agora_iot_device_manager.h
引用文件
无
函数
agora_iot_register_and_bind
C
int agora_iot_register_and_bind(const char *host_url, const char *product_key, const char *device_id,
const char *user_id, const char *device_nickname, agora_iot_device_info_t *info);
注册设备并将设备与用户绑定。
参数
| 参数 | 描述 |
|---|---|
[in] host_url | SDK 使用的 AWS OpenAPI 服务的主机域名。你可以在声网灵隼控制台的应用配置>>开发者选项>>呼叫服务>>Master Server URL 处获取。详见开通并配置声网灵隼服务。 |
[in] product_key | 你的 Product Key。可以从声网灵隼控制台的应用配置页面的开发者选项选项卡中获取。详见开通并配置声网灵隼服务。 |
[in] device_id | 你的设备 ID。你需要自行设置。每个设备的设备 ID 必须是唯一的。长度为 1 ~ 128 个字符。字符集支持：
设备 ID 与 License 绑定。参考开通并配置声网灵隼服务获取免费或商业 License。 |
[in] user_id | 你的用户 ID。 |
[in] device_nickname | 设备昵称。客户端 SDK 的设备绑定列表会显示该昵称。你可以任意指定，通常建议与产品名称一致（请使用 UTF-8 编码设置中文名称）。如果使用了绑定功能，该名称将显示在客户端。你也可以在客户端为设备重新命名。 |
[out] info | 注册绑定完成后返回的设备信息。详见 agora_iot_device_info_t。 |
返回
- 0：方法调用成功。
- < 0：方法调用失败。
agora_iot_query_user
C
int agora_iot_query_user(const char *host_url, const char *product_key, const char *device_id, char *user_id);
参数
| 参数 | 描述 |
|---|---|
[in] host_url | SDK 使用的 AWS OpenAPI 服务的主机域名。你可以在声网灵隼控制台的应用配置>>开发者选项>>呼叫服务>>Master Server URL 处获取。详见开通并配置声网灵隼服务。 |
[in] product_key | 你的 Product Key。可以从声网灵隼控制台的应用配置页面的开发者选项选项卡中获取。详见开通并配置声网灵隼服务。 |
[in] device_id | 你的设备 ID。你需要自行设置。每个设备的设备 ID 必须是唯一的。长度为 1 ~ 128 个字符。字符集支持：
设备 ID 与 License 绑定。参考 开通并配置声网灵隼服务获取免费或商业 License。 |
[out] user_id | 与设备绑定的的用户 ID。 |
查询设备绑定的用户。
返回
- 0：方法调用成功。
- < 0：方法调用失败。
agora_iot_license_activate
C
int agora_iot_license_activate(const char *appid, const char *key, const char *secret,
const char *product_key, const char *device_id, const char *pid, char **cert);
激活 License 并生成证书。每次激活将消耗一个 License 额度。
参数
| 参数 | 描述 |
|---|---|
[in] appid | 你的声网 App ID。可以从声网灵隼控制台的应用配置页面的开发者选项选项卡中获取。详见开通并配置声网灵隼服务。 |
[in] key | 你的 Restful API Customer ID。可以从声网灵隼控制台的应用配置页面的开发者选项选项卡中获取。详见开通并配置声网灵隼服务。 |
[in] secret | 你的 Restful API Customer Secret。可以从声网灵隼控制台的应用配置页面的开发者选项选项卡中获取。详见开通并配置声网灵隼服务。 |
[in] product_key | 你的 Product Key。可以从声网灵隼控制台的应用配置页面的开发者选项选项卡中获取。详见 开通并配置声网灵隼服务。 |
[in] device_id | 你的设备 ID。你需要自行设置。每个设备的设备 ID 必须是唯一的。长度为 1 ~ 128 个字符。字符集支持：
设备 ID 与 License 绑定。参考开通并配置声网灵隼服务获取免费或商业 License。 |
[in] pid | 你的 PID。可以从声网灵隼控制台的用量查看页面中获取。 |
[out] cert | 激活成功后生成的证书。License 激活成功后，接口将返回获取到的 License 检验证书，用于 SDK 初始化的授权凭证，你需要保存证书到配置文件或 Flash 中，下次运行时从文件或 Flash 中获取证书。 |
返回
- 0：方法调用成功。
- < 0：方法调用失败。
常量
AGORA_IOT_CERTIFICATE_MAX_LEN
C
#define AGORA_IOT_CERTIFICATE_MAX_LEN 2048
证书最大长度。
AGORA_IOT_PRIVATE_KEY_MAX_LEN
C
#define AGORA_IOT_PRIVATE_KEY_MAX_LEN 2048
私钥最大长度。
AGORA_IOT_DOMAIN_MAX_LEN
C
#define AGORA_IOT_DOMAIN_MAX_LEN 256
域名最大长度。
类型定义
agora_iot_device_info_t
C
typedef struct agora_iot_device_info {
char certificate[AGORA_IOT_CERTIFICATE_MAX_LEN];
char private_key[AGORA_IOT_PRIVATE_KEY_MAX_LEN];
char domain[AGORA_IOT_DOMAIN_MAX_LEN];
char client_id[AGORA_IOT_CLIENT_ID_MAX_LEN];
} agora_iot_device_info_t;
设备信息。
| 参数 | 描述 |
|---|---|
certificate[AGORA_IOT_CERTIFICATE_MAX_LEN] | 设备证书。 |
private_key[AGORA_IOT_PRIVATE_KEY_MAX_LEN] | 设备私钥。 |
domain[AGORA_IOT_DOMAIN_MAX_LEN] | 域名。 |
client_id[AGORA_IOT_CLIENT_ID_MAX_LEN] | Client ID。用于呼叫。 |