通过阅读本文，您可以了解到Electron SDK的AliRtcEngine接口详情。

目录

构造函数
constructor(option: AliEngineOption)
参数 类型 描述
option AliEngineOption 引擎初始化参数。
说明 参数中的H5兼容模式表示能否和Web端正常通信，默认关闭。

基础接口

API 描述 支持的最低版本
destroy SDK资源释放。 2.5.2

频道相关接口

API 描述 支持的最低版本
joinChannel 加入频道。 2.5.2
leaveChannel 离开频道。 2.5.2
isInCall 检查当前是否在频道中。 2.5.2
setChannelProfile 设置频道模式。 2.5.2

发布相关接口

API 描述 支持的最低版本
publishLocalVideoStream 设置是否允许推视频流。 2.5.2
isLocalVideoStreamPublished 查询当前是否允许推视频流。 2.5.2
isScreenSharePublished 查询当前是否允许推屏幕流。 2.5.2
publishLocalAudioStream 设置是否允许推音频流。 2.5.2
isLocalAudioStreamPublished 查询当前是否允许推音频流。 2.5.2
publishLocalDualStream 设置是否允许推次要视频流。 2.5.2
isDualStreamPublished 查询当前是否允许推次要视频流。 2.5.2

订阅相关接口

API 描述 支持的最低版本
setRemoteVideoStreamType 设置订阅的相机流格式。 2.5.2
setRemoteDefaultVideoStreamType 设置默认订阅的相机流格式。 2.5.2
setDefaultSubscribeAllRemoteAudioStreams 设置是否默认拉音频流。 2.5.2
subscribeAllRemoteAudioStreams 停止或恢复拉所有远端音频流。 2.5.2
subscribeRemoteAudioStream 停止或恢复特定远端用户的音频流拉取。 2.5.2
setDefaultSubscribeAllRemoteVideoStreams 设置是否默认拉视频流。 2.5.2
subscribeAllRemoteVideoStreams 停止或恢复拉所有远端视频流。 2.5.2
subscribeRemoteVideoStream 停止或恢复特定远端用户的视频流拉取。 2.5.2

视频相关接口

API 描述 支持的最低版本
setScreenShareEncoderConfiguration 设置屏幕共享编码属性。 2.5.2
setLocalViewConfig 为本地预览设置渲染窗口以及绘制参数。 2.5.2
enableLocalVideo 禁用或重新启用本地视频采集。 2.5.2
muteLocalCamera 设置是否停止推本地视频流。 2.5.2
setRemoteViewConfig 为远端的视频设置渲染窗口。 2.5.2
stopRecord 停止录制。 2.5.2
startRecord 开始录制。 2.5.2
pauseRecord 暂停录制。 2.5.2
resumeRecord 重新开始录制。 2.5.2
setBeautyEffect 设置基础美颜。 2.5.2
setVideoEncoderConfiguration 设置视频编码属性。 2.5.2

共享视频接口

API 描述 支持的最低版本
startScreenShareByDesktopId 根据桌面ID进行屏幕分享。 2.5.2
startScreenShareByWindowId 根据窗口ID进行屏幕分享。 2.5.2
stopScreenShare 停止屏幕分享。 2.5.2
getScreenShareConfig 获取屏幕共享配置。 2.5.2
getScreenShareSourceInfo 获取屏幕分享源信息。 2.5.2
getCurrentScreenShareSourceId 获取当前屏幕共享源ID。 2.5.2
getCurrentScreenShareSourceType 获取当前屏幕共享源类型。 2.5.2

音频相关接口

API 描述 支持的最低版本
muteLocalMic 设置是否停止推本地音频。 2.5.2
muteRemoteAudio 设置是否停止播放远端音频流。 2.5.2
muteAllRemoteAudio 停止或恢复远端所有的音频播放。 2.5.2
startAudioCapture 开启音频采集。 2.5.2
stopAudioCapture 关闭音频采集。 2.5.2
startAudioPlayer 开启音频播放设备。 2.5.2
stopAudioPlayer 关闭音频播放。 2.5.2
enableAudioVolumeIndication 设置音量回调频率和平滑系数。 2.5.2
setAudioProfile 设置音频Profile。 2.5.2
startAudioAccompany 开始混音。 2.5.2
stopAudioAccompany 停止混音。 2.5.2
setAudioAccompanyVolume 设置混音音量。 2.5.2
setAudioAccompanyPublishVolume 设置混音之后推流出去的音量。 2.5.2
getAudioAccompanyPublishVolume 获取推流出去的混音音量。 2.5.2
setAudioAccompanyPlayoutVolume 设置混音之后本地播放的音量。 2.5.2
getAudioAccompanyPlayoutVolume 获取混音本地播放的音量。 2.5.2
pauseAudioAccompany 暂停混音。 2.5.2
resumeAudioAccompany 重新开始混音。 2.5.2
getAudioAccompanyDuration 获取伴奏文件时长。 2.5.2
getAudioAccompanyCurrentPosition 获取音乐文件播放进度。 2.5.2
setAudioAccompanyPosition 设置音频文件的播放位置。 2.5.2
enableSystemAudioRecording 设置是否开启系统声音采集推送。 2.5.2
isSystemAudioRecording 当前是否开启系统声音采集推送。 2.5.2
setSystemAudioRecordingVolume 设置系统声音采集推送音量。 2.5.2
getSystemAudioRecordingVolume 获取当前设置系统声音采集推送音量。 2.5.2

音频设备管理接口

API 描述 支持的最低版本
getAudioCaptureList 获取系统中的录音设备列表。 2.5.2
getCurrentAudioCaptureName 获取使用的录音设备名称。 2.5.2
getCurrentAudioCaptureID 获取使用的录音设备ID。 2.5.2
setCurrentAudioCaptureName 选择录音设备名称。 2.5.2
setCurrentAudioCaptureID 选择录音设备ID。 2.5.2
getAudioPlayerList 获取系统中的扬声器列表。 2.5.2
getCurrentAudioPlayerName 获取当前使用的扬声器名称。 2.5.2
getCurrentAudioPlayerID 获取当前使用的扬声器ID。 2.5.2
setCurrentAudioPlayerName 选择扬声器名称。 2.5.2
setCurrentAudioPlayerID 选择扬声器ID。 2.5.2
startTestAudioRecordByName 开始测试音频采集设备。 2.5.2
startTestAudioRecordById 开启麦克风设备测试（按设备ID）。 2.5.2
stopTestAudioRecord 停止测试音频采集设备。 2.5.2
startTestAudioPlayoutByName 开始测试音频播放设备。 2.5.2
startTestAudioPlayoutById 开启扬声器设备测试（按设备ID）。 2.5.2
stopTestAudioPlayout 停止测试音频播放设备。 2.5.2

视频设备管理接口

API 描述 支持的最低版本
getCameraList 获取摄像头列表。 2.5.2
getCurrentCameraName 获取当前使用的摄像头名称。 2.5.2
getCurrentCameraID 获取当前使用的摄像头ID。 2.5.2
setCurrentCameraName 选择摄像头名称。 2.5.2
setCurrentCameraID 选择摄像头ID。 2.5.2

预览接口

API 描述 支持的最低版本
startPreview 开启预览。 2.5.2
stopPreview 停止预览。 2.5.2

远端用户查询接口

API 描述 支持的最低版本
getUserInfo 查询远端用户信息。 2.5.2

其他接口

API 描述 支持的最低版本
getSDKVersion 获取SDK版本号。 2.5.2
setClientRole 设置用户角色。 2.5.2
getClientRole 获取用户角色。 2.5.2
startLastmileDetect 开始网络质量探测。 2.5.2
stopLastmileDetect 停止网络质量探测。 2.5.2
getCurrentConnectionStatus 获取当前网络链接状态。 2.5.2
on 订阅事件。 2.5.2
off 取消订阅事件。 2.5.2

接口详情

  • destroy：SDK资源释放。
    destroy(): void;
  • joinChannel：加入频道。
    joinChannel(authInfo: AliEngineAuthInfo, options?: ChannelMediaOptions): number;
    参数说明
    参数 类型 描述
    authInfo AliEngineAuthInfo 鉴权信息。
    options ChannelMediaOptions 订阅选项。
    说明
    • 加入频道成功后，如果中途需要加入其他频道，必须先调用leaveChannel离开当前频道。
    • 如果加入频道失败，需要重试时，无需先调用leaveChannel。
    • 该接口是异步接口，是否成功加入频道，通过onJoinChannelResult判断。
  • leaveChannel：离开频道。
    leaveChannel (): number;
    说明 该接口为异步接口，是否成功离开频道，通过onJoinChannelResult判断。
  • isInCall：检查当前是否在频道中。
    isInCall(): boolean;
    返回说明

    true表示在频道中，false表示不在频道中。

  • setChannelProfile：设置频道模式（入会前调用）。
    setChannelProfile (channelProfile: AliEngineChannelProfile): number;
    参数说明
    参数 类型 描述
    channelProfile AliEngineChannelProfile 频道类型，默认通信模式。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • publishLocalVideoStream：设置是否允许推视频流。
    publishLocalVideoStream (enable: boolean): number;
    参数说明
    参数 类型 描述
    enable boolean 是否允许推视频流。取值：
    • true（默认值）：允许推视频流。
    • false：不允许推视频流。
  • isLocalVideoStreamPublished：查询当前是否允许推视频流。
    isLocalVideoStreamPublished (): boolean;
    返回说明

    true表示允许，false表示不允许。

  • isScreenSharePublished：查询当前是否允许推屏幕流。
    isScreenSharePublished (): boolean;
    返回说明

    true表示允许，false表示不允许。

  • publishLocalAudioStream：设置是否允许推音频流。
    publishLocalAudioStream (enable: boolean): number;
    参数说明
    参数 类型 描述
    enable boolean 是否允许推音频流。取值：
    • true（默认值）：允许推音频流。
    • false：不允许推音频流。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • isLocalAudioStreamPublished：查询当前是否允许推音频流。
    isLocalAudioStreamPublished (): boolean;
    返回说明

    true表示允许，false表示不允许。

  • publishLocalDualStream：设置是否允许推次要视频流。
    publishLocalDualStream (enabled: boolean): number;
    参数说明
    参数 类型 描述
    enable boolean 是否允许推次要视频流。取值：
    • true（默认值）：允许推次要视频流。
    • false：不允许推次要视频流。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • isDualStreamPublished：查询当前是否允许推次要视频流。
    isDualStreamPublished (): boolean;
    返回说明

    true表示允许，false表示不允许。

  • setRemoteVideoStreamType：设置订阅的相机流格式。
    setRemoteVideoStreamType (uid: string, streamType: AliEngineVideoStreamType): number;
    参数说明
    参数 类型 描述
    uid string 远端用户ID。
    streamType AliEngineVideoStreamType 相机流格式。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setRemoteDefaultVideoStreamType：设置默认订阅的相机流格式。
    setRemoteDefaultVideoStreamType (streamType: AliEngineVideoStreamType): number;
    参数说明
    参数 类型 描述
    streamType AliEngineVideoStreamType 相机流格式。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setDefaultSubscribeAllRemoteAudioStreams：设置是否默认拉音频流。
    setDefaultSubscribeAllRemoteAudioStreams (sub: boolean): number;
    参数说明
    参数 类型 描述
    sub boolean 是否订阅。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • subscribeAllRemoteAudioStreams：停止或恢复拉所有远端音频流。
    subscribeAllRemoteAudioStreams (sub: boolean): number;
    参数说明
    参数 类型 描述
    sub boolean 是否订阅。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • subscribeRemoteAudioStream：停止或恢复特定远端用户的音频流拉取。
    subscribeRemoteAudioStream (uid: string, sub: boolean): number;
    参数说明
    参数 类型 描述
    uid string 远端用户ID。
    sub boolean 是否订阅。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setDefaultSubscribeAllRemoteVideoStreams：设置是否默认拉视频流。
    setDefaultSubscribeAllRemoteVideoStreams (sub: boolean): number;
    参数说明
    参数 类型 描述
    sub boolean 是否订阅。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • subscribeAllRemoteVideoStreams：停止或恢复拉所有远端视频流。
    subscribeAllRemoteVideoStreams (sub: boolean): number;
    参数说明
    参数 类型 描述
    sub boolean 是否订阅。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • subscribeRemoteVideoStream：停止或恢复特定远端用户的视频流拉取。
    subscribeRemoteVideoStream (uid: string, track: AliEngineVideoTrack, sub: boolean): number;
    参数说明
    参数 类型 描述
    uid string 远端用户ID。
    track AliEngineVideoTrack 视频流类型。
    sub boolean 是否订阅。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setScreenShareEncoderConfiguration：设置屏幕共享编码属性。
    setScreenShareEncoderConfiguration (config: AliEngineScreenShareEncoderConfiguration): number;
    参数说明
    参数 类型 描述
    config AliEngineScreenShareEncoderConfiguration 屏幕共享编码属性。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setLocalViewConfig：为本地预览设置渲染窗口以及绘制参数。
    setLocalViewConfig (view: HTMLDivElement): void;
    参数说明
    参数 类型 描述
    element HTMLDivElement 预览容器。
  • enableLocalVideo：禁用或重新启用本地视频采集。
    enableLocalVideo (enabled: boolean): number;
    参数说明
    参数 类型 描述
    enable boolean 禁用或重新启用本地视频采集。取值：
    • true（默认值）：重新启用视频采集。
    • false：停止视频采集。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • muteLocalCamera：设置是否停止推本地视频流。
    muteLocalCamera (mute: boolean, track: AliEngineVideoTrack): number;
    参数说明
    参数 类型 描述
    mute boolean 停止或恢复推视频流。取值：
    • true：停止推视频流。
    • false（默认值）：恢复推视频流。
    track AliEngineVideoTrack 需要改变推流状态的视频流类型。
    说明 此接口只是控制指定视频流上是否发送黑帧，采集和数据发送不会停止，如果需要关闭采集请使用enableLocalVideo接口，如果需要中止视频数据发送请使用publishLocalVideoStream接口。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setRemoteViewConfig：为远端的视频设置渲染窗口。
    setRemoteViewConfig (userId: string, contianer: HTMLDivElement, type: number): void;
    参数说明
    参数 类型 描述
    uid string 用户ID。
    container HTMLDivElement 视图容器。
    type number 视频流类型，取值：
    • 1：摄像头。
    • 2：屏幕。
  • stopRecord：停止录制。
    stopRecord (): boolean;
    返回说明

    true表示方法调用成功，false表示方法调用失败。

  • startRecord：开始录制，目前仅支持音频录制。
    startRecord (recordType: AliEngineRecordType, recordFormat: AliEngineRecordFormat, filePath: string, audioConfig: AliEngineRecordAudioConfig, videoConfig: AliEngineRecordVideoConfig, isFragment: boolean): boolean;
    参数说明
    参数 类型 描述
    recordType AliEngineRecordType 录制类型。
    recordFormat AliEngineRecordFormat 录制格式。
    filePath string 文件路径。
    audioConfig AliEngineRecordAudioConfig 录制音频设置。
    videoConfig AliEngineRecordVideoConfig 录制视频设置。
    isFragment boolean 是否支持MP4内部分段，只在录制MP4时有效。
    返回说明

    true表示方法调用成功，false表示方法调用失败。

  • pauseRecord：暂停录制。
    pauseRecord (): boolean;
    返回说明

    true表示方法调用成功，false表示方法调用失败。

  • resumeRecord：重新开始录制。
    resumeRecord (): boolean;
    返回说明

    true表示方法调用成功，false表示方法调用失败。

  • setBeautyEffect：设置基础美颜，目前只支持美白和磨皮。
    setBeautyEffect (enable: boolean, config: AliEngineBeautyConfig): number;
    参数说明
    参数 类型 描述
    enable boolean 是否启用基础美颜。取值：
    • true：开启。
    • false（默认值）：关闭。
    config AliEngineBeautyConfig 基础美颜参数。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setVideoEncoderConfiguration：设置视频编码属性。
    setVideoEncoderConfiguration (config: AliEngineVideoEncoderConfiguration): number;
    参数说明
    参数 类型 描述
    config AliEngineVideoEncoderConfiguration 预定义的编码属性。
  • startScreenShareByDesktopId：根据桌面ID进行屏幕分享。
    startScreenShareByDesktopId (desktopId: number, config: AliEngineScreenShareConfig): number;
    参数说明
    参数 类型 描述
    desktopId number 桌面ID，可通过getScreenShareSourceInfo接口获取。
    config AliEngineScreenShareConfig 屏幕分享配置。
    说明 配置指定区域分享时，分享区域最小分辨率为16 x 16，设置区域小于最小分辨率时重置为最小分辨率；设置分享区域超过实际桌面分辨率时，将分享整个桌面。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • startScreenShareByWindowId：根据窗口ID进行屏幕分享。
    startScreenShareByWindowId (windowId: number, config: AliEngineScreenShareConfig): number;
    参数说明
    参数 类型 描述
    windowId number 窗口ID，可通过getScreenShareSourceInfo接口获取。
    config AliEngineScreenShareConfig 屏幕分享配置。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • stopScreenShare：停止屏幕分享。
    stopScreenShare (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • getScreenShareConfig：获取屏幕共享配置。
    getScreenShareConfig (): AliEngineScreenShareConfig;
    返回说明

    返回屏幕共享配置信息AliEngineScreenShareConfig。

  • getScreenShareSourceInfo：获取屏幕分享源信息。
    getScreenShareSourceInfo (sourceType: AliEngineScreenShareType): Promise<AliEngineScreenItemInfo[]>
    参数说明
    参数 类型 描述
    sourceType AliEngineScreenShareType 屏幕分享类型。
    返回说明

    Promise返回AliEngineScreenItemInfo[]。

  • getCurrentScreenShareSourceId：获取当前屏幕共享源ID。
    getCurrentScreenShareSourceId (): string;
    返回说明

    返回当前屏幕共享源ID。

  • getCurrentScreenShareSourceType：获取当前屏幕共享源类型。
    getCurrentScreenShareSourceType (): AliEngineScreenShareType;
    返回说明

    返回当前屏幕共享源类型。

  • muteLocalMic：设置是否停止推本地音频。
    muteLocalMic (mute: boolean, mode: AliEngineMuteLocalAudioMode): number;
    参数说明
    参数 类型 描述
    mute boolean 停止或恢复本地音频数据发送。取值：
    • true：本地音频发送静音帧。
    • false：恢复正常。
    mode AliEngineMuteLocalAudioMode 静音模式，默认麦克风静音模式。
    说明 mute只是发送音频数据为静音帧，采集和编码模块仍然在工作。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • muteRemoteAudio：设置是否停止播放远端音频流。
    muteRemoteAudio (uid: string, mute: boolean): number;
    参数说明
    参数 类型 描述
    uid string 用户ID。
    mute boolean 停止或恢复远端的音频播放。取值：
    • true：停止播放。
    • false：恢复播放。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • muteAllRemoteAudio：停止或恢复远端所有的音频播放。
    muteAllRemoteAudio (mute: boolean): number;
    参数说明
    参数 类型 描述
    mute boolean 停止或恢复远端所有的音频播放。取值：
    • true：停止播放。
    • false：恢复播放。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • startAudioCapture：开启音频采集。
    startAudioCapture (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • stopAudioCapture：关闭音频采集。
    stopAudioCapture (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • startAudioPlayer：开启音频播放设备。
    startAudioPlayer (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • stopAudioPlayer：关闭音频播放。
    stopAudioPlayer (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • enableAudioVolumeIndication：设置音量回调频率和平滑系数。
    enableAudioVolumeIndication (interval: number, smooth: number, reportVad: number): number;
    参数说明
    参数 类型 描述
    interval number 时间间隔，单位为毫秒，最小值不得小于10ms，建议设置300~500ms；小于等于0表示不启用音量提示和说话人提示功能。
    smooth number 平滑系数，数值越大平滑程度越高，反之越低，实时性越好，取值范围：[0,9]，建议设置3。
    reportVad number 说话人检测开关。取值：
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setAudioProfile：设置音频Profile。
    setAudioProfile (audioProfile: AliEngineAudioProfile, audioScene: AliEngineAudioScenario): number;
    参数说明
    参数 类型 描述
    audio_profile AliEngineAudioProfile 音频采集或编码模式参数。
    audio_scene AliEngineAudioScenario 音频场景模式参数。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • startAudioAccompany：开始混音。
    startAudioAccompany (filePath: string, onlyLocalPlay: boolean, replaceMic: boolean, loopCycle: number): number;
    参数说明
    参数 类型 描述
    filePath string 混音文件路径。
    onlyLocalPlay boolean 是否只本地播放。
    replaceMic boolean 是否替换掉MIC。
    loopCycles number 循环次数（可以设置-1或者正整数）。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • stopAudioAccompany：停止混音。
    stopAudioAccompany (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setAudioAccompanyVolume：设置混音音量，需要在调用startAudioAccompany后才能生效。
    setAudioAccompanyVolume (volume: number): number;
    参数说明
    参数 类型 描述
    volume number 混音音量，取值范围：[0,100]。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setAudioAccompanyPublishVolume：设置混音之后推流出去的音量，需要在调用startAudioAccompany后才能生效。
    setAudioAccompanyPublishVolume (volume: number): number;
    参数说明
    参数 类型 描述
    volume number 混音音量，取值范围：[0,100]。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • getAudioAccompanyPublishVolume：获取推流出去的混音音量。
    getAudioAccompanyPublishVolume (): number;
    返回说明

    返回推流出去的混音音量。

  • setAudioAccompanyPlayoutVolume：设置混音之后本地播放的音量，需要在调用startAudioAccompany后才能生效。
    setAudioAccompanyPlayoutVolume (volume: number): number;
    参数说明
    参数 类型 描述
    volume number 混音音量，取值范围：[0,100]。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • getAudioAccompanyPlayoutVolume：获取混音本地播放的音量。
    getAudioAccompanyPlayoutVolume (): number;
    返回说明

    返回当前混音本地播放的音量。

  • pauseAudioAccompany：暂停混音。
    pauseAudioAccompany (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • resumeAudioAccompany：重新开始混音。
    resumeAudioAccompany (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • getAudioAccompanyDuration：获取伴奏文件时长。
    getAudioAccompanyDuration (): number;
    返回说明

    返回当前伴奏文件时长，单位为毫秒。

  • getAudioAccompanyCurrentPosition：获取音乐文件播放进度。
    getAudioAccompanyCurrentPosition (): number;
    返回说明

    返回当前音乐文件播放进度，单位为毫秒。

  • setAudioAccompanyPosition：设置音频文件的播放位置。
    setAudioAccompanyPosition (pos: number): number;
    参数说明
    参数 类型 描述
    pos number 进度条位置，单位为毫秒。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • enableSystemAudioRecording：设置是否开启系统声音采集推送。
    enableSystemAudioRecording (enable: boolean, path: string): number;
    参数说明
    参数 类型 描述
    enable boolean 是否开启系统声音采集推送。取值：
    • true：开启。
    • false：关闭。
    path string Windows端需要设置为第三方播放器路径；Mac需要设置为虚拟声卡设备名才能采集系统声音，关闭时需要传入要切换回的扬声器名称。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • isSystemAudioRecording：当前是否开启系统声音采集推送。
    isSystemAudioRecording (): boolean;
    返回说明

    true表示方法调用成功，false表示方法调用失败。

  • setSystemAudioRecordingVolume：设置系统声音采集推送音量。
    setSystemAudioRecordingVolume (volume: number): number;
    参数说明
    参数 类型 描述
    volume number 设置音量。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • getSystemAudioRecordingVolume：获取当前设置系统声音采集推送音量。
    getSystemAudioRecordingVolume (): number;
    说明 需要开启系统声音采集推送后才能设置，否则设置失败。
    返回说明

    返回系统音量。

  • getAudioCaptureList：获取系统中的录音设备列表。
    getAudioCaptureList(): AliEngineDeviceInfo[];
    返回说明

    返回系统中的录音设备列表。

  • getCurrentAudioCaptureName：获取使用的录音设备名称。
    getCurrentAudioCaptureName(): string;
    返回说明

    返回当前音频采集设备名。

  • getCurrentAudioCaptureID：获取使用的录音设备ID。
    getCurrentAudioCaptureID (): string;
    返回说明

    返回当前音频采集设备ID。

  • setCurrentAudioCaptureName：选择录音设备名称。
    setCurrentAudioCaptureName(captureName: string): number;
    参数说明
    参数 类型 描述
    captureName string 音频采集设备名称。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setCurrentAudioCaptureID：选择录音设备ID。
    setCurrentAudioCaptureID (captureID: string): number;
    参数说明
    参数 类型 描述
    captureID string 音频采集设备名称。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • getAudioPlayerList：获取系统中的扬声器列表。
    getAudioPlayerList (): AliEngineDeviceInfo[];
    返回说明

    返回音频播放设备列表。

  • getCurrentAudioPlayerName：获取当前使用的扬声器名称。
    getCurrentAudioPlayerName (): string;
    返回说明

    返回当前音频播放设备名。

  • getCurrentAudioPlayerID：获取当前使用的扬声器ID。
    getCurrentAudioPlayerID (): string;
    返回说明

    返回当前音频播放设备ID。

  • setCurrentAudioPlayerName：选择扬声器名称。
    setCurrentAudioPlayerName (playerName: string): number;
    参数说明
    参数 类型 描述
    playerName string 音频播放设备名称。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setCurrentAudioPlayerID：选择扬声器ID。
    setCurrentAudioPlayerID (playerID: string): number;
    参数说明
    参数 类型 描述
    playerID string 音频播放设备ID。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • startTestAudioRecordByName：开始测试音频采集设备。
    startTestAudioRecordByName (deviceName: string, callbackInterval: number): number;
    参数说明
    参数 类型 描述
    deviceName string 音频采集设备名称。
    callbackInterval number 音量回调频率，单位：毫秒，默认值200毫秒。
    说明 开始测试后音量信息通过onAudioDeviceRecordLevel回调返回。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • startTestAudioRecordById：开启麦克风设备测试（按设备ID）。
    startTestAudioRecordById (deviceId: string, callbackInterval: number): number;
    参数说明
    参数 类型 描述
    deviceId string 设备ID。
    callbackInterval number 音量回调频率，单位：毫秒，默认值200毫秒。
    说明 开始测试后音量信息通过onAudioDeviceRecordLevel回调返回。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • stopTestAudioRecord：停止测试音频采集设备。
    stopTestAudioRecord (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • startTestAudioPlayoutByName：开始测试音频播放设备。
    startTestAudioPlayoutByName (deviceName: string, filePath: string, callbackInterval: number, loopCycles: number): number;
    参数说明
    参数 类型 描述
    deviceName string 音频播放设备名称。
    filePath string 音频文件路径。
    callbackInterval number 音量回调频率，单位：毫秒，默认值200毫秒。
    loopCycles number 重复播放次数，-1表示循环播放。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • startTestAudioPlayoutById：开启扬声器设备测试（按设备ID）。
    startTestAudioPlayoutById (deviceId: string, filePath: string, callbackInterval: number, loopCycles: number): number;
    参数说明
    参数 类型 描述
    deviceId string 设备ID。
    filePath string 音频文件路径。
    callbackInterval number 音量回调频率，单位：毫秒，默认值200毫秒。
    loopCycles number 重复播放次数，-1表示循环播放。
    说明 开始测试后音量信息通过onAudioDevicePlayoutLevel回调返回。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • stopTestAudioPlayout：停止测试音频播放设备。
    stopTestAudioPlayout (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • getCameraList：获取摄像头列表。
    getCameraList (): AliEngineDeviceInfo [];
    返回说明

    返回摄像头列表。

  • getCurrentCameraName：获取当前使用的摄像头名称。
    getCurrentCameraName (): string;
    返回说明

    返回当前使用的摄像头名称。

  • getCurrentCameraID：获取当前使用的摄像头ID。
    getCurrentCameraID (): string;
    返回说明

    返回当前使用的摄像头ID。

  • setCurrentCameraName：选择摄像头名称。
    setCurrentCameraName (cameraName: string): number;
    参数说明
    参数 类型 描述
    cameraName string 摄像头名称。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • setCurrentCameraID：选择摄像头ID。
    setCurrentCameraID (cameraID: string): number;
    参数说明
    参数 类型 描述
    cameraID string 摄像头ID。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • startPreview：开启预览。
    startPreview (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • stopPreview：停止预览。
    startPreview (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • getUserInfo：查询远端用户信息。
    getUserInfo (uid: string): AliEngineUserInfo;
    参数说明
    参数 类型 描述
    uid string 用户ID。
    返回说明

    返回用户信息AliEngineUserInfo。

  • getSDKVersion：获取SDK版本号。
    getSDKVersion (): string;
    返回说明

    返回SDK版本号。

  • setClientRole：设置用户角色。
    setClientRole (clientRole: AliEngineClientRole): number;
    参数说明
    参数 类型 描述
    clientRole AliEngineClientRole 用户角色类型，默认值为AliEngineClientRoleLive（观众角色），非通信模式下角色类型才有效。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • getClientRole：获取用户角色。
    getClientRole (): AliEngineClientRole;
    返回说明

    返回当前用户角色。

  • startLastmileDetect：开始网络质量探测。
    startLastmileDetect (): number;
    说明 此接口需在joinChannel之前调用，探测结果在onLastmileDetectResultWithQuality回调。
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • stopLastmileDetect：停止网络质量探测。
    stopLastmileDetect (): number;
    返回说明

    0表示方法调用成功，其他表示方法调用失败。

  • getCurrentConnectionStatus：获取当前网络链接状态。
    getCurrentConnectionStatus (): AliEngineConnectionStatus;
    返回说明

    返回当前网络连接状态AliEngineConnectionStatus。

  • on：订阅事件。
    on(event: string, handler: function): void;
    参数说明
    参数 类型 描述
    event string 事件名称。
    handler function 回调函数。
  • off：取消订阅事件。
    off(event: string, handler: function): void;
    参数说明
    参数 类型 描述
    event string 事件名称。
    handler function 回调函数。