通话界面定制化配置 JCCTalkingConfig

用于配置通话界面的各种视觉和功能属性,包括工具栏、视频窗口、按钮显示等

const talkingConfig = new JCCTalkingConfig();
talkingConfig.title = "视频通话中";
talkingConfig.toolBarBackground = "#FF333333";
talkingConfig.showMinimized = true;

Accessors

  • set toolBarBackground(value: string): void

    设置工具栏背景色

    Parameters

    • value: string

      工具栏背景色,输入格式"#FF000000"

    Returns void

    设置通话界面底部工具栏的背景颜色

  • set toolBarButtonTextSize(value: number): void

    设置工具栏按钮文字大小

    Parameters

    • value: number

      工具栏按钮文字大小

    Returns void

    设置通话界面底部工具栏按钮的文字大小

  • set toolBarBottomMargin(value: number): void

    设置工具栏距离底部距离

    Parameters

    • value: number

      工具栏距离底部距离

    Returns void

    设置通话界面底部工具栏距离底部距离

  • set topBarBackground(value: string): void

    设置顶部栏背景色

    Parameters

    • value: string

      顶部栏背景色,输入格式"#FF000000"

    Returns void

    设置通话界面顶部状态栏的背景颜色

  • set topBarMarginTop(value: number): void

    设置顶部栏距顶部距离

    Parameters

    • value: number

      工具栏距顶部距离

    Returns void

    设置通话界面工具栏距离顶部距离

  • set title(value: string): void

    设置标题内容

    Parameters

    • value: string

      标题内容

    Returns void

    设置通话界面顶部显示的标题文本

  • set titleTextSize(value: number): void

    设置标题字体大小

    Parameters

    • value: number

      标题字体大小

    Returns void

    设置通话界面顶部显示的标题字体大小

  • set timerTextSize(value: number): void

    设置计时器字体大小

    Parameters

    • value: number

      计时器字体大小

    Returns void

    设置通话界面顶部显示的计时器字体大小

  • set showStatistic(value: boolean): void

    设置是否显示统计按钮

    Parameters

    • value: boolean

      是否显示统计按钮

    Returns void

    控制是否在通话界面显示网络统计信息按钮

  • set showMinimized(value: boolean): void

    设置是否显示最小化按钮

    Parameters

    • value: boolean

      是否显示最小化按钮

    Returns void

    控制是否在通话界面显示最小化按钮

  • set showRequestResolution(value: boolean): void

    设置是否显示订阅分辨率按钮

    Parameters

    • value: boolean

      是否显示订阅分辨率按钮

    Returns void

    控制是否在通话界面显示订阅分辨率按钮

  • set useCustomTalkingAbility(value: boolean): void

    设置是否使用自定义ability

    Parameters

    • value: boolean

      是否使用自定义ability

    Returns void

    控制是否使用自定义ability加载通话界面

  • set customView(value: any): void

    设置自定义组件

    Parameters

    • value: any

      自定义组件控制器

    Returns void

    设置通话界面的自定义视图组件

  • set useThirdACD(value: boolean): void

    设置是否使用第三方排队机

    Parameters

    • value: boolean

      是否使用第三方排队机

    Returns void

    控制是否使用第三方排队机功能

  • set showCancelSign(value: boolean): void

    设置是否显示签名取消按钮

    Parameters

    • value: boolean

      是否显示签名取消按钮

    Returns void

    控制是否在电子签名界面显示取消按钮

  • set heldAudioPath(value: string): void

    设置呼叫保持的音乐文件路径

    Parameters

    • value: string

      呼叫保持的音乐文件路径

    Returns void

    设置通话保持状态下播放的音乐文件路径

  • set showShareCanvas(value: boolean): void

    设置是否显示共享的画面

    Parameters

    • value: boolean

      是否显示共享的画面

    Returns void

    控制是否在通话界面显示共享的画面内容

  • set remotePaintColor(value: string): void

    设置远端画笔颜色

    Parameters

    • value: string

      远端画笔颜色

    Returns void

    设置远端用户涂鸦时的画笔颜色,格式为"#AARRGGBB"

  • set localPaintColor(value: string): void

    设置本端画笔颜色

    Parameters

    • value: string

      本端画笔颜色

    Returns void

    设置本地用户涂鸦时的画笔颜色,格式为"#AARRGGBB"

  • set signFullScreen(value: boolean): void

    设置电子签名是否全屏显示

    Parameters

    • value: boolean

      电子签名是否全屏显示

    Returns void

    控制电子签名界面是否以全屏方式显示

  • set pipSmallVideoWindowWidth(value: number): void

    设置对讲模式小视频窗口显示宽度

    Parameters

    • value: number

      对讲模式小视频窗口显示宽度,单位dp

    Returns void

    设置PiP(画中画)模式下小视频窗口的宽度

  • set pipSmallVideoWindowHeight(value: number): void

    设置对讲模式小视频窗口显示高度

    Parameters

    • value: number

      对讲模式小视频窗口显示高度,单位dp

    Returns void

    设置PiP(画中画)模式下小视频窗口的高度

  • set speakSmallVideoWindowWidth(value: number): void

    设置演讲者模式小视频窗口显示宽度

    Parameters

    • value: number

      演讲者模式小视频窗口显示宽度,单位dp

    Returns void

    设置演讲者模式下小视频窗口的宽度

  • set speakSmallVideoWindowHeight(value: number): void

    设置演讲者模式小视频窗口显示高度

    Parameters

    • value: number

      演讲者模式小视频窗口显示高度,单位dp

    Returns void

    设置演讲者模式下小视频窗口的高度

  • set videoHoldBackgroundColor(value: string): void

    设置关闭摄像头后窗口背景色

    Parameters

    • value: string

      关闭摄像头后窗口背景色

    Returns void

    设置当摄像头关闭时视频窗口的背景颜色,格式为"#AARRGGBB"

  • set videoHoldLargeIcon(value: string): void

    设置关闭摄像头后大窗口展示图片

    Parameters

    • value: string

      关闭摄像头后大窗口展示图片

    Returns void

    设置摄像头关闭时在大窗口中显示的图片资源路径

  • set videoHoldSmallIcon(value: string): void

    设置关闭摄像头后小窗口展示图片

    Parameters

    • value: string

      关闭摄像头后小窗口展示图片

    Returns void

    设置摄像头关闭时在小窗口中显示的图片资源路径

  • set defaultDoodleStrokeWidth(value: number): void

    设置签名画笔大小

    Parameters

    • value: number

      签名画笔大小

    Returns void

    设置电子签名功能中画笔的粗细

  • set fullDisplayFunctionLayout(value: boolean): void

    设置功能布局UI是否全显示

    Parameters

    • value: boolean

      功能布局UI是否全显示

    Returns void

    控制通话界面的功能按钮是否全部显示

  • set delayDismissDuration(value: number): void

    设置通话结束后延迟销毁通话界面时长

    Parameters

    • value: number

      延迟销毁时长,单位毫秒

    Returns void

    设置通话结束后多长时间销毁通话界面,可用于显示通话结束的提示

  • set showDoodleButton(value: boolean): void

    设置是否显示涂鸦按钮

    Parameters

    • value: boolean

      是否显示涂鸦按钮

    Returns void

    控制是否在通话界面显示涂鸦功能按钮

  • set isAutoCloseRemoteRecord(value: boolean): void

    设置是否自动关闭远程录制

    Parameters

    • value: boolean

      是否自动关闭远程录制

    Returns void

    控制是否在通话结束时自动关闭远程录制功能

  • set isSwitchFocusVideoViewWithClick(value: boolean): void

    设置是否允许点击小视频窗口切换焦点视频

    Parameters

    • value: boolean

      是否允许点击小视频窗口切换焦点视频

    Returns void

    控制是否在通话时允许点击小视频窗口切换焦点视频

  • set miniScreenShareTip(value: string): void

    设置屏幕共享时最小化窗口提示信息

    Parameters

    • value: string

      屏幕共享时最小化窗口提示信息

    Returns void

    设置当屏幕共享时最小化窗口显示的提示文本

  • set toolBarButtons(value: JCCToolBarButton[]): void

    设置JCToolbarButtons配置数组

    Parameters

    Returns void

    设置通话界面工具栏显示的按钮及其顺序,可选值参考 JCCToolBarButtons 枚举

    config.toolBarButtons = [
    JCCToolBarButtons.JCCEndButton,
    JCCToolBarButtons.JCCMicButton,
    JCCToolBarButtons.JCCCameraButton
    ];
  • set videoHoldLastFrame(value: boolean): void

    设置关摄像头是否停留最后一帧

    Parameters

    • value: boolean

      关摄像头是否停留最后一帧

    Returns void

    控制关闭摄像头时是否保留最后一帧画面,而不是显示背景色或占位图片

  • set newMessageToast(value: string): void

    设置新消息提示语

    Parameters

    • value: string

      新消息提示语

    Returns void

    设置收到新消息时显示的提示文本

  • set msgToastVerticalBiasPercent(value: number): void

    设置新消息弹出提示位置和界面顶部的距离百分比

    Parameters

    • value: number

      新消息弹出提示位置百分比

    Returns void

    设置新消息toast提示框距离界面顶部的相对位置,取值范围0-1

  • set msgLayoutInitialHeight(value: number): void

    设置消息聊天框初始高度

    Parameters

    • value: number

      消息聊天框初始高度,单位vp

    Returns void

    设置消息聊天窗口打开时的初始高度

  • set msgSupportSendFile(value: boolean): void

    设置消息界面是否支持发送文件

    Parameters

    • value: boolean

      是否支持发送文件

    Returns void

    设置消息界面是否支持发送文件

  • set msgGetSendFilesUrl(value: string): void

    设置预加载的文件列表接入地址

    Parameters

    • value: string

      预加载的文件列表接入地址

    Returns void

    设置预加载的文件列表接入地址

  • set intervalNoResponsePrompt(value: boolean): void

    设置无应答时是否每间隔一分钟提示一次

    Parameters

    • value: boolean

      是否每间隔一分钟提示一次

    Returns void

    控制在无应答时是否重复提示,若为true则每分钟提示一次,false则只提示一次