WhitePlayerConfig.h 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. //
  2. // WhitePlayerConfig.h
  3. // WhiteSDK
  4. //
  5. // Created by yleaf on 2019/3/1.
  6. //
  7. #import "WhiteObject.h"
  8. #import "WhiteConsts.h"
  9. #import "WhiteCameraBound.h"
  10. #import "WhiteWindowParams.h"
  11. NS_ASSUME_NONNULL_BEGIN
  12. /** 用于配置白板回放房间对象。 */
  13. @interface WhitePlayerConfig : WhiteObject
  14. - (instancetype)init NS_UNAVAILABLE;
  15. /**
  16. 设置 Room Token 并初始化 `WhitePlayerConfig` 对象。
  17. @param roomUuid 房间 UUID,即房间唯一标识符。
  18. @param roomToken 用于鉴权的 Room Token。
  19. @return 初始化的 `WhitePlayerConfig` 对象
  20. */
  21. - (instancetype)initWithRoom:(NSString *)roomUuid roomToken:(NSString *)roomToken;
  22. /**
  23. 待回放的互动白板房间所在的数据中心。
  24. 数据中心包括:
  25. - `"cn-hz"`:中国大陆
  26. - `"us-sv"`:美国
  27. - `"in-mum"`:印度
  28. - `"sg"`:新加坡
  29. - `"gb-lon"`:英国
  30. @since 2.11.0 */
  31. @property (nonatomic, strong, nullable) WhiteRegionKey region;
  32. /** 房间 UUID,即房间唯一标识符。 */
  33. @property (nonatomic, copy) NSString *room;
  34. /** 用于鉴权的 Room Token。 */
  35. @property (nonatomic, copy) NSString *roomToken;
  36. @property (nonatomic, copy, nullable) NSString *slice;
  37. /** 白板回放的起始时间。
  38. Unix 时间戳(秒),表示回放的起始 UTC 时间。例如,`1615370614` 表示 2021-03-10 18:03:34 GMT+0800。 */
  39. @property (nonatomic, strong, nullable) NSNumber *beginTimestamp;
  40. /** 白板回放的持续时长(秒)。如果没有设置,回放会从起始时间一直持续到退出房间。 */
  41. @property (nonatomic, strong, nullable) NSNumber *duration;
  42. /** 白板回放的音频地址。
  43. **Note:**
  44. - 即使传入视频地址,也只会播放音频部分。
  45. - 如需显示视频画面,请使用 [WhiteCombinePlayer](WhiteCombinePlayer) 方法。
  46. */
  47. @property (nonatomic, strong, nullable) NSString *mediaURL;
  48. /**
  49. SDK 回调播放进度的频率(秒)。默认为 0.5 秒。
  50. */
  51. @property (nonatomic, strong) NSNumber *step;
  52. /** 视角边界,详见 [WhiteCameraBound](WhiteCameraBound)。 */
  53. @property (nonatomic, strong, nullable) WhiteCameraBound *cameraBound;
  54. @end
  55. @interface WhitePlayerConfig (Deprecated)
  56. /**
  57. 已废弃,请使用 [mediaURL](mediaURL)。
  58. */
  59. @property (nonatomic, strong, nullable) NSString *audioUrl DEPRECATED_MSG_ATTRIBUTE("use mediaURL property");
  60. /** 多窗口用的本地参数,只影响本地客户 */
  61. @property (nonatomic, strong, nullable) WhiteWindowParams *windowParams;
  62. @end
  63. NS_ASSUME_NONNULL_END