import { ExceptionData, QualityGrade } from './../../src/common/zego.entity.web'; import { ZegoRTMEvent, ZegoUser } from './ZegoExpressEntity.rtm'; /** * 低照度增强模式。 * */ export declare enum ZegoLowlightEnhancementMode { Off = 0, On = 1 } /** * 背景处理分割模式 */ export declare enum Segmentation { PortraitSegmentation = 0 } /** * 地理围栏类型。 */ export declare enum ZegoGeoFenceType { /** * 不使用地理围栏。 */ ZegoGeoFenceTypeNone = 0, /** * 包括指定的地理围栏信息。 */ ZegoGeoFenceTypeInclude = 1, /** * 排除指定的地理围栏信息。 */ ZegoGeoFenceTypeExclude = 2 } /** * 详情描述:SEI 类型。 * */ export declare enum ZegoSEIType { /** * 采用 SEI (nalu type = 6,payload type = 243) 类型打包,此类型是 SEI 标准未规定的类型,跟视频编码器或者视频文件中的 SEI 不存在冲突性,用户不需要根据 SEI 的内容做过滤。 * SDK 默认发送 SEI 采用此种类型 */ ZegoDefined = 0, /** * 采用 SEI (nalu type = 6,payload type = 5) 类型打包,H.264 标准对于此类型有规定的格式:startcode + nalu type(6) + payload type(5) + len + pay load(uuid + context)+ trailing bits; * 因为视频编码器自身会产生 payload type 为 5 的 SEI,或者使用视频文件推流时,视频文件中也可能存在这样的 SEI,所以使用此类型时,用户把 uuid + context 当作一段 buffer 塞给次媒体的发送接口; * 此时为了区别视频编码器自身产生的 SEI, App 在发送此类型 SEI 时,可以填写业务特定的uuid(uuid长度为16字节),接收方使用SDK 解析payload type为 5的SEI时,会根据设置的过滤字符串过滤出 uuid相符的 SEI 抛给业务,如果没有设置过滤字符串,SDK会把所有收到的SEI都抛给业务方; * uuid过滤字符串设置接口,setSEIConfig设置的uuid过滤字符串。 */ UserUnregister = 1 } /** * ZegoCamera及ZegoSreen的分辨率、码率等配置的约束扩展。 * * 详细描述:约束对象,当ZegoCamera和ZegoSreen的参数videoQuality 为4时,对分辨率、码率等进行设置。 * * 业务场景:创建预览音视频流时约束扩展。 * * 注意事项: * 对于四种形式,优先级为 exact > ideal >= max = min。即: * 1. 出现exact时,忽略其他选项。若无法满足,则采集失败 * 2. 出现ideal,没有min、max时,尽量靠近ideal * ⅰ. 若能达到,则可以浮动在 ideal ± 10 * ⅱ. 若不能达到,则选用最靠近的值 * 3. 不出现exact,出现ideal,有min时,尽量靠近ideal的同时,大于min。若无法满足大于min,则采集失败 * 4. 不出现exact,出现ideal,有max时,尽量靠近ideal的同时,小于max。若无法满足小于max,则采集失败 * 5. 不出现exact,出现ideal,有min和max时,尽量靠近ideal的同时,大于min且小于max。若无法满足,则采集失败 * 6. 不出现exact,不出现ideal,出现min时,大于min。若无法满足大于min,则采集失败 * 7. 不出现exact,不出现ideal,出现max时,小于max。若无法满足小于max,则采集失败 * 8. 不出现exact,不出现ideal,出现min和max时,大于min且小于max。若无法满足,则采集失败。 * */ export interface ConstraintExtend { /** * 可选参数,出现该选项时忽略其他选项。严格指定采集设备最终输出的值,如果设备不支持指定的值,采集会失败。 */ exact?: number; /** * 可选参数,期望采集设备最终输出的值,如果设备不支持指定的值,会尽量输出一个最靠近的值。 */ ideal?: number; /** * 可选参数,采集设备最终输出的值上限。 */ max?: number; /** * 可选参数,采集设备最终输出的值下限。 */ min?: number; } /** * 音浪回调设置选项。 * */ export interface SoundLevelDelegateOptions { /** * 详情描述:设置在页面隐藏时是否保持开启获取获取音浪和回调音浪回调,2.18.0 及以后版本默认为关闭。 * 业务场景:在页面隐藏时关闭获取音浪可以减少性能消耗。 */ enableInBackground?: boolean; } /** * 音效播放器设置选项。 * */ export interface ZegoAudioEffectPlayOptions { /** * 指定加载在线音频资源地址,如果 audioEffectID 上已经加载了音效,会直接使用加载好的音效。 * 1. 在线音频文件需要符合 [浏览器的同源策略](https://developer.mozilla.org/zh-CN/docs/Web/Security/Same-origin_policy)。 * 2. 支持 MP3、AAC 以及浏览器支持的其他音频格式。 */ path?: string; } /** * 自动切换摄像头接口相关配置约束 * */ export interface ZegoAutoSwitchDeviceConfig { /** * 详情描述:是否开启摄像头设备的自动切换 * * 是否必填:否 */ camera?: boolean; /** * 详情描述:是否开启麦克风设备的自动切换 * * 是否必填:否 */ microphone?: boolean; } /** * 创建摄像头媒体流相关参数约束 * * Note: 详情描述:该类用于约束接口 createStream 的参数 source.camera。 * * Note: 业务场景:创建摄像头音视频流。 * * Note: 注意事项: * 1. 创建流成功后拿到的 stream 为 mediaStream 对象,开发者可通过赋值给