RoomKit
  • iOS : Objective-C
  • Android
  • macOS
  • Windows
  • Web
  • 小程序
  • Flutter
  • React Native
  • 产品简介
    • 概述
    • 发布日志
  • 开通 RoomKit 服务
  • 下载
  • 体验 App
  • 快速开始
  • 进阶功能
  • 客户端 API
  • 服务端 API
  • 常见错误码
  • 常见问题
  • 文档中心
  • RoomKit
  • 进阶功能
  • 自定义房间参数

自定义房间参数

更新时间:2022-11-17 11:41

1 功能简介

为了方便针对房间内的一些展示信息和功能模块进行个性化设置,我们提供了自定义房间参数接口,通过该接口,您可以自定义房间标题,主持人昵称,房间开始时间等。

2 前提条件

在实现自定义房间参数之前,请确保已在项目中集成 RoomKit SDK,详情请参考 集成

3 使用步骤

  1. 配置类 ZegoRoomParameter 负责管理房间内的可配置参数,您可以通过使用该类自定义房间参数。房间可配置参数如下:

    属性 描述
    subject 房间主题,会在房间名和房间详情中显示。
    hostNickname 主持人昵称,会在房间详情中显示。
    beginTimestamp 房间开始时间,会在房间开始倒计时中使用,0 代表不显示倒计时。
    streamEncryptKey 流加解密密钥,会在流传输加解密中使用,需要流加密传输时使用,只支持 RTC 场景。
  2. 调用 setRoomParameter 方法设置配置参数。

    • 自定义房间参数需要在加入房间前配置。
    • 设置参数前需要先初始化房间参数配置类。

    ZegoRoomParameter 的类定义:

    @interface ZegoRoomParameter : NSObject
    
    /// 房间主题
    @property (nonatomic, copy) NSString *subject;
    
    /// 主持人昵称
    @property (nonatomic, copy) NSString *hostNickname;
    
    /// 房间开始时间戳
    @property (nonatomic, assign) NSInteger beginTimestamp;
    
    /// 持续时长
    @property (nonatomic, assign) NSInteger duration;
    
    /// 流加解密密钥。不加密则不设置
    @property (nonatomic, copy) NSString *streamEncryptKey;
    
    @end
    

    ZegoRoomParameter 的初始化与设置:

    // 初始化配置参数类
    ZegoRoomParameter *roomParam = [ZegoRoomParameter new];
    
    roomParam.subject = @"subject"; // 房间名称
    roomParam.beginTimestamp = 123456789; // 房间开始时间戳
    roomParam.duration = 30;  // 房间持续时长
    roomParam.hostNickname = @"hostName"; // 主持人昵称
    
    // 设置房间自定义参数
    [[ZegoRoomKit sharedInstance].inRoomService setRoomParameter:roomParam];
本篇目录