# Global

##

### Members

#### annoSelectTypeEnum :number

Description:

  - 注释选择类别

##### Properties:

Name | Type | Description
--- | --- | ---
`mouse` | number |
`draw` | number |
`eraser` | number |

注释选择类别

##### Type:

- number

#### AnnotationInitTypeEnum :String

Description:

  - 批注层初始化类型枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`proportional` | String | 按比例缩放，推荐外部容器为div，此模式下SDK会根据外部容器元素宽高计算渲染的白板宽高，渲染的远端白板可以保持比例，不会造成画笔或者背景图的形变；SDK会自动创建背景层，无需应用层自动创建，SDK会自动更新背景图和背景色及下载白板时可以带背景层下载
`full` | String | 平铺，外部容器可以为div也可以直接传入canvas，此模式下白板会撑满容器的宽高，可能会和远端白板比例不一致，造成画笔或者背景图的形变

批注层初始化类型枚举

##### Type:

- String

#### appDataKeyEnum :String

Description:

  - 房间级别的AppData中KEY枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`lecturer` | String |
`voiceActivated` | String |

房间级别的AppData中KEY枚举

##### Type:

- String

#### (readonly) Appender :number

Description:

  - 日志显示方式枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`alert` | number | 使用alert语句显示日志
`inpage` | number | 内嵌到页面显示日志
`popup` | number | 弹出对话框显示日志
`browserConsole` | number | 浏览器控制台显示日志

日志显示方式枚举

##### Type:

- number

#### arrowTypeEnum :number

Description:

  - 箭头类别

##### Properties:

Name | Type | Description
--- | --- | ---
`none` | number |
`begin` | number |
`end` | number |
`double` | number |

箭头类别

##### Type:

- number

#### AudioCodingType :number

Description:

  - 音频编码格式枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`ISAC_16k` | number |
`ISAC_32k` | number |
`opus` | number |
`G722` | number |
`PCMA` | number |
`PCMU` | number |

音频编码格式枚举

##### Type:

- number

#### boardStatusEnum :number

Description:

  - 注释选择类别

##### Properties:

Name | Type | Description
--- | --- | ---
`close` | number |
`open` | number |

注释选择类别

##### Type:

- number

#### CameraType :number

Description:

  - 摄像头前后置枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`unknown` | number | 未知
`front` | number | 前置
`back` | number | 后置

摄像头前后置枚举

##### Type:

- number

#### canvasTypeEnum :number

Description:

  - 注释形状类别

##### Properties:

Name | Type | Description
--- | --- | ---
`mouse` | number |
`line` | number |
`rect` | number |
`ellipse` | number |
`polyline` | number |
`hlight_point` | number |
`hlight_texttag` | number |
`eraser` | number |
`rhomb` | number |
`arrow` | number |
`success` | number |
`failure` | number |
`clear` | number |

注释形状类别

##### Type:

- number

#### changeTypeEnum :number

Description:

  - 引擎级别设备变化事件类型枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`remove` | number |
`add` | number |

引擎级别设备变化事件类型枚举

##### Type:

- number

#### connectionEventTypeEnum :number

Description:

  - 箭头类别

##### Properties:

Name | Type | Description
--- | --- | ---
`sendVideo` | number |
`recvVideo` | number |
`sendAudio` | number |
`recvAudio` | number |
`conndidate` | number |

箭头类别

##### Type:

- number

#### ConnectionStatus :number

Description:

  - 网络状态枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`init` | number | 初始状态
`connecting` | number | 连接中
`connected` | number | 连接成功
`connectFailed` | number | 连接失败
`reJoinRoomTimeOut` | number | 重新加会超时
`reJoinConnected` | number | 重新加会成功
`reconnected` | number | 重连成功

网络状态枚举

##### Type:

- number

#### DataCryptoType :number

Description:

  - 数据加密类型枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`AES128` | number |
`AES256` | number |
`SM4` | number |

数据加密类型枚举

##### Type:

- number

#### (constant) ErrorConstant :Object

Description:

  - 错误码及说明

错误码及说明

##### Type:

- Object

#### exporterStatusEnum :number

Description:

  - 录制状态枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`stop` | number |
`live` | number |
`pause` | number |

录制状态枚举

##### Type:

- number

#### exporterTypeEnum :number

Description:

  - 创建流导出类型枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`record` | number |
`record_real_time` | number |
`liver` | number |
`avc_media_mixer` | number |

创建流导出类型枚举

##### Type:

- number

#### fillTypeEnum :number

Description:

  - 填充类别

##### Properties:

Name | Type | Description
--- | --- | ---
`none` | number |
`full` | number |

填充类别

##### Type:

- number

#### LiveEnum :number

Description:

  - 直播的各种类型枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`VideoType` | number |
`AudioType` | number |

直播的各种类型枚举

##### Type:

- number

#### (readonly) LogLevel :number

Description:

  - 日志显示级别枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`all` | number |
`trace` | number |
`debug` | number |
`info` | number |
`warn` | number |
`error` | number |
`fatal` | number |
`off` | number |

日志显示级别枚举

##### Type:

- number

#### (readonly) ModulesEnum :String

Description:

  - 模块枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`avdEngine` | String | 引擎模块
`browserDetect` | String | 浏览器检测模块
`video` | String | 视频模块
`audio` | String | 音频模块
`error` | String | 错误处理模块
`annotation` | String | 批注模块
`client` | String | 信令模块

模块枚举

##### Type:

- String

#### OperType :number

Description:

  - 操作类型枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`add` | number |
`remove` | number |
`update` | number |
`share` | number |
`close` | number |

操作类型枚举

##### Type:

- number

#### RecordEnum :number

Description:

  - 录制各种类型枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`VideoType` | number |
`AudioType` | number |
`FileType` | number |

录制各种类型枚举

##### Type:

- number

#### recorderAudioEnum :string

Description:

  - 录制声音枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`AVD_userId_allUser` | string | 所有用户
`AVD_userId_allUserWithoutMe` | string | 除自己外的所有用户
`AVD_userId_noneUser` | string | 没有用户

录制声音枚举

##### Type:

- string

#### Resolution :Object

Description:

  - 分辨率枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`"1920*1280"` | Object |
`"1920*1080"` | Object |
`"1280*1024"` | Object |
`"1280*720"` | Object |
`"960*720"` | Object |
`"640*1024"` | Object |
`"640*960"` | Object |
`"640*480"` | Object |
`"640*360"` | Object |
`"508*360"` | Object |
`"480*854"` | Object |
`"480*800"` | Object |
`"320*480"` | Object |
`"320*240"` | Object |
`"320*180"` | Object |
`"160*120"` | Object |

分辨率枚举

##### Type:

- Object

#### ResolutionSetType :number

Description:

  - 分辨率设置类型枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`exact` | number | 强制
`ideal` | number | 期望，摄像头不支持，可以向下兼容

分辨率设置类型枚举

##### Type:

- number

#### RoomCallback :String

Description:

  - 房间级别callback枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`connection_status` | String |
`connection_indicator` | String |
`room_status_notify` | String |
`app_data_notify` | String |
`user_data_notify` | String |
`user_name_notify` | String |
`public_data` | String |
`private_data` | String |
`private_data_to_user` | String |
`public_message` | String |
`private_message` | String |
`user_join_notify` | String |
`user_leave_notify` | String |
`leave_indication` | String |
`close_room_result` | String |
`close_room_notify` | String |
`screen_sharing_ended` | String |
`mcu_peerconnection_completed` | String |
`outgoing_invite_status_notify` | String |
`room_control_change_notify` | String |
`mediaplay_started_notify` | String |
`mediaplay_stoped_notify` | String |
`mediaplay_progress_notify` | String |
`stream_keep_alive_timeout_notify` | String |

房间级别callback枚举

##### Type:

- String

#### RoomStateEnum :String

Description:

  - 房间状态

##### Properties:

Name | Type | Description
--- | --- | ---
`DISCONNECTED` | String |
`CONNECTING` | String |
`CONNECTED` | String |
`RECONNECTING` | String |
`DISCONNECTING` | String |

房间状态

##### Type:

- String

#### RoomStatus :number

Description:

  - 房间状态枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`scheduled` | number |
`opening` | number |
`locked` | number |
`closed` | number |

房间状态枚举

##### Type:

- number

#### RoomTypeEnum :String

Description:

  - 房间类型枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`join_host_first` | String |
`net_acc` | String |
`host_control` | String |
`free_speech` | String |

房间类型枚举

##### Type:

- String

#### ScreenDisplaySurface :string

Description:

  - 桌面共享弹窗显示内容选项

##### Properties:

Name | Type | Description
--- | --- | ---
`browser` | string |
`window` | string |
`monitor` | string |
`preferCurrentTab` | string |

桌面共享弹窗显示内容选项

##### Type:

- string

#### shapeTypeEnum :String

Description:

  - 注释形状类别

##### Properties:

Name | Type | Description
--- | --- | ---
`mouse` | String |
`line` | String |
`rect` | String |
`ellipse` | String |
`polyline` | String |
`hlight_point` | String |
`hlight_texttag` | String |
`eraser` | String |
`rhomb` | String |
`arrow` | String |
`success` | String |
`failure` | String |
`clear` | String |
`img` | String |
`txt` | String |

注释形状类别

##### Type:

- String

#### StreamStatus :number

Description:

  - 流状态枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`none` | number |
`init` | number | 初始状态
`published` | number | 流发布状态
`muted` | number |
`forbided` | number |
`subed` | number |
`opened` | number |

流状态枚举

##### Type:

- number

#### (constant) USER_AGENT_AVD_COVERT_VIEWER :String

Description:

  - 观察者用户的user_agent值,只能订阅不能发布操作， 算授权数量里。

观察者用户的user_agent值,只能订阅不能发布操作， 算授权数量里。

##### Type:

- String

#### (constant) USER_AGENT_AVD_DEFAULT :String

Description:

  - web端加会用户user_agent默认值：web

web端加会用户user_agent默认值：web

##### Type:

- String

#### USER_AGENT_AVD_IOS

Description:

  - ios safari端加会用户user_agent值：web_ios

ios safari端加会用户user_agent值：web_ios

#### (constant) USER_AGENT_AVD_MEDIA_MIXER :String

Description:

  - avc模式混屏情况下，服务器产生的混屏用户其user_agent指定值

avc模式混屏情况下，服务器产生的混屏用户其user_agent指定值

##### Type:

- String

#### (constant) USER_AGENT_AVD_MEDIA_MIXER_ADMIN :String

Description:

  - avc模式混屏情况下，web端进行混屏布局操作的用户其user_agent指定值

avc模式混屏情况下，web端进行混屏布局操作的用户其user_agent指定值

##### Type:

- String

#### (constant) USER_AGENT_AVD_THROWING_SCREEN_ANONYM :String

Description:

  - 桌面共享投屏的匿名用户其user_agent指定值.预留

桌面共享投屏的匿名用户其user_agent指定值.预留

##### Type:

- String

#### (constant) USER_AGENT_AVD_VIDEO_TRANSCODING :String

Description:

  - 服务器视频转码指定值

服务器视频转码指定值

##### Type:

- String

#### (constant) USER_AGENT_AVD_WEB_RECORD :String

Description:

  - web端加会网页录制用户user_agent默认值：avd_web_record

web端加会网页录制用户user_agent默认值：avd_web_record

##### Type:

- String

#### UserCallback :String

Description:

  - 用户级别callback枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`microphone_status_notify` | String |
`camera_status_notify` | String |
`screen_status_notify` | String |
`screen_audio_status_notify` | String |
`camera_data_notify` | String |
`screen_data_notify` | String |
`publish_camera_notify` | String |
`unpublish_camera_notify` | String |
`subscrible_camera_result` | String |
`unsubscrible_camera_result` | String |
`publish_screen_notify` | String |
`unpublish_screen_notify` | String |
`subscrible_screen_result` | String |
`unsubscrible_screen_result` | String |
`publish_microphone_notify` | String |
`unpublish_microphone_notify` | String |
`subscrible_microphone_result` | String |
`unsubscrible_microphone_result` | String |
`board_add_result` | String |
`board_update_result` | String |
`board_remove_result` | String |
`board_share_result` | String |
`board_close_result` | String |
`room_set_stream_name_rep_success` | String |
`room_set_stream_name_rep_error` | String |
`video_stream_control_rep_success` | String |
`video_stream_control_rep_error` | String |
`subscrible_screen_audio_result` | String |
`unsubscrible_screen_audio_result` | String |

用户级别callback枚举

##### Type:

- String

#### VideoCodingType :number

Description:

  - 视频编码格式枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`VP8` | number |
`VP9` | number |
`H264` | number |

视频编码格式枚举

##### Type:

- number

#### VideoQualityType :number

Description:

  - 视频质量枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`high` | number | 高
`normal` | number | 中
`low` | number | 低

视频质量枚举

##### Type:

- number

#### viewLayoutModeEnum :number

Description:

  - 混屏布局枚举

##### Properties:

Name | Type | Description
--- | --- | ---
`fixation` | number |
`auto` | number |
`auto_orato` | number |

混屏布局枚举

##### Type:

- number