AliRtcEngine接口

查询SDK当前版本号

public static getSDKVersion(): string

返回说明

string - 当前的SDK版本号，格式为字符串，例："7.10.0"

设置H5兼容模式

public static setH5CompatibleMode(enable: boolean): void

参数说明

参数	类型	描述
enable	boolean	true: 兼容H5；false: 传统模式，不兼容H5

获取H5兼容模式设置

public static getH5CompatibleMode(): boolean

返回说明

boolean - true: 兼容H5；false: 传统模式，不兼容H5

设置自身相关监听事件回调

public setRtcEngineEventListener(listener: AliRtcEngineEventListener | null) : void

参数说明

参数	类型	描述
listener	AliRtcEngineEventListener | null	用于接收来自engine的消息

获取Native层实例句柄

public getNativeHandle() : number

返回说明

number - Native层实例句柄

设置频道模式

public setChannelProfile(channelProfile: AliRtcChannelProfile): number

参数说明

参数	类型	描述
channelProfile	AliRtcChannelProfile	频道模式类型，详细请参考 AliRtcChannelProfile

返回说明

number - 0: 成功；<0: 失败

设置直播场景 AliRtcClientRole 设置为对应的用户角色

public setClientRole(clientRole: AliRtcClientRole): number

参数说明

参数	类型	描述
clientRole	AliRtcClientRole	用户角色类型，详细请参考 AliRtcClientRole

返回说明

number - 0: 成功；<0: 失败

获取当前用户角色

public getCurrentClientRole(): AliRtcClientRole

返回说明

AliRtcClientRole - 当前用户角色类型，详细请参考 AliRtcClientRole

该方法让用户加入频道，一个频道内可以加入多个用户进行互相通话

public joinChannel(authInfo: AliRtcEngineAuthInfo, userName: string) : number

参数说明

参数	类型	描述
authInfo	AliRtcEngineAuthInfo	认证信息，从App Server获取
userName	string	任意用于显示的用户名称。不是User ID

返回说明

number - 0: 成功；<0: 失败

加入频道

public joinChannelWithToken(token: string, channelId: string, userId: string, userName: string): number

参数说明

参数	类型	描述
token	string	认证信息，从App Server获取
channelId	string	入会频道，必须和产生token时一样；可以不传，此时会默认使用产生token的channelId
userId	string	入会的userid，必须和产生token时一样；可以不传，此时会默认使用产生token的userId
userName	string	任意用于显示的用户名称，不是User ID；可以不传,标识没有userName

返回说明

number - 0: 成功；<0: 失败

加入频道

public joinChannelWithChannelParam(token: string,  channelParam: AliRtcSDKChannelParam) : number

参数说明

参数	类型	描述
token	string	认证信息，从App Server获取
channelParam	AliRtcSDKChannelParam	入会参数，详见 AliRtcSDKChannelParam

返回说明

number - 0: 成功；<0: 失败

加入AI频道

public joinAIChannel(token: string, channelParam: AliRtcSDKChannelParam, agentParam: AliRtcSDKAIAgentParam) : number

参数说明

参数	类型	描述
token	string	认证信息，从App Server获取
channelParam	AliRtcSDKChannelParam	入会参数，详见 AliRtcSDKChannelParam
agentParam	AliRtcSDKAIAgentParam	入会参数，详见 AliRtcSDKAIAgentParam

返回说明

number - 0: 成功；<0: 失败

离开频道,即挂断或者停止童话

public leaveChannel(): number

返回说明

number - 0: 成功；非0: 失败

获取当前网络链接状态

public getCurrentConnectionStatus(): AliRtcConnectionStatus

返回说明

AliRtcConnectionStatus - 当前链接状态

获取状态：当前是否在频道中

public isInCall(): boolean

返回说明

boolean - true: 表示当前已经加入了频道；false: 表示当前不在频道中

刷新鉴权信息

public refreshAuthInfo(authInfo: AliRtcEngineAuthInfo): number

参数说明

参数	类型	描述
authInfo	AliRtcEngineAuthInfo	鉴权信息

返回说明

number - 0: 成功；<0: 失败

刷新鉴权信息

public refreshAuthInfoWithToken(token: string): number

参数说明

参数	类型	描述
token	string	鉴权token信息；channelid、userid必须和入会时一致

返回说明

number - 0: 成功；<0: 失败

查询是否纯音频模式

public isAudioOnlyMode(): boolean

返回说明

boolean - true: 表示纯音频模式；false: 表示非纯音频模式

是否推送本地视频（摄像头）流

public publishLocalVideoStream(enabled: boolean): number

参数说明

参数	类型	描述
enabled	boolean	是否开启/关闭本地视频流推送；true: 开启视频流推送；false: 关闭视频流推送

返回说明

number - 0: 设置成功；<0: 设置失败，返回错误码

查询是否设置推送视频流

public isLocalVideoStreamPublished(): boolean

返回说明

boolean - true: 已设置推送；false: 未设置推送

是否推送次要视频流

public publishLocalDualVideoStream(enable: boolean): number

参数说明

参数	类型	描述
enable	boolean	是否开启/关闭次要视频流推送；true: 开启次要视频流推送；false: 关闭次要视频流推送

返回说明

number - 0: 设置成功；<0: 设置失败，返回错误码

查询当前是否设置推送次要视频流

public isLocalDualVideoStreamPublished(): boolean

返回说明

boolean - true: 已设置推送；false: 未设置推送

是否推送本地音频流

public publishLocalAudioStream(enabled: boolean): number

参数说明

参数	类型	描述
enabled	boolean	是否开启/关闭本地音频流推送；true: 开启音频流推送；false: 关闭音频流推送

返回说明

number - 0: 设置成功；<0: 设置失败，返回错误码

查询是否设置推送音频流

public isLocalAudioStreamPublished(): boolean

返回说明

boolean - true: 已设置推送；false: 未设置推送

是否推送次要音频流

public publishLocalDualAudioStream(enabled: boolean): number

参数说明

参数	类型	描述
enabled	boolean	是否开启

返回说明

number - 0: 设置成功；<0: 设置失败，返回错误码

查询是否设置推送第二条音频流

public isLocalDualAudioStreamPublished(): boolean

返回说明

boolean - true: 已设置推送；false: 未设置推送

设置是否默认接收音频流

public setDefaultSubscribeAllRemoteAudioStreams(sub: boolean): number

参数说明

参数	类型	描述
sub	boolean	true: 接收用户的音频流；false: 停止接收用户的音频流

返回说明

number - 0: 成功；非0: 失败

设置是否默认订阅视频流

public setDefaultSubscribeAllRemoteVideoStreams(sub: boolean): number

参数说明

参数	类型	描述
sub	boolean	是否默认订阅视频流；true：（Default）默认订阅视频流；false：默认不订阅视频流

返回说明

number - 0: 设置成功；<0: 设置失败

设置订阅的相机流格式，大流或小流

public setRemoteVideoStreamType(uid: string, streamType: AliRtcVideoStreamType): number

参数说明

参数	类型	描述
uid	string	远端用户ID
streamType	AliRtcVideoStreamType	流类型

返回说明

number - 0: 成功；非0: 失败

设置默认订阅的相机流格式，大流或小流

public setRemoteDefaultVideoStreamType(streamType: AliRtcVideoStreamType): number

参数说明

参数	类型	描述
streamType	AliRtcVideoStreamType	流类型

返回说明

number - 0: 成功；非0: 失败

停止/恢复接收所有远端音频流

public subscribeAllRemoteAudioStreams(sub: boolean): number

参数说明

参数	类型	描述
sub	boolean	true: 接收所有用户的音频流；false: 停止接收所有用户的音频流

返回说明

number - 0: 成功；非0: 失败

停止/恢复接收远端第二条音频流

public subscribeAllRemoteDualAudioStreams(sub: boolean): number

参数说明

参数	类型	描述
sub	boolean	true: 接收远端第二条音频流；false: 停止接收远端第二条音频流

返回说明

number - 0: 成功；非0: 失败

停止/恢复接收所有远端视频流

public subscribeAllRemoteVideoStreams(sub: boolean): number

参数说明

参数	类型	描述
sub	boolean	true: 接收所有用户的视频流；false: 停止允许接收所有用户的视频流

返回说明

number - 0: 成功；非0: 失败

停止/恢复订阅麦克风音频流

public subscribeRemoteAudioStream(uid: string, sub: boolean): number

参数说明

参数	类型	描述
uid	string	uid
sub	boolean	true: 接收指定用户的音频流；false: 停止接收指定用户的音频流

返回说明

number - 0: 成功；非0: 失败

停止/恢复订阅特定远端用户的音频流

public subscribeRemoteAudioStreamByTrack(uid: string, track: AliRtcAudioTrack, sub: boolean): number

参数说明

参数	类型	描述
uid	string	uid
track	AliRtcAudioTrack	音频流类型；AliRtcAudioTrackNo: 无效参数，设置不会有任何效果；AliRtcAudioTrackMic: 麦克风流；AliRtcAudioTrackDual: 第二条音频流；AliRtcAudioTrackBoth: 麦克风流和第二条音频流
sub	boolean	是否订阅远端用户的音频流；true:订阅指定用户的音频流；false:停止订阅指定用户的音频流

返回说明

number - 0: 成功；非0: 失败

停止/恢复订阅视频流

public subscribeRemoteVideoStream(uid: string, track: AliRtcVideoTrack, sub: boolean): number

参数说明

参数	类型	描述
uid	string	uid
track	AliRtcVideoTrack	视频流类型
sub	boolean	true: 接收指定用户的视频流；false: 停止接收指定用户的视频流

返回说明

number - 0: 成功；非0: 失败

停止/恢复订阅远端音视频流

public subscribeRemoteMediaStream(uid: string, videoTrack: AliRtcVideoTrack, subVideo: boolean, audioTrack: AliRtcAudioTrack, subAudio: boolean): number

参数说明

参数	类型	描述
uid	string	uid
videoTrack	AliRtcVideoTrack	视频流类型
subVideo	boolean	是否订阅视频
audioTrack	AliRtcAudioTrack	音频流类型
subAudio	boolean	是否订阅音频

返回说明

number

订阅目标频道，指定用户的流

public subscribeRemoteDestChannelStream(channelId: string, uid: string, videoTrack: AliRtcVideoTrack, audioTrack: AliRtcAudioTrack, sub: boolean): number

参数说明

参数	类型	描述
channelId	string	目标频道
uid	string	远端用户ID
videoTrack	AliRtcVideoTrack	视频流类型；AliRtcVideoTrackNo: 取消所有的视频流，不受sub值影响；AliRtcVideoTrackCamera: 相机流；AliRtcVideoTrackScreen: 屏幕共享流；AliRtcVideoTrackBoth: 相机流和屏幕共享流
audioTrack	AliRtcAudioTrack	音频流类型；AliRtcAudioTrackNo: 取消所有的音频流，不受sub值影响；AliRtcAudioTrackMic: 麦克风流；AliRtcAudioTrackDual: Dual音频流；AliRtcAudioTrackBoth: 麦克风流 + Dual音频流
sub	boolean	是否订阅远端用户的流；true：订阅指定用户的流；false：停止订阅指定用户的流

返回说明

number - 0: 成功；非0: 失败

设置音频profile

public setAudioProfile(profile: AliRtcAudioProfile, scenario: AliRtcAudioScenario): number

参数说明

参数	类型	描述
profile	AliRtcAudioProfile	音频采集/编码模式参数, 详见 AliRtcAudioProfile
scenario	AliRtcAudioScenario	音频场景模式参数,详见 AliRtcAudioScenario

返回说明

number - 0: 成功；其他: 失败

设置音频能力

public SetAudioCapability(ability: AliRtcAudioCapability): number

参数说明

参数	类型	描述
ability	AliRtcAudioCapability	能力项

返回说明

number - 0: 成功；非0: 失败

开启音频采集

public startAudioCapture(): number

返回说明

number - 0: 成功；非0: 返回错误码

开启音频采集

public stopAudioCapture(): number

返回说明

number - 0: 成功；非0: 返回错误码

开启音频播放设备

public startAudioPlayer(): number

返回说明

number - 0: 成功；非0: 返回错误码

关闭音频播放

public stopAudioPlayer(): number

返回说明

number - 0: 成功；非0: 返回错误码

停止/恢复本地音频数据发送

public muteLocalMic(mute: boolean, mode:  AliRtcMuteLocalAudioMode): number

参数说明

参数	类型	描述
mute	boolean	true表示静音本地音频，发送静音帧; false表示取消静音
mode	AliRtcMuteLocalAudioMode	静音模式，静音模式分三种, 默认模式为静音本地麦克风采集音频和所有外部输入音频

返回说明

number - 0: 成功；非0: 失败

设置录音音量

public setRecordingVolume(volume: number): number

参数说明

参数	类型	描述
volume	number	录音音量，取值范围[0,400] 0：静音；>100：放大音量；<100：减小音量

返回说明

number - 0: 成功；非0: 失败

设置播放音量

public setPlayOutVolume(volume: number): number

参数说明

参数	类型	描述
volume	number	播放音量，取值范围[0,400] 0：静音; >100：放大音量； <100：减小音量

返回说明

number - 0: 成功；非0: 失败

设置默认音频输出是否从扬声器出声，默认从扬声器出声

public setDefaultAudioRouteToSpeakerphone(defaultToSpeakerphone: boolean): number

参数说明

参数	类型	描述
defaultToSpeakerphone	boolean	true：扬声器模式（默认扬声器）；false：听筒模式

返回说明

number - 0: 成功；<0: 失败

设置音频输出为听筒还是扬声器

public enableSpeakerphone(enable: boolean): number

参数说明

参数	类型	描述
enable	boolean	true：扬声器模式；false：听筒模式（默认听筒）

返回说明

number - 0: 成功；非0: 失败

获取当前音频输出为听筒还是扬声器

public isSpeakerOn(): boolean

返回说明

boolean

调节本地播放的指定远端用户音量

public setRemoteAudioVolume(uid: string, volume: number): number

参数说明

参数	类型	描述
uid	string	远端用户ID
volume	number	播放音量，取值范围[0,100] 0：静音；100：原始音量

返回说明

number - 0: 成功；非0: 失败

停止/恢复远端指定用户的音频流的播放

public muteRemoteAudioPlaying(uid: string, mute: boolean): number

参数说明

参数	类型	描述
uid	string	远端用户ID
mute	boolean	true: 停止播放；false: 恢复播放

返回说明

number - 0: 成功；非0: 失败

停止/恢复远端的所有音频流的播放

public muteAllRemoteAudioPlaying(mute: boolean): number

参数说明

参数	类型	描述
mute	boolean	true: 停止播放；false: 恢复播放

返回说明

number - 0: 成功；非0: 失败

设置音量回调频率和平滑系数

public enableAudioVolumeIndication(interval: number, smooth: number, reportVad: number): number

参数说明

参数	类型	描述
interval	number	时间间隔，单位毫秒，最小值不得小于10ms, 建议设置300-500ms, <= 0表示不启用音量提示和说话人提示功能
smooth	number	平滑系数，数值越大平滑程度越高，反之越低，实时性越好，建议设置3，范围[0, 9]
reportVad	number	说话人检测开关；1: 开启；0: 关闭

返回说明

number - 0: 成功；<0: 失败

启用耳返

public enableEarBack(enable: boolean): number

参数说明

参数	类型	描述
enable	boolean	是否启用耳返 true：开启； false：关闭；默认：关闭

返回说明

number - 0：成功；非0：失败

设置耳返音量

public setEarBackVolume(volume: number): number

参数说明

参数	类型	描述
volume	number	音量大小，范围是：[0 ~ 100]，默认值为100

返回说明

number - 0：成功；非0：失败

通话前，开启音频采集设备检测

public startAudioCaptureTest(): number

返回说明

number - 0: 成功；非0: 失败

关闭音频采集检测

public stopAudioCaptureTest(): number

返回说明

number - 0: 成功；非0: 返回错误码

测试播放音频文件

public playAudioFileTest(filePath: string): number

参数说明

参数	类型	描述
filePath	string	文件路径

返回说明

number - =0 成功；非0: 失败

停止测试播放音频文件

public stopAudioFileTest(): number

返回说明

number - =0 成功；非0: 失败

设置本地预览显示视图

public setLocalViewConfig(canvas: AliRtcVideoCanvas, xComponentController: AliRtcXComponentController | null, track: AliRtcVideoTrack): number

参数说明

参数	类型	描述
canvas	AliRtcVideoCanvas	本地视频显示属性
xComponentController	AliRtcXComponentController | null	XComponent视图绑定的Controller
track	AliRtcVideoTrack	视频流类型

开启本地视频预览

public startPreview(): number

返回说明

number - 0: 成功；非0: 失败

关闭本地视频预览

public stopPreview(): number

返回说明

number - 0: 成功；非0: 失败

设置摄像头采集偏好

public setCameraCaptureConfiguration(cameraCaptureConfiguration: AliRtcCameraCaptureConfiguration): number

参数说明

参数	类型	描述
cameraCaptureConfiguration	AliRtcCameraCaptureConfiguration	采集偏好；preference: AliRtcCaptureOutputPreferencePreview 高清预览，采集优先保证视频预览质量；AliRtcCaptureOutputPreferencePerformance 采集选择最接近推流的分辨率，优先保证设备性能；AliRtcCaptureOutputPreferenceAuto 自动调整采集分辨率；cameraDirection: 设置采集方向，前置或后置

返回说明

number - 0: 成功；非0: 失败

禁用或启用本地视频采集

public enableLocalVideo(enabled: boolean): number

参数说明

参数	类型	描述
enabled	boolean	true : 启用本地视频采集；false : 禁用本地视频采集

返回说明

number - 0: 成功；非0: 失败

停止/恢复本地摄像头采集

public enableVideoCapture(enabled: boolean): number

参数说明

参数	类型	描述
enabled	boolean	false表示关闭摄像头采集，true表示开启摄像头采集

返回说明

number - 0: 成功；非0: 失败

停止/恢复本地视频数据发送

public muteLocalCamera(mute: boolean, track: AliRtcVideoTrack): number

参数说明

参数	类型	描述
mute	boolean	true表示视频数据发送黑帧；false表示恢复正常
track	AliRtcVideoTrack	只支持AliRtcVideoTrackCamera

返回说明

number - 0: 成功；非0: 失败

检查当前是否打开摄像头

public isCameraOn(): boolean

返回说明

boolean - true: 表示已开启；false: 表示未开启

停止/恢复远端所有视频track渲染

public muteAllRemoteVideoRendering(mute: boolean): number

参数说明

参数	类型	描述
mute	boolean	true: 停止渲染，所有视频为黑帧；false: 恢复渲染

返回说明

number - 0: 成功；非0: 失败

设置相机流视频编码属性

public setVideoEncoderConfiguration(config: AliRtcVideoEncoderConfiguration): number

参数说明

参数	类型	描述
config	AliRtcVideoEncoderConfiguration	预定义的编码属性，详见 AliRtcVideoEncoderConfiguration

返回说明

number - 0: 成功；<0: 失败

设置相机流视频解码属性

public setVideoDecoderConfiguration(config: AliRtcVideoDecoderConfiguration): void

参数说明

参数	类型	描述
config	AliRtcVideoDecoderConfiguration	预定义的解码属性，详见 AliRtcVideoDecoderConfiguration

设置预览和推流镜像能力

public setVideoMirrorMode(mirrorMode: AliRtcVideoPipelineMirrorMode): number

参数说明

参数	类型	描述
mirrorMode	AliRtcVideoPipelineMirrorMode	设置镜像的模式

返回说明

number - 0: 设置成功；<0: 设置失败

设置采集缩放时机，视频数据是采集的时候立即缩放还是编码时才进行缩放

public setCapturePipelineScaleMode(mode: AliRtcCapturePipelineScaleMode): void

参数说明

参数	类型	描述
mode	AliRtcCapturePipelineScaleMode	控制采集缩放时机的模式，默认是采集的时候立即缩放

设置远端视频显示视图

public setRemoteViewConfig(canvas: AliRtcVideoCanvas, xComponentController: AliRtcXComponentController | null, uid: string, track: AliRtcVideoTrack): number

参数说明

参数	类型	描述
canvas	AliRtcVideoCanvas	本地视频显示属性
xComponentController	AliRtcXComponentController | null	XComponent视图绑定的Controller
uid	string	远端用户ID
track	AliRtcVideoTrack	只支持 AliRtcVideoTrackCamera 和 AliRtcVideoTrackScreen

返回说明

number - 0 : 成功；< 0 : 失败

切换前后摄像头

public switchCamera(): number

返回说明

number - 0: 成功；非0: 失败

获取当前摄像头方向（前/后摄像头）

public getCurrentCameraDirection(): AliRtcCameraDirection

返回说明

AliRtcCameraDirection - 摄像头方向

设置摄像头缩放比例

public setCameraZoom(zoom: number): number

参数说明

参数	类型	描述
zoom	number	缩放比例

返回说明

number - 0: 成功；非0: 失败

获取摄像头最大缩放比例

public getCameraMaxZoomFactor(): number

返回说明

number - 摄像头最大缩放比例

获取摄像头缩放比例

public getCurrentZoom(): number

返回说明

number - 摄像头缩放比例

设置摄像头曝光度

public setExposure(exposure: number): number

参数说明

参数	类型	描述
exposure	number	曝光度

返回说明

number - 0: 成功；非0: 失败

获取摄像头曝光度

public getCurrentExposure(): number

返回说明

number - 摄像头曝光度

获取摄像头最小曝光度

public getMinExposure(): number

返回说明

number - 摄像头最小曝光度

获取摄像头最大曝光度

public getMaxExposure(): number

返回说明

number - 摄像头最大曝光度

设置摄像头闪光灯是否打开

public setCameraFlash(flash: boolean): number

参数说明

参数	类型	描述
flash	boolean	是否允许闪光灯

返回说明

number - 0: 成功；非0: 失败

摄像头是否支持手动聚焦

public isCameraFocusPointSupported(): boolean

返回说明

boolean - true: 支持；false: 不支持

摄像头是否支持设置曝光区域

public isCameraExposurePointSupported(): boolean

返回说明

boolean - true: 支持；false: 不支持

设置摄像头手动聚焦

public setCameraFocusPoint(x: number, y: number): number

参数说明

参数	类型	描述
x	number	聚焦点x坐标
y	number	聚焦点y坐标

返回说明

number - 0: 成功；非0: 失败

设置摄像头曝光点

public setCameraExposurePoint(x: number, y: number): number

参数说明

参数	类型	描述
x	number	聚焦点x坐标
y	number	聚焦点y坐标

返回说明

number - 0: 成功；非0: 失败

获取视频编解码格式

public getVideoCodecType(codeKind: AliRtcVideoCodecKindType): AliRtcVideoFormat

参数说明

参数	类型	描述
codeKind	AliRtcVideoCodecKindType	视频codec类型：编码/解码

返回说明

AliRtcVideoFormat - 0: 成功；非0: 失败

获取当前使用的编码器类型,如未开始推流，返回无效类型

public getCurrentEncoderManufacturer(track: AliRtcVideoTrack): AliRtcVideoCodecManufacturer

参数说明

参数	类型	描述
track	AliRtcVideoTrack	AliRtcVideoTrack

返回说明

AliRtcVideoCodecManufacturer - 编码器类型

视频截图功能

public snapshotVideo(userId: string, trackType: AliRtcVideoTrack): number

参数说明

参数	类型	描述
userId	string	用户ID， userId 为""代表本地用户
trackType	AliRtcVideoTrack	视频流类型，只支持AliRtcVideoTrackCamera和AliRtcVideoTrackScreen

返回说明

number - 0 : 仅代表调用该接口成功，是否获取到截图画面，详细见 AliRtcEngineEventListener#onSnapshotCompleted；< 0 : 失败

设置屏幕流视频编码属性

public setScreenShareEncoderConfiguration(config: AliRtcScreenShareEncoderConfiguration): number

参数说明

参数	类型	描述
config	AliRtcScreenShareEncoderConfiguration	预定义的编码属性

开启屏幕帧监听

public startScreenShare(mode: AliRtcScreenShareMode): number

参数说明

参数	类型	描述
mode	AliRtcScreenShareMode	屏幕共享模式

停止屏幕共享

public stopScreenShare(): number

返回说明

number - 0: 成功；非0: 失败

查询是否设置推送屏幕分享

public isScreenSharePublished(): boolean

返回说明

boolean - true: 已设置推送；false: 未设置推送

注册音频数据回调

public registerAudioFrameObserver(observer: AliRtcEngineAudioFrameListener | null): void

参数说明

参数	类型	描述
observer	AliRtcEngineAudioFrameListener | null	音频数据回调，设置为空，则停止回调数据

订阅音频数据

public enableAudioFrameObserver(enable: boolean, audioSource: AliRtcAudioSource, config: AliRtcAudioFrameObserverConfig | null): number

参数说明

参数	类型	描述
enable	boolean	是否允许数据回调
audioSource	AliRtcAudioSource	音频裸数据源类型，详见 AliRtcAudioSource
config	AliRtcAudioFrameObserverConfig | null	回调参数设置，详见 AliRtcAudioFrameObserverConfig, null时默认参数为48000，1，ReadOnly

返回说明

number - 0: success

新增外部音频流

public addExternalAudioStream(config: AliRtcExternalAudioStreamConfig): number

参数说明

参数	类型	描述
config	AliRtcExternalAudioStreamConfig	外部音频流配置 详见 AliRtcExternalAudioStreamConfig

返回说明

number - >0: 外部音频流Id；<0: 失败

输入外部音频数据

public pushExternalAudioStreamRawData(streamId: number, audioFrame: AliRtcAudioFrame): number

参数说明

参数	类型	描述
streamId	number	外部音频流Id
audioFrame	AliRtcAudioFrame	外部音频裸数据

返回说明

number - <0: 表示失败; 0: 表示成功; 返回值为 AliRtcErrorCode.ERR_SDK_AUDIO_INPUT_BUFFER_FULL 时，需要在间隔投递数据时间长度后再次重试投递

设置外部音频流播放音量

public setExternalAudioStreamPlayoutVolume(streamId: number, volume: number): number

参数说明

参数	类型	描述
streamId	number	外部音频流Id
volume	number	音量 0-100

返回说明

number - 0: 成功；非0: 失败

获取外部音频流播放音量

public getExternalAudioStreamPlayoutVolume(streamId: number): number

参数说明

参数	类型	描述
streamId	number	外部音频流Id

返回说明

number - [0, 100]: 播放音量；< 0: 失败

设置外部音频流推流音量

public setExternalAudioStreamPublishVolume(streamId: number, volume: number): number

参数说明

参数	类型	描述
streamId	number	外部音频流Id
volume	number	音量 0-100

返回说明

number - 0: 成功；非0: 失败

获取外部音频流推流音量

public getExternalAudioStreamPublishVolume(streamId: number): number

参数说明

参数	类型	描述
streamId	number	外部音频流Id

返回说明

number - [0, 100]: 推流音量；< 0: 失败

移除外部音频流

public removeExternalAudioStream(streamId: number): number

参数说明

参数	类型	描述
streamId	number	外部音频流Id

返回说明

number - 0: 成功；非0: 失败

启用外部视频输入源

setExternalVideoSource(enable: boolean, streamType: AliRtcVideoTrack, renderMode: AliRtcRenderMode): void

参数说明

参数	类型	描述
enable	boolean	true 开启；false 关闭
streamType	AliRtcVideoTrack	流类型 AliRtcVideoTrack；AliRtcVideoTrackCamera 外部输入视频数据走相机流通道，如果当前相机采集打开中，调用该接口设置enable为true，sdk会替换掉相机采集；AliRtcVideoTrackScreen 外部输入视频数据走屏幕流通道，如果当前屏幕共享采集打开中，调用该接口设置enable为true，sdk会替换掉屏幕共享采集
renderMode	AliRtcRenderMode	处理模式，外部输入视频源宽高比和推流profile不一致时，会按照对应的renderMode做对应处理，详见 AliRtcRenderMode；AliRtcRenderModeAuto 自动（默认），如果外部输入的视频宽高比和推流设置的宽高比不一致时，维持外部输入的视频宽高比，等比例缩放宽高到推流设置的宽高范围内，注意此模式下为了保证原始视频的比例和内容完整性，会导致实际推流的分辨率和设置的不一致；AliRtcRenderModeStretch 拉伸平铺，如果外部输入的视频宽高比和推流设置的宽高比不一致时，将输入视频拉伸到推流设置的比例，画面会变形；AliRtcRenderModeFill 填充黑边，如果外部输入的视频宽高比和推流设置的宽高比不一致时，将输入视频上下或者左右填充黑边；AliRtcRenderModeCrop 裁剪，如果外部输入的视频宽高比和推流设置的宽高比不一致时，将输入视频宽或者高进行裁剪，画面内容会丢失

返回说明

void

输入视频数据

pushExternalVideoFrame(videoFrame: AliRtcVideoFrame, streamType: AliRtcVideoTrack): number

参数说明

参数	类型	描述
videoFrame	AliRtcVideoFrame	帧数据，详见 AliRtcVideoFrame
streamType	AliRtcVideoTrack	流类型，详见 AliRtcVideoTrack；AliRtcVideoTrackCamera 外部输入视频数据走相机流通道；AliRtcVideoTrackScreen 外部输入视频数据走屏幕流通道

返回说明

number - 0: 成功；非0: 失败

输入视频数据

setExternalImageData(rawData: AliRtcVideoFrame, streamType: AliRtcVideoTrack): number

参数说明

参数	类型	描述
rawData	AliRtcVideoFrame	帧数据，详见 AliRtcVideoFrame
streamType	AliRtcVideoTrack	流类型，详见 AliRtcVideoTrack；AliRtcVideoTrackCamera 外部输入视频数据走相机流通道；AliRtcVideoTrackScreen 外部输入视频数据走屏幕流通道

返回说明

number - 0: 成功；非0: 失败

设置变调参数

public setAudioEffectPitchValue(value: number): number

参数说明

参数	类型	描述
value	number	变调参数，范围：[0.5, 2.0]，1.0表示音调不变，小于1.0表示音调降低，大于1.0表示音调升高，默认1.0

返回说明

number - 0：成功；非0：失败

设置变声音效模式

public setAudioEffectVoiceChangerMode(mode: AliRtcAudioEffectVoiceChangerMode): number

参数说明

参数	类型	描述
mode	AliRtcAudioEffectVoiceChangerMode	参考 AliRtcAudioEffectVoiceChangerMode 对应的变声音效模式值

返回说明

number - 0：成功；非0：失败

设置混响音效模式

public setAudioEffectReverbMode(mode: AliRtcAudioEffectReverbMode): number

参数说明

参数	类型	描述
mode	AliRtcAudioEffectReverbMode	参考 AliRtcAudioEffectReverbMode 对应的混响模式

返回说明

number - 0：成功；非0：失败

设置美声音效模式

public setAudioEffectBeautifyMode(mode: AliRtcAudioEffectBeautifyMode): number

参数说明

参数	类型	描述
mode	AliRtcAudioEffectBeautifyMode	参考 AliRtcAudioEffectBeautifyMode 对应的混响模式

返回说明

number - 0：成功；非0：失败

设置混响音效类型

public setAudioEffectReverbParamType(type: AliRtcAudioEffectReverbParamType, value: number): number

参数说明

参数	类型	描述
type	AliRtcAudioEffectReverbParamType	参考 AliRtcAudioEffectReverbParamType 对应的混响类型
value	number	混响参数值，不同混响类型的取值范围参考 AliRtcAudioEffectReverbParamType 中取值说明

返回说明

number - 0：成功；非0：失败

设置均衡器音效类型

public setAudioEffectEqualizationParam(bandIndex: AliRtcAudioEffectEqualizationBandFrequency, gain: number): number

参数说明

参数	类型	描述
bandIndex	AliRtcAudioEffectEqualizationBandFrequency	均衡器段数[0,9] center frequency [31,62,125,250,500,1000,2000,4000,8000,16000] Hz
gain	number	均衡器增益db [-15,15] default 0

返回说明

number - 0：成功；非0：失败

开始伴奏混音

public startAudioAccompany(fileName: string, config: AliRtcAudioAccompanyConfig): number

参数说明

参数	类型	描述
fileName	string	文件路径
config	AliRtcAudioAccompanyConfig	伴奏播放配置

返回说明

number - 0: 成功；非0: 返回错误码

停止伴奏混音

public stopAudioAccompany(): number

返回说明

number - 0: 成功；非0: 返回错误码

设置伴奏音量

public setAudioAccompanyVolume(volume: number): number

参数说明

参数	类型	描述
volume	number	伴奏音量，取值范围[0,100]

返回说明

number - 0: 成功；非0: 返回错误码

设置伴奏推流音量

public setAudioAccompanyPublishVolume(volume: number): number

参数说明

参数	类型	描述
volume	number	伴奏推流音量，取值范围[0,100]

返回说明

number - 0: 成功；非0: 返回错误码

获取伴奏推流音量

public getAudioAccompanyPublishVolume(): number

返回说明

number - [0, 100]: 成功；其他值：返回错误码

设置伴奏本地播放音量

public setAudioAccompanyPlayOutVolume(volume: number): number

参数说明

参数	类型	描述
volume	number	伴奏本地播放音量，取值范围[0,100]

返回说明

number - 0: 成功；非0: 返回错误码

获取伴奏本地播放音量

public getAudioAccompanyPlayOutVolume(): number

返回说明

number - [0, 100]: 成功；其他值：返回错误码

暂停伴奏混音

public pauseAudioAccompany(): number

返回说明

number - 0: 成功；非0: 返回错误码

重新开始伴奏混音

public resumeAudioAccompany(): number

返回说明

number - 0: 成功；非0: 返回错误码

获取伴奏文件时长, 单位为毫秒

public getAudioAccompanyDuration(): number

返回说明

number - >=0: 伴奏文件时长；<0: 返回错误码

获取伴奏文件播放进度，单位为毫秒

public getAudioAccompanyCurrentPosition(): number

返回说明

number - >=0: 伴奏文件播放进度；<0: 返回错误码

设置伴奏文件的播放位置

public setAudioAccompanyPosition(pos: number): number

参数说明

参数	类型	描述
pos	number	进度条位置，单位为毫秒

返回说明

number - 0: 成功；非0: 返回错误码

预加载音效文件

public preloadAudioEffect(soundId: number, filePath: string): number

参数说明

参数	类型	描述
soundId	number	用户给该音效文件分配的ID
filePath	string	音效文件路径，支持本地文件和网络URL

返回说明

number - 0：成功；非0：失败

删除预加载的音效文件

public unloadAudioEffect(soundId: number): number

参数说明

参数	类型	描述
soundId	number	用户给该音效文件分配的ID

返回说明

number - 0：成功；非0：失败

开始播放音效

public playAudioEffect(soundId: number, filePath: string, config: AliRtcAudioEffectConfig): number

参数说明

参数	类型	描述
soundId	number	用户给该音效文件分配的ID，每个音效均有唯一的ID，如果你已通过 preloadAudioEffect 将音效加载至内存，确保这里的soundId与preloadAudioEffect设置的soundId相同
filePath	string	文件路径，支持本地文件和网络URL
config	AliRtcAudioEffectConfig	伴奏播放配置

返回说明

number - 0：成功；非0：失败

暂停音效

public pauseAudioEffect(soundId: number):number

参数说明

参数	类型	描述
soundId	number	用户给该音效文件分配的ID

返回说明

number - 0：成功；非0：失败

暂停所有音效

public pauseAllAudioEffects(): number

返回说明

number - 0：成功；非0：失败

恢复指定音效文件

public resumeAudioEffect(soundId: number): number

参数说明

参数	类型	描述
soundId	number	用户给该音效文件分配的ID

返回说明

number - 0：成功；非0：失败

恢复所有音效文件

public resumeAllAudioEffects (): number

返回说明

number - 0：成功；非0：失败

停止播放音效

public stopAudioEffect(soundId: number): number

参数说明

参数	类型	描述
soundId	number	用户给该音效文件分配的ID，每个音效均有唯一的ID，如果你已通过 preloadAudioEffect 将音效加载至内存，确保这里的soundId与 preloadAudioEffect 设置的soundId相同

返回说明

number - 0：成功；非0：失败

停止播放所有音效

public stopAllAudioEffects(): number

返回说明

number - 0：成功；非0：失败

设置音效推流混音音量

public setAudioEffectPublishVolume(soundId: number, volume: number): number

参数说明

参数	类型	描述
soundId	number	用户给该音效文件分配的ID
volume	number	推流混音音量，范围是：[0, 100]，默认值：50

返回说明

number - 0：成功；非0：失败

获取音效推流混音音量

public getAudioEffectPublishVolume(soundId: number): number

参数说明

参数	类型	描述
soundId	number	用户给该音效文件分配的ID

返回说明

number - [0, 100]：音效推流混音音量；其他：错误值

设置音效本地播放音量

public setAudioEffectPlayOutVolume(soundId: number, volume: number): number

参数说明

参数	类型	描述
soundId	number	用户给该音效文件分配的ID
volume	number	音效本地播放音量，范围：[0, 100]，默认值：50

返回说明

number - 0：成功；非0：失败

获取音效本地播放音量

public getAudioEffectPlayOutVolume(soundId: number): number

参数说明

参数	类型	描述
soundId	number	用户给该音效文件分配的ID

返回说明

number - [0, 100]：音效本地播放音量；其他：错误值

设置所有音效推流混音音量

public setAllAudioEffectsPublishVolume(soundId: number): number

参数说明

参数	类型	描述
soundId	number	推流混音音量，范围是：[0, 100]，默认值：50

返回说明

number - 0：成功；非0：失败

设置所有音效本地播音量

public setAllAudioEffectsPlayoutVolume(soundId: number): number

参数说明

参数	类型	描述
soundId	number	音效本地播放音量，范围：[0, 100]，默认值：50

返回说明

number - 0：成功；非0：失败

是否开启SEI视频流，如开启将使用16x16黑帧/20fps

public enableSEIVideoStream(enabled: boolean): number

参数说明

参数	类型	描述
enabled	boolean	true=开启 false=关闭

返回说明

number - 0: 成功；非0: 失败

发送媒体扩展信息

public sendMediaExtensionMsg(message: ArrayBuffer, repeatCount: number, delay: number, isKeyFrame: boolean): number

参数说明

参数	类型	描述
message	ArrayBuffer	媒体扩展信息，长度限制为最大4K字节
repeatCount	number	重复次数，代表消息冗余度，用于防止网络丢包导致的消息丢失，-1为无限传输
delay	number	延迟，单位毫秒，调用API后，最短多少毫秒发送扩展信息
isKeyFrame	boolean	是否只有关键帧才使用扩展信息 true表示只有关键帧才附加扩展信息

返回说明

number - 0: 成功；<0: 失败

发送媒体扩展信息

public sendMediaExtensionMsgEx(message: ArrayBuffer, repeatCount: number, delay: number, isKeyFrame: boolean, payloadType: number): number

参数说明

参数	类型	描述
message	ArrayBuffer	媒体扩展信息，长度限制为最大4K字节
repeatCount	number	重复次数，代表消息冗余度，用于防止网络丢包导致的消息丢失，-1为无限传输
delay	number	延迟，单位毫秒，调用API后，最短多少毫秒发送扩展信息
isKeyFrame	boolean	是否只有关键帧才使用扩展信息 true表示只有关键帧才附加扩展信息
payloadType	number	[5, 100..254]范围 payloadType=5等于使用sendMediaExtensionMsg 接口

返回说明

number - 0: 成功；<0: 失败

发送数据消息

public sendDataChannelMsg(controlMsg: AliRtcDataChannelMsg): number

参数说明

参数	类型	描述
controlMsg	AliRtcDataChannelMsg	消息内容

返回说明

number - 0: 成功；非0: 失败

开始文件录制

public startRecord(recordType: AliRtcRecordType,
    recordFormat: AliRtcRecordFormat,
    filePath: string,
    audioConfig: AliRtcRecordAudioConfig | undefined,
    videoConfig: AliRtcRecordVideoConfig | undefined): boolean

参数说明

参数	类型	描述
recordType	AliRtcRecordType	录制类型。
recordFormat	AliRtcRecordFormat	录制文件格式，如果录制视频（recordType=AliRtcRecordTypeVideo），则忽略该配置。
filePath	string	文件路径
audioConfig	AliRtcRecordAudioConfig | undefined	音频设置。
videoConfig	AliRtcRecordVideoConfig | undefined	视频设置。

返回说明

boolean - true: 成功；false: 失败

停止文件录制

public stopRecord(): void

开启旁路直播

public startPublishLiveStream(streamURL: string, params: AliRtcLiveTranscodingParam) : number

参数说明

参数	类型	描述
streamURL	string	推流地址
params	AliRtcLiveTranscodingParam	推流所需参数

返回说明

number - 0 : 成功；非0 : 失败

更新旁路直播相关参数

public updatePublishLiveStream(streamURL: string, params: AliRtcLiveTranscodingParam) : number

参数说明

参数	类型	描述
streamURL	string	推流地址
params	AliRtcLiveTranscodingParam	推流所需参数, 详细定义见 AliRtcLiveTranscodingParam

返回说明

number - 0 : 成功；非0 : 失败

停止旁路直播

public stopPublishLiveStream(streamURL: string) : number

参数说明

参数	类型	描述
streamURL	string	推流地址

返回说明

number - 0 : 成功；非0 : 失败

获得旁路直播状态

public getPublishLiveStreamState(streamURL: string): AliRtcLiveTranscodingState

参数说明

参数	类型	描述
streamURL	string	推流地址

返回说明

AliRtcLiveTranscodingState - 返回 AliRtcLiveTranscodingState

更新旁路直播相关参数

public updatePublishLiveStreamWithTaskId(taskId: string, params: AliRtcLiveTranscodingParam): number

参数说明

参数	类型	描述
taskId	string	任务id
params	AliRtcLiveTranscodingParam	推流所需参数

返回说明

number - 0 : 成功；非0 : 失败

停止旁路直播

public stopPublishLiveStreamWithTaskId(taskId: string): number

参数说明

参数	类型	描述
taskId	string	任务id

返回说明

number - 0 : 成功；非0 : 失败

获得旁路直播状态

public getPublishLiveStreamStateWithTaskId(taskId: string): AliRtcLiveTranscodingState

参数说明

参数	类型	描述
taskId	string	任务Id

返回说明

AliRtcLiveTranscodingState - 返回 AliRtcLiveTranscodingState

根据RtsUrl推流，目前同时只支持推一路流

public publishStreamByRtsUrl(rtsUrl: string): number

参数说明

参数	类型	描述
rtsUrl	string	rts url，不携带roomserver信息

返回说明

number - 0: 成功；非0: 失败

根据RtsUrl停止推流

public stopPublishStreamByRtsUrl(rtsUrl: string): number

参数说明

参数	类型	描述
rtsUrl	string	rts url，不携带roomserver信息

返回说明

number - 0: 成功；非0: 失败

根据RtsUrl拉流，目前同时只支持拉一路流

public subscribeStreamByRtsUrl(rtsUrl: string, uid: string, preLoad: boolean = false): number

参数说明

参数	类型	描述
rtsUrl	string	rts url，不携带roomserver信息
uid	string	用户id，由调用者指定，并且需要保持唯一性
preLoad	boolean	是否预加载，默认为false

返回说明

number - 0: 成功；非0: 失败

根据Rts user id停止拉流

public stopSubscribeStreamByRtsUserId(uid: string): number

参数说明

参数	类型	描述
uid	string	rts user id

返回说明

number - 0: 成功；非0: 失败

根据uid，暂停从服务端订阅RTS流

public pauseRtsStreamByRtsUserId(uid: string): number

参数说明

参数	类型	描述
uid	string	rts user id

返回说明

number - 0: 成功；非0: 失败

根据uid，恢复从服务端订阅RTS流

public resumeRtsStreamByRtsUserId(uid: string): number

参数说明

参数	类型	描述
uid	string	rts user id

返回说明

number - 0: 成功；非0: 失败

开始网络质量探测

public startLastmileDetect(config: AliRtcNetworkProbeConfig): number

参数说明

参数	类型	描述
config	AliRtcNetworkProbeConfig	探测配置项

返回说明

number - 0: 成功；非0: 失败

停止网络质量探测

public stopLastmileDetect(): number

返回说明

number - 0: 成功；非0: 失败

设置SDK日志文件保存路径

public static setLogDirPath(logDirPath: string): number

参数说明

参数	类型	描述
logDirPath	string	日志文件保存目录的绝对路径，该参数是一个目录路径，而不是文件的路径

返回说明

number - 0，成功；非0，失败。其中有两种错误码，释义如下：AliRtcError#ERR_LOG_ROOT_PATH_ERROR: 路径已存在或因权限问题不可访问。AliRtcError#ERR_LOG_ALREADY_INIT：log对象已经初始化过。

设置日志等级

public static setLogLevel(logLevel: AliRtcLogLevel): void

参数说明

参数	类型	描述
logLevel	AliRtcLogLevel	Log级别，详见 AliRtcLogLevel 枚举类型

设置是否上传日志文件，默认上传

public static enableUploadLog(enable: boolean): void

参数说明

参数	类型	描述
enable	boolean	true 上传日志文件；false 不上传日志文件

以json字符串的格式，更新外部输入参数

public setExtras(extras: string): number

参数说明

参数	类型	描述
extras	string	json字符串的，可以是空字符串

返回说明

number - 0: 成功；非0: 失败

以json字符串的格式，设置自定义属性

public setParameter(param: string): number

参数说明

参数	类型	描述
param	string	自定义属性参数

返回说明

number - 0: 成功；非0: 失败

获取自定义属性

public getParameter(paramKey: string): string

参数说明

参数	类型	描述
paramKey	string	自定义属性参数

返回说明

string - 属性值