import { LayoutAvatarType } from './index'; import { ILoginInfo } from './client'; import { StreamFrameRate, StreamResolution } from './stream'; /** * 水印范围 * * @param { CONTENT } '0' - 共享内容叠加水印 * @param { ALL } '1' - 视频和共享内容叠加水印 */ export declare enum WatermarkRange { CONTENT = "0", ALL = "1" } /** * 水印状态,是否有水印 */ export declare enum WatermarkStatus { NONE = "0", WITH = "1" } /** * 呼叫号码的云会议室属性配置 */ export interface IConfAuxPro { watermark: WatermarkStatus; watermarkRange: WatermarkRange; displayConfNo: string; inoutReminder: string; waitingRoomProp?: IWaitingRoomProps; } /** * 等候室相关信息 * * @property { number } waitingState 等候室状态 1:在等候室; 0: 未在等候室 * @property { string } reason 原因 */ export interface IWaitingRoomProps { waitingState: number; reason: string; } /** * Calluriv2接口返回的部分对外数据信息 */ export interface IConfCallInfo { displayName: string; numberType: string; callUrl: string; avatar: string; deviceType: string; deviceId: string; } /** * 个人云会议室信息 * 默认只保存了部分信息 * * @property { string } meetingControlPassword - 会控密码 * @property { string } meetingNumber - 个人云会议室号码 * @property { string } password - 入会密码 * @property { boolean } isMeetingOwner - 是否是会议室Owner * @property { string? } allowTempUserCall 是否允许临时账号入会,默认是false,通过Manager平台配置 * @property { string? } tempUserCallApproved 是否是由主持人管控入会,默认是false,通过Manager平台配置 */ export interface ICloudRoomConfig { meetingControlPassword: string; meetingNumber: string; password: string; isMeetingOwner?: boolean; allowTempUserCall?: boolean; tempUserCallApproved?: boolean; } /** * 用户和对应个人云会议室信息数据 */ export interface IExportUserInfo extends ILoginInfo { cloudRoomInfo: ICloudRoomConfig; } /** * 会议上行和下行方向 * * @property DOWNLINK - PEOPLE+CONTENT下行方向 * @property UPLINK - PEOPLE+CONTENT上行方向 * @property ALL - 上行+下行方向 * @property PEOPLE_DOWNLINK - PEOPLE下行方向 * @property PEOPLE_UPLINK - PEOPLE上行方向 * @property CONTENT_DOWNLINK - CONTENT下行方向 * @property CONTENT_UPLINK - CONTENT上行方向 */ export declare enum MEETING_DIRECTION { DOWNLINK = "DOWNLINK", UPLINK = "UPLINK", ALL = "ALL", PEOPLE_DOWNLINK = "PEOPLE_DOWNLINK", PEOPLE_UPLINK = "PEOPLE_UPLINK", CONTENT_DOWNLINK = "CONTENT_DOWNLINK", CONTENT_UPLINK = "CONTENT_UPLINK" } /** * 媒体能力配置 * * @property { StreamResolution } peopleRecResolution - 控制People接收分辨率 * @property { StreamResolution } peopleSendResolution - 控制People发送分辨率 * @property { StreamFrameRate } peopleRecFrameRate - 控制People接收帧率 * @property { StreamFrameRate } peopleSendFrameRate - 控制People发送帧率 * @property { StreamResolution } contentRecResolution - 控制Content发送分辨率 * @property { StreamResolution } contentSendResolution - 控制Content发送分辨率 * @property { number } rxBandwidth - 控制下行带宽,值类似:1920 * @property { number } pTxBandwidth - web节点People发送带宽,该字段不存在时或者配置为0时,取默认值3000000(3M) * @property { number } cTxBandwidth - web节点Content发送带宽,该字段不存在时或者配置为0时,取默认值3000000(3M) * @property { number } bwMode - 带宽模式配置 * 0-本地带宽表;未配置带宽模式时,终端默认使用0-本地带宽表 * 1-极限模式----暂时不支持 * 2-低带宽模式----暂时不支持 * 3-普通模式----暂时不支持 * 4-高带宽模式-----20260327支持,文档:https://nones.xylink.com/wiki/#/team/AQzvsooq/space/WctinJ2n/page/Aoro2gn1 */ export interface IMediaConfig { peopleRecResolution: StreamResolution; peopleSendResolution: StreamResolution; peopleRecFrameRate: StreamFrameRate; peopleSendFrameRate: StreamFrameRate; contentRecResolution: StreamResolution; contentSendResolution: StreamResolution; rxBandwidth: number; pTxBandwidth: number; cTxBandwidth: number; bwMode?: number; } /** * 媒体能力配置 请求参数 */ export interface IMediaConfigParam { clientConfigName: string; configName: string; } /** * 企业配置信息 * * @property { LayoutAvatarType } userAvatarMode - 头像配置 0:名称头像(默认), 1: 人物头像 * @property { boolean } showDepartment - 显示组织 * @property { boolean } showDepartmentAndTitle - 显示组织和职务 * * 备注:其他开关暂时未使用到 */ export interface IEnterpriseConfig { userAvatarMode?: LayoutAvatarType; showDepartment?: boolean; showDepartmentAndTitle?: boolean; shareScreenshot?: boolean; shareMaxNumSetting?: boolean; openTempAccount?: boolean; multipleSharedCount?: number; enbaleMultipleShared?: boolean; enableVodShare?: boolean; enableMonitor?: boolean; enableModifyPhone?: boolean; enableEnterpriseMemberInvatition?: boolean; enableApplySpeak?: boolean; disableTranscriptionEng?: boolean; aiDenoise?: boolean; } /** * 签到参数 * * @property { string } questionnaireId - 业务ID */ export interface SignInParams { questionnaireId: string; } /** * 签到结果 * * @property { boolean } success - 是否成功 * @property { string } status - 签到结果 * @property { string } data - 描述 */ export interface SignInResult { success: boolean; status: string; data: string; } /** * 签到文案 详细内容 * * @property { string } businessType - 业务类型 * @property { string } copyWritingCode - 文案编码 * @property { string } remark - 备注 * @property { string } content - 文案内容 * @property { string } picUrl - 图片地址 * @property { string } startVersion - 开始版本 * @property { number } createTime - 创建时间 * @property { number } updateTime - 更新时间 * @property { number } indexNo - 排序 * @property { string } enterpriseId - 企业id * @property { boolean } custom - 是否自定义 */ interface CopyWritingInfo { businessType: string; copyWritingCode: string; remark: string; content: string; picUrl: string; startVersion: string; createTime: number; updateTime: number; indexNo: number; enterpriseId: string; custom: boolean; } /** * 签到文案 * * @property { string } businessType - 业务类型 * @property { string } name - 业务名称 * @property { string } remark - 备注 * @property { string } startVersion - 开始版本 * @property { number } createTime - 创建时间 * @property { number } updateTime - 更新时间 * @property { CopyWritingInfo[] } copyWritings - 签到文案 */ export interface copyWritingsDTO { businessType: string; name: string; remark: string; startVersion: string; createTime: number; updateTime: number; copyWritings: CopyWritingInfo[]; } /** * 签到文案 * * @property { boolean } isSupport - 是否支持签到 * @property { string } businessName - 业务名称 * @property { string } content - 签到文案 * @property { copyWritingsDTO } copyWritingsDTO - 签到文案 */ export interface SignInText { isSupport: boolean; businessName: string; content: string; copyWritingsDTO: copyWritingsDTO; } /** * 校验会控主持密码结果 */ export interface ControlPasswordResult { code: number; data: string; } /** * 签到/投票业务状态 * * @param { VOTE_SIGNATURE_START } VOTE_SIGNATURE_START - 开始签到 * @param { VOTE_SIGNATURE_STOP } VOTE_SIGNATURE_STOP - 签到结束 */ export declare enum EVENT_TYPE { VOTE_SIGNATURE_START = "VOTE_SIGNATURE_START", VOTE_SIGNATURE_STOP = "VOTE_SIGNATURE_STOP" } /** * 业务类型 * * @param { SIGN_IN } 2 - 签到 */ export declare enum VOTE_TYPE { SIGN_IN = 2 } /** * 互动工具业务类型:签到 答题 投票 评价 * * @param { CHECK_IN } CHECK_IN - 签到 */ export declare enum PROCESS_TYPE { CHECK_IN = "CHECK_IN" } /** * 互动工具业务涉及到弹窗和状态栏内容 * * @property { string } notifyContent - 左上角状态栏文案 * @property { string } notifyLabel - 左上角状态栏按钮内容 比如签到按钮 * @property { string } dialogTitle - 弹窗标题 * @property { string } dialogContent - 弹窗主要内容 黑体字部分 * @property { string } dialogSubContent - 弹窗描述 * @property { string } dialogLabel - 弹窗右下角按钮文案 */ export interface CopyWriting { notifyContent: string; notifyLabel: string; dialogTitle: string; dialogContent: string; dialogSubContent: string; dialogLabel: string; } /** * 会控互动工具相关数据, 签到等 * * @property { EVENT_TYPE } type - 业务状态 * @property { VOTE_TYPE } voteType - 业务类型, 签到:2 * @property { string } questionnaireId - 业务id * @property { boolean } endAuto - 是否自动结束(有倒计时),还是手动结束 * @property { number } duration -期限,比如签到剩余时间 * @property { number } endUtcTime - 结束时间 * @property { string } meetingId - 会议ID * @property { PROCESS_TYPE } processType - 互动工具业务类型:签到 答题 投票 评价 * @property { string } url - 签到url * @property { string } urlPropv3 - 通过此值获取签到对应的接口(分区云) * @property { string } urlProp - 通过此值获取签到对应的接口(公有云) * @property { string } webViewUrl - h5页面url * @property { Copywriting } copywriting - 弹窗内容、左侧顶部状态栏内容 */ export interface InteractiveToolInfo { type: EVENT_TYPE; voteType: VOTE_TYPE; questionnaireId: string; endAuto?: false; duration?: number; endUtcTime?: number; meetingId?: string; processType: PROCESS_TYPE; displayResult?: true; faceCheckInSupport?: false; faceType?: number; supportFace?: false; supportScan?: true; url?: string; urlPropv3?: string; urlProp?: string; webViewUrl?: string; webViewUrlProp?: string; copywriting?: CopyWriting; } /** * 获取签到文案参数 * * @property { EVENT_TYPE } type - 业务状态 * @property { string } environment - 语言 * @property { VOTE_TYPE } businessType - 业务类型 */ export interface SignInTextParams { type: EVENT_TYPE; environment: string; businessType: VOTE_TYPE; } /** * 会议室通用配置 * * @property { string } displayNum - 显示云会议室号码, 点对点显示不使用此值,直接显示呼叫的号码 * @property { string } mpvc - 点对点和多点的临时会议室号(多点是几个终端呼起来的,没有真正的会议室号),有些场景如会控需要。 * @property { string } confAuxProperties - 云会议室属性配置 * @property { IWaitingRoomProps } waitingRoomProps - 等候室属性配置 */ export interface ConferenceCommon { displayNum?: string; mpvc?: string; confAuxProperties?: string; waitingRoomProps?: IWaitingRoomProps; } /** * 是否是联席主持人 * * @param NONE - 默认值 * @param ON - 是 * @param OFF - 否 */ export declare enum CoChair { NONE = "none", ON = "on", OFF = "off" } /** * 是否是主持人 * * @param NONE - 默认值 * @param ON - 是 * @param OFF - 否 */ export declare enum Host { NONE = "none", ON = "on", OFF = "off" } /** * 是否有改名权限 * * @param ON - 是 * @param OFF - 否 */ export declare enum EnableRename { ON = "on", OFF = "off" } /** * 是否有权限 * * @param ON - 是 * @param OFF - 否 */ export declare enum XYNotificationStatus { ON = "on", OFF = "off", NONE = "none" } /** * 信令上报的消息 * * @property { CoChair } coChair - 是否是联席主持人 * @property { Host } host - 是否是主持人 * @property { EnableRename } enableRename - 是否有改名权限 * @property { XYNotificationStatus } newImStatus - 是否有聊天权限 * @property { XYNotificationStatus } waiterChatToHost - 是否允许私聊主持人 * @property { string } meetingId - 会议ID */ export interface XYNotificationContent { coChair?: CoChair; host?: Host; enableRename?: EnableRename; newImStatus?: XYNotificationStatus; waiterChatToHost?: XYNotificationStatus; meetingId?: string; } /** * 联席主持人/主持人/改名权限/聊天权限 等消息 * * @property { XYNotificationType } type - 消息类型 * @property { number } subType - 消息类型 * @property { XYNotificationContent } content - 消息详细内容 * @property { string } requestId - 消息ID */ export interface XYNotification { type: XYNotificationType; subType: number; content: XYNotificationContent; requestId: string; } /** * 消息类型 * * @param CO_CHAIR - 联席主持人 * @param HOST - 主持人 * @param RENAME - 改名 * @param IM - 聊天 */ export declare enum XYNotificationType { CO_CHAIR = "CO_CHAIR", HOST = "HOST", RENAME = "RENAME", IM = "IM" } /** * IM 聊天消息 * * @property { string } from - 发送人 * @property { string } to - 接收人 * @property { number } msgType - 消息类型 * @property { number } chatType - 聊天类型 * @property { string } content - 消息内容 * @property { number } sendtime - 消息发送时间 * @property { string } msgId - 消息ID * @property { number } sequence - 消息序号 * @property { string } fromName - 发送人名称 * @property { string } avatar - 发送人头像 * @property { string } toName - 接收人名称 * @property { boolean } fromLocal - 是否是本地发送 * @property { boolean } toAll - 是否是全体发送 */ export interface XYIMMsg { from: string; to: string; msgType: number; chatType: number; content: string; sendtime: number; msgId: string; sequence: number; fromName: string; avatar: string; toName: string; fromLocal?: boolean; toAll?: boolean; } export {};