自定义房间属性
RCRTCRoom 类提供在音视频房间属性扩展功能。在音视频房间中,可以设置、获取和删除扩展属性。
设置房间属性
使用 setAttribute
设置房间属性。
[self.room setAttribute:[info toJsonString]
forKey:@"属性 Key 值"
message:message
completion:^(BOOL isSuccess, RCRTCCode code) {
}];
参数 | 类型 | 说明 |
---|---|---|
attributeValue | NSString | 属性值 |
key | NSString | 属性名称 |
message | RCMessageContent | 是否在设置属性的时候携带消息内容,传空则不往房间中发送消息,可以通过自定义消息通知其他端有新属性已经设置 |
completion | RCRTCOperationCallback | 设置完成回调 block |
获取房间属性
[self.room getAttributes:{@"属性 Key 值"}
completion:^(BOOL isSuccess, RCRTCCode code, NSDictionary * _Nullable attr) {
}];
参数 | 类型 | 说明 |
---|---|---|
attributeKeys | NSArray | 属性 Key 值列表 |
completion | RCRTCAttributeOperationCallback | 查询结果的回调 block |
删除属性
[self.room deleteAttributes:@[@" Key 值"]
message:deleteMessage
completion:^(BOOL isSuccess, RCRTCCode code) {
}];
参数 | 类型 | 说明 |
---|---|---|
attributeKeys | NSArray | 属性 Key 值列表 |
message | RCMessageContent | 是否在设置属性的时候携带消息内容,传空则不往房间中发送消息 |
completion | RCRTCOperationCallback | 删除完成回调 block |
属性变化回调
在设置和删除自定义房间属性时,房间内的其他用户在通过 RCRTCRoomEventDelegate 下面的代理方法,回调接收自定义的房间属性消息 RCMessage。
- (void)didReceiveMessage:(RCMessage *)message;
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
message | RCMessage | 接收到其他人发送到 room 里的消息体,参考 IMLib 中 RCMessage |