Room.Option

cn.tee3.avd

## 枚举 Room.Option

- java.lang.Object
- - java.lang.Enum<Room.Option>
  - - cn.tee3.avd.Room.Option

- 所有已实现的接口:
    java.io.Serializable, java.lang.Comparable<Room.Option>
  封闭类:
    Room

      public static enum Room.Option
      extends java.lang.Enum<Room.Option>

  房间选项

- - ### 枚举常量概要

    枚举常量
    枚举常量和说明
    `ro_audio_auto_subscribe` < 值类型为uint32, 字符类型为"3000" or "5000" ：设置链接超时时间，单位毫秒，必须是正数，系统默认是5000毫秒。
    `ro_audio_drop_data` < 值类型为bool, 字符类型为"true" or "false"：表示接收到视频数据后不解码直接丢弃，一般用于模拟客服端做并发测试。
    `ro_audio_mixerdata_callback_buffered` < 值类型为string, 音频编码算法：字符类型为"isac" or "opus" or "pcmu"：分别表示isac语音编码 、 opus音乐编码、pcmu音乐编码；缺省为"isac"。
    `ro_audio_option_codec` < 值类型为bool, 字符类型为"true" or "false"：表示是否自动订阅音频,true 自动订阅，false 不自动订阅 默认为true
    `ro_media_use_dtls` < 值类型为bool, 字符类型为"true" or "false"：表示接收到音频数据后不解码直接丢弃，一般用于模拟客服端做并发测试。
    `ro_room_auto_rejoin` < 值类型为枚举CameraType, 字符类型为"front" or "back"：表示前后置摄像头模式时房间中默认使用的摄像头：前置(front)和后置（back）， 缺省为前置。
    `ro_room_connect_timeout` < 值类型为int32, 字符类型为"3" or "2"等数字字符：设置每次断线后重连次数。
    `ro_room_options_apply` < 值类型为int32, 单位为毫秒，字符类型为"60000"（60秒后超时不再重连） or "-1"（一直重连）等数字字符：设置断线重连失败后自动重连超时时间，在启用ro_room_auto_rejoin为true后有效。
    `ro_room_reconnect_times` < 值类型为bool, 字符类型为"true" or "false"：表示音视频是否启用DTLS加密，DTLS加密数据更加安全，但是会加重Server 的负担，在UDP丢包严重的网络环境下，媒体链接需要的时间会更多（30%丢包，链接时间10s-40s）。
    `ro_room_rejoin_times` < 值类型为int32, 字符类型为"true" or "false"：在重连失败之后是否尝试自动重新加入房间，系统默认为true。
    `ro_video_default_camera` < 值类型为bool, 字符类型为"true" or "false"：表示房间中混音数据回调是否缓冲为1024sample后回调：缓冲(true)和不缓冲（false）， 缺省为缓冲。
    `ro_video_drop_data`
    `ro_video_mixerdata_callback_format` < 值类型为String, 房间中各种选项（根据字符枚举）立即应用。

  - ### 方法概要

    所有方法 静态方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `static Room.Option` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
    `static Room.Option[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

    - ### 从类继承的方法 java.lang.Enum

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

    - ### 从类继承的方法 java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### 枚举常量详细资料

    - #### ro_video_drop_data

          public static final Room.Option ro_video_drop_data

    - #### ro_audio_drop_data

          public static final Room.Option ro_audio_drop_data

      < 值类型为bool, 字符类型为"true" or "false"：表示接收到视频数据后不解码直接丢弃，一般用于模拟客服端做并发测试。 默认值为false，设置为true后将丢弃该房间所有接收到的视频数据。 必须在join调用之前设置才有效。

    - #### ro_media_use_dtls

          public static final Room.Option ro_media_use_dtls

      < 值类型为bool, 字符类型为"true" or "false"：表示接收到音频数据后不解码直接丢弃，一般用于模拟客服端做并发测试。 默认值为false，设置为true后将丢弃该房间所有接收到的音频数据。 必须在join调用之前设置才有效。

    - #### ro_room_reconnect_times

          public static final Room.Option ro_room_reconnect_times

      < 值类型为bool, 字符类型为"true" or "false"：表示音视频是否启用DTLS加密，DTLS加密数据更加安全，但是会加重Server 的负担，在UDP丢包严重的网络环境下，媒体链接需要的时间会更多（30%丢包，链接时间10s-40s）。 默认值为true，使用的是DTLS加密方式。 必须在join调用之前设置才有效。

    - #### ro_room_connect_timeout

          public static final Room.Option ro_room_connect_timeout

      < 值类型为int32, 字符类型为"3" or "2"等数字字符：设置每次断线后重连次数。系统默认为重连3次，如需改变需要应用层自己设置。 在join之前或者之后设置都有效。

    - #### ro_audio_auto_subscribe

          public static final Room.Option ro_audio_auto_subscribe

      < 值类型为uint32, 字符类型为"3000" or "5000" ：设置链接超时时间，单位毫秒，必须是正数，系统默认是5000毫秒。 在join之前或者之后设置都有效。

    - #### ro_audio_option_codec

          public static final Room.Option ro_audio_option_codec

      < 值类型为bool, 字符类型为"true" or "false"：表示是否自动订阅音频,true 自动订阅，false 不自动订阅 默认为true

    - #### ro_audio_mixerdata_callback_buffered

          public static final Room.Option ro_audio_mixerdata_callback_buffered

      < 值类型为string, 音频编码算法：字符类型为"isac" or "opus" or "pcmu"：分别表示isac语音编码 、 opus音乐编码、pcmu音乐编码；缺省为"isac"。 必须在join调用之前设置才有效。

    - #### ro_video_default_camera

          public static final Room.Option ro_video_default_camera

      < 值类型为bool, 字符类型为"true" or "false"：表示房间中混音数据回调是否缓冲为1024sample后回调：缓冲(true)和不缓冲（false）， 缺省为缓冲。 在join之前或者之后设置都有效。

    - #### ro_room_auto_rejoin

          public static final Room.Option ro_room_auto_rejoin

      < 值类型为枚举CameraType, 字符类型为"front" or "back"：表示前后置摄像头模式时房间中默认使用的摄像头：前置(front)和后置（back）， 缺省为前置。 必须在join调用之前设置才有效。

    - #### ro_room_rejoin_times

          public static final Room.Option ro_room_rejoin_times

      < 值类型为int32, 字符类型为"true" or "false"：在重连失败之后是否尝试自动重新加入房间，系统默认为true。 在join之前或者之后设置都有效。

    - #### ro_room_options_apply

          public static final Room.Option ro_room_options_apply

      < 值类型为int32, 单位为毫秒，字符类型为"60000"（60秒后超时不再重连） or "-1"（一直重连）等数字字符：设置断线重连失败后自动重连超时时间，在启用ro_room_auto_rejoin为true后有效。 系统默认为服务器返回时间，此时间可在后台配置，如果都失败将通过onConnectionStatus接口返回cs_connectFailed状态。在join之前或者之后设置都有效。

    - #### ro_video_mixerdata_callback_format

          public static final Room.Option ro_video_mixerdata_callback_format

      < 值类型为String, 房间中各种选项（根据字符枚举）立即应用。当前字符枚举有："audio_options"：Engine中设置的音频选项应用如aec，agc等。

  - ### 方法详细资料

    - #### values

          public static Room.Option[] values()

      按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

          for (Room.Option c : Room.Option.values())
              System.out.println(c);

      返回:
        按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

    - #### valueOf

          public static Room.Option valueOf(java.lang.String name)

      返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)
      参数:
        `name` - 要返回的枚举常量的名称。
      返回:
        返回带有指定名称的枚举常量
      抛出:
        `java.lang.IllegalArgumentException` - 如果该枚举类型没有带有指定名称的常量
        `java.lang.NullPointerException` - 如果参数为空值