P2P连线接口
KY_Connect
- 功能描述:
- 连接设备并解码出图。
接口定义
- (void)KY_Connect:(NSString * _Nonnull)uid
authKey:(NSString * _Nonnull)authKey
authType:(AvAuthType)authType
password:(NSString * _Nonnull)password
channel:(NSInteger)channel
isDecode:(BOOL)isDecode
renderType:(RENDERTYPE)renderType;
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| uid | string | 设备唯一标识符 (UID) |
| authKey | string | 用于 AuthKey 方式认证的密钥。 |
| authType | AvAuthType | 认证类型枚举(例如,密码认证或 AuthKey 认证)。 |
| password | string | 设备访问密码(当 authType 为密码认证时使用)。 |
| channel | int | 要开启并出图的通道号,默认值为 0。 |
| isDecode | boolean | 是否进行解码并渲染画面,默认为 true。 |
| renderType | RENDERTYPE | 指定渲染输出的数据类型。参考 RENDERTYPE 枚举 定义。 |
RENDERTYPE 枚举
| 枚举值 | 说明 |
|---|---|
OUTPUT_EMPTY (0) | 仅接收、解码、渲染视频流,不对外输出原始数据。 |
OUTPUT_YUV (1) | 接收、解码、渲染,并输出 I420 格式的 YUV 数据(此操作会消耗额外性能)。 |
OUTPUT_RGB_8888 (2) | 接收、解码、渲染,并输出 RGB_8888 格式的数据(此操作会消耗额外性能)。 |
OUTPUT_RGB_565 (3) | 接收、解码、渲染,并输出 RGB_565 格式的数据(此操作会消耗额外性能)。 |
OUTPUT_YUV_NV12 (4) | 接收、解码、渲染,并输出 NV12 格式的 YUV 数据(此操作会消耗额外性能)。 |
回调说明
连接状态和结果通常通过设置 delegate 并实现相应的回调方法来获取(例如,KY_DeviceStatus)。
返回码
详细的返回码会在 delegate 的回调方法中提供。
代码示例
// 假设 self.camera 是一个已经初始化的 KYCamera 实例
// self.uid, self.pwd, _mainChannel, self.isAuthToken, self.authKey 已提前设置
[self.camera KY_Connect:self.uid
authKey:self.authKey
authType:(self.isAuthToken ? AvAuthTypeAuthKey : AvAuthTypePassword)
password:self.pwd
channel:_mainChannel
isDecode:YES
renderType:OUTPUT_YUV];
KY_Disconnect
- 功能描述:
- 断开指定通道的连接,并停止该通道的音视频功能。
接口定义
- (void)KY_Disconnect:(NSInteger)channel;
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| channel | int | 要断开连接的通道号,通常为 0。 |
回调说明
断开状态通常通过设置 delegate 并实现 KY_DeviceStatus 回调方法来获取。
返回码
无。
代码示例
[self.camera KY_Disconnect:_mainChannel];
KY_DisconnectAll
- 功能描述:
- 停止并断开与该设备的所有通道连接。
接口定义
- (void)KY_DisconnectAll;
参数说明
无。
回调说明
断开状态通常通过设置 delegate 并实现 KY_DeviceStatus 回调方法来获取。
返回码
无。
代码示例
[self.camera KY_DisconnectAll];
