鸿蒙音视频全部接口与回调函数-视频直播-阿里云

通过阅读本文，您可以了解实时音视频Harmony SDK接口详情。

API	功能描述
getInstance	获取 AliRtcEngine 实例
destroyInstance	销毁 AliRtcEngine 实例
getSDKVersion	查询sdk当前版本号
setH5CompatibleMode	设置H5兼容模式
getH5CompatibleMode	获取H5兼容模式设置
setRtcEngineEventListener	设置自身相关监听事件回调
getNativeHandle	获取Native层实例句柄

频道相关接口

API	功能描述
setChannelProfile	设置频道模式
setClientRole	设置直播场景 AliRtcClientRole 设置为对应的用户角色
getCurrentClientRole	获取当前用户角色
joinChannel	该方法让用户加入频道，一个频道内可以加入多个用户进行互相通话
joinChannelWithToken	加入频道
joinChannelWithChannelParam	加入频道
joinAIChannel	加入AI频道
leaveChannel	离开频道,即挂断或者停止童话
getCurrentConnectionStatus	获取当前网络链接状态
isInCall	获取状态：当前是否在频道中
refreshAuthInfo	刷新鉴权信息
refreshAuthInfoWithToken	刷新鉴权信息
isAudioOnlyMode	查询是否纯音频模式

发布及订阅相关接口

API	功能描述
publishLocalVideoStream	是否推送本地视频(摄像头)流
isLocalVideoStreamPublished	查询是否设置推送视频流
publishLocalDualVideoStream	是否推送次要视频流
isLocalDualVideoStreamPublished	查询当前是否设置推送次要视频流
publishLocalAudioStream	是否推送本地音频流
isLocalAudioStreamPublished	查询是否设置推送音频流
publishLocalDualAudioStream	是否推送次要音频流
isLocalDualAudioStreamPublished	查询是否设置推送第二条音频流
setDefaultSubscribeAllRemoteAudioStreams	设置是否默认接收音频流
setDefaultSubscribeAllRemoteVideoStreams	设置是否默认订阅视频流
setRemoteVideoStreamType	设置订阅的相机流格式，大流或小流
setRemoteDefaultVideoStreamType	设置默认订阅的相机流格式，大流或小流
subscribeAllRemoteAudioStreams	停止/恢复接收所有远端音频流
subscribeAllRemoteDualAudioStreams	停止/恢复接收远端第二条音频流
subscribeAllRemoteVideoStreams	停止/恢复接收所有远端视频流
subscribeRemoteAudioStream	停止/恢复订阅麦克风音频流
subscribeRemoteAudioStreamByTrack	停止/恢复订阅特定远端用户的音频流
subscribeRemoteVideoStream	停止/恢复订阅视频流
subscribeRemoteMediaStream	停止/恢复订阅远端音视频流
subscribeRemoteDestChannelStream	订阅目标频道，指定用户的流

音频设备管理相关接口

API	功能描述
setAudioProfile	设置音频profile
SetAudioCapability	设置音频能力
startAudioCapture	开启音频采集
stopAudioCapture	开启音频采集
startAudioPlayer	开启音频播放设备
stopAudioPlayer	关闭音频播放
muteLocalMic	停止/恢复本地音频数据发送
setRecordingVolume	设置录音音量
setPlayOutVolume	设置播放音量
setDefaultAudioRouteToSpeakerphone	设置默认音频输出是否从扬声器出声，默认从扬声器出声
enableSpeakerphone	设置音频输出为听筒还是扬声器
isSpeakerOn	获取当前音频输出为听筒还是扬声器
setRemoteAudioVolume	调节本地播放的指定远端用户音量
muteRemoteAudioPlaying	停止/恢复远端指定用户的音频流的播放
muteAllRemoteAudioPlaying	停止/恢复远端的所有音频流的播放
enableAudioVolumeIndication	设置音量回调频率和平滑系数
enableEarBack	启用耳返
setEarBackVolume	设置耳返音量
startAudioCaptureTest	通话前，开启音频采集设备检测
stopAudioCaptureTest	关闭音频采集检测
playAudioFileTest	测试播放音频文件
stopAudioFileTest	停止测试播放音频文件

视频设备管理相关接口

API	功能描述
setLocalViewConfig	设置本地预览显示视图
startPreview	开启本地视频预览
stopPreview	关闭本地视频预览
setCameraCaptureConfiguration	设置摄像头采集偏好
enableLocalVideo	禁用或启用本地视频采集
enableVideoCapture	停止/恢复本地摄像头采集
muteLocalCamera	停止/恢复本地视频数据发送
isCameraOn	检查当前是否打开摄像头
muteAllRemoteVideoRendering	停止/恢复远端所有视频track渲染
setVideoEncoderConfiguration	设置相机流视频编码属性
setVideoDecoderConfiguration	设置相机流视频解码属性
setVideoMirrorMode	设置预览和推流镜像能力
setCapturePipelineScaleMode	设置采集缩放时机，视频数据是采集的时候立即缩放还是编码时才进行缩放
setRemoteViewConfig	设置远端视频显示视图
switchCamera	切换前后摄像头
getCurrentCameraDirection	获取当前摄像头方向（前/后摄像头）
setCameraZoom	设置摄像头缩放比例
getCameraMaxZoomFactor	获取摄像头最大缩放比例
getCurrentZoom	获取摄像头缩放比例
setExposure	设置摄像头曝光度
getCurrentExposure	获取摄像头曝光度
getMinExposure	获取摄像头最小曝光度
getMaxExposure	获取摄像头最大曝光度
setCameraFlash	设置摄像头闪光灯是否打开
isCameraFocusPointSupported	摄像头是否支持手动聚焦
isCameraExposurePointSupported	摄像头是否支持设置曝光区域
setCameraFocusPoint	设置摄像头手动聚焦
setCameraExposurePoint	设置摄像头曝光点
getVideoCodecType	获取视频编解码格式
getCurrentEncoderManufacturer	获取当前使用的编码器类型,如未开始推流，返回无效类型
snapshotVideo	视频截图功能

桌面共享

API	功能描述
setScreenShareEncoderConfiguration	设置屏幕流视频编码属性
startScreenShare	开启屏幕帧监听
stopScreenShare	停止屏幕共享
isScreenSharePublished	查询是否设置推送屏幕分享

配置音频数据回调

API	功能描述
registerAudioFrameObserver	注册音频数据回调
enableAudioFrameObserver	订阅音频数据

自定义音频输入

API	功能描述
addExternalAudioStream	新增外部音频流
pushExternalAudioStreamRawData	输入外部音频数据
setExternalAudioStreamPlayoutVolume	设置外部音频流播放音量
getExternalAudioStreamPlayoutVolume	获取外部音频流播放音量
setExternalAudioStreamPublishVolume	设置外部音频流推流音量
getExternalAudioStreamPublishVolume	获取外部音频流推流音量
removeExternalAudioStream	移除外部音频流

自定义视频输入

API	功能描述
setExternalVideoSource	启用外部视频输入源
pushExternalVideoFrame	输入视频数据
setExternalImageData	输入视频数据

音频变声与混响

API	功能描述
setAudioEffectPitchValue	设置变调参数
setAudioEffectVoiceChangerMode	设置变声音效模式
setAudioEffectReverbMode	设置混响音效模式
setAudioEffectBeautifyMode	设置美声音效模式
setAudioEffectReverbParamType	设置混响音效类型
setAudioEffectEqualizationParam	设置均衡器音效类型

播放伴奏

API	功能描述
startAudioAccompany	开始伴奏混音
stopAudioAccompany	停止伴奏混音
setAudioAccompanyVolume	设置伴奏音量
setAudioAccompanyPublishVolume	设置伴奏推流音量
getAudioAccompanyPublishVolume	获取伴奏推流音量
setAudioAccompanyPlayOutVolume	设置伴奏本地播放音量
getAudioAccompanyPlayOutVolume	获取伴奏本地播放音量
pauseAudioAccompany	暂停伴奏混音
resumeAudioAccompany	重新开始伴奏混音
getAudioAccompanyDuration	获取伴奏文件时长, 单位为毫秒
getAudioAccompanyCurrentPosition	获取伴奏文件播放进度，单位为毫秒
setAudioAccompanyPosition	设置伴奏文件的播放位置

播放音效

API	功能描述
preloadAudioEffect	预加载音效文件
unloadAudioEffect	删除预加载的音效文件
playAudioEffect	开始播放音效
pauseAudioEffect	暂停音效
pauseAllAudioEffects	暂停所有音效
resumeAudioEffect	恢复指定音效文件
resumeAllAudioEffects	恢复所有音效文件
stopAudioEffect	停止播放音效
stopAllAudioEffects	停止播放所有音效
setAudioEffectPublishVolume	设置音效推流混音音量
getAudioEffectPublishVolume	获取音效推流混音音量
setAudioEffectPlayOutVolume	设置音效本地播放音量
getAudioEffectPlayOutVolume	获取音效本地播放音量
setAllAudioEffectsPublishVolume	设置所有音效推流混音音量
setAllAudioEffectsPlayoutVolume	设置所有音效本地播音量

SEI

API	功能描述
enableSEIVideoStream	是否开启SEI视频流，如开启将使用16x16黑帧/20fps
sendMediaExtensionMsg	发送媒体扩展信息
sendMediaExtensionMsgEx	发送媒体扩展信息

Data Channel

API	功能描述
sendDataChannelMsg	发送数据消息

文件录制

API	功能描述
startRecord	开始文件录制
stopRecord	停止文件录制

旁路直播

API	功能描述
startPublishLiveStream	开启旁路直播
updatePublishLiveStream	更新旁路直播相关参数
stopPublishLiveStream	停止旁路直播
getPublishLiveStreamState	获得旁路直播状态
updatePublishLiveStreamWithTaskId	更新旁路直播相关参数
stopPublishLiveStreamWithTaskId	停止旁路直播
getPublishLiveStreamStateWithTaskId	获得旁路直播状态

推拉RTS裸流

API	功能描述
publishStreamByRtsUrl	根据RtsUrl推流，目前同时只支持推一路流
stopPublishStreamByRtsUrl	根据RtsUrl停止推流
subscribeStreamByRtsUrl	根据RtsUrl拉流，目前同时只支持拉一路流
stopSubscribeStreamByRtsUserId	根据Rts user id停止拉流
pauseRtsStreamByRtsUserId	根据uid，暂停从服务端订阅RTS流
resumeRtsStreamByRtsUserId	根据uid，恢复从服务端订阅RTS流

网络质量探测

API	功能描述
startLastmileDetect	开始网络质量探测
stopLastmileDetect	停止网络质量探测

其他接口

API	功能描述
setLogDirPath	设置SDK日志文件保存路径
setLogLevel	设置日志等级
enableUploadLog	设置是否上传日志文件，默认上传
setExtras	以json字符串的格式，更新外部输入参数
setParameter	以json字符串的格式，设置自定义属性
getParameter	获取自定义属性
enableStatsReport	设置是否上传业务埋点，默认上传
getNetworkTime	获取时间轴时间

回调接口

API	功能描述
onRemoteUserOnline	远端用户（通信模式）/（互动模式，主播角色）加入频道回调
onRemoteUserOffline	远端用户（通信模式）/（互动模式，主播角色）离开频道回调
onJoinChannel	加入频道回调
onLeaveChannel	离开频道回调
onConnectionStatusChange	网络连接状态改变回调
onBye	被服务器踢出/会议结束频道的消息回调
onAudioPublishStateChanged	音频推流变更回调
onVideoPublishStateChanged	视频推流变更回调
onScreenSharePublishStateChanged	屏幕流推流变更回调
onDualVideoStreamPublishStateChanged	视频次要流推流变更回调
onAudioSubscribeStateChanged	音频订阅情况变更回调
onVideoSubscribeStateChanged	相机流订阅情况变更回调
onSubscribeStreamTypeChanged	大小流订阅情况变更回调
onRemoteTrackAvailableNotify	远端用户的音视频流发生变化回调
onFirstRemoteVideoFrameDrawn	远端用户的第一帧视频帧显示时触发这个消息
onFirstLocalVideoFrameDrawn	预览开始显示第一帧视频帧时触发这个消息
onFirstVideoPacketSend	视频首包发送回调
onFirstVideoPacketReceived	视频首包接收回调
onFirstVideoFrameReceived	收到远端用户视频首帧的回调
onVideoResolutionChanged	分辨率变化回调
onFirstAudioPacketSend	音频首包发送回调
onFirstAudioPacketReceived	音频首包接收回调
onFirstRemoteAudioDecoded	已解码远端音频首帧回调
onAudioVolumeCallback	订阅的音频音量回调
onTestAudioVolumeCallback	订通话前音频采集检测的音量回调
onActiveSpeaker	订阅的当前说话人回调
onAudioAccompanyStateChanged	本地伴奏播放状态回调
onAudioEffectFinished	本地音效播放结束回调
onNetworkQualityChanged	网络质量变化时发出的消息
onLastmileDetectResultWithQuality	网络质量探测回调
onLastmileDetectResultWithBandWidth	网络质量探测结果的回调
onStats	当前会话统计信息回调
onLocalVideoStats	本地视频统计信息回调
onRemoteVideoStats	远端视频统计信息回调
onLocalAudioStats	本地音频统计信息回调
onRemoteAudioStats	远端音频统计信息回调
onPublishLiveStreamStateChanged	旁路推流状态改变回调
onPublishLiveStreamStateChangedWithTaskId	旁路推流状态改变回调（基于任务ID）
onPublishLiveTaskStatusChanged	旁路任务状态改变回调
onPublishLiveTaskStatusChangedWithTaskId	旁路任务状态改变回调（基于任务ID）
onUserAudioMuted	远端用户静音/取消静音回调
onUserVideoMuted	对端用户发送视频黑帧数据发送通知
onUserVideoEnabled	对端用户关闭相机流采集发送通知
onUpdateRoleNotify	当用户角色发生变化时通知
onRemoteAudioAccompanyStarted	远端用户伴奏播放开始回调
onRemoteAudioAccompanyFinished	远端用户伴奏播放结束回调
onMediaExtensionMsgReceived	收到媒体扩展信息回调
onLocalDeviceException	本地设备异常回调
onDataChannelMessage	dataChannel消息回调
onRemoteVideoChanged	远端视频流发生变化回调
onAuthInfoWillExpire	用户authInfo即将过期通知
onAuthInfoExpired	用户调用需要鉴权的接口，服务端返回信息过期
onAIAgentResult	AI agent处理结果回调
onRemoteUserSubscribedDataChannel	可以开始发送data channel消息回调
onAudioDelayInfo	音频延时信息回调
onLocalAudioCaptureStateChanged	本地音频采集设备状态回调
onLocalVideoCaptureStateChanged	本地视频采集设备状态回调
onRecordEvent	文件录制回调事件
onOccurWarning	警告通知
onOccurError	错误通知
onPublishStreamByRtsUrlResult	启动RTS URL推流结果
onStopPublishStreamByRtsUrlResult	结束RTS URL推流结果
onSubscribeStreamByRtsUrlResult	订阅RTS URL结果回调
onStopSubscribeStreamByRtsUrlResult	取消订阅使用RTS URL结果回调
onSubscribedRtsStreamBeyondLimit	RTS URL预建联数目超限回调
onPauseRtsStreamResult	使用RTS UID 暂停订阅结果回调
onResumeRtsStreamResult	使用RTS UID 恢复订阅结果回调
onCapturedAudioFrame	采集裸数据回调
onProcessCapturedAudioFrame	3A后数据回调
onPublishAudioFrame	推流数据回调
onPlaybackAudioFrame	播放数据回调
onMixedAllAudioFrame	推流数据和播放数据混音后回调
onRemoteUserAudioFrame	远端拉流数据回调

接口详情

getInstance

获取 AliRtcEngine 实例

public static getInstance(extras: string | null, context : common.Context): AliRtcEngine | undefined

说明

该方法为同步调用，以单例的形式提供对象创建。注意：如果返回undefined，表面内部的单例还在释放资源中，需要稍后再试。

参数说明

参数	类型	描述
extras	string \| null	用于接收来自客户灰度下发的参数，通过JSON配置SDK的特别功能，可以是空字符串
context	common.Context	App上下文

返回说明

AliRtcEngine | undefined

destroyInstance

销毁 AliRtcEngine 实例

public static destroyInstance(): void

getSDKVersion

查询sdk当前版本号

public static getSDKVersion(): string

说明

在任何时刻都可以调用

返回说明

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

setH5CompatibleMode

设置H5兼容模式

public static setH5CompatibleMode(enable: boolean): void

说明

不支持在创建 AliRtcEngine 实例之后更改H5兼容模式，必须在创建实例之前就调用此方法。

参数说明

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

getH5CompatibleMode

获取H5兼容模式设置

public static getH5CompatibleMode(): boolean

返回说明

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

setRtcEngineEventListener

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

public setRtcEngineEventListener(listener: AliRtcEngineEventListener | null) : void

说明

不建议在回调方法中做耗时操作，这将有可能引起不必要的阻塞从而影响SDK的运行

参数说明

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

getNativeHandle

获取Native层实例句柄

public getNativeHandle() : number

说明

通过获取该实例句柄，可以在Native进行相关业务开发，例如监听与回写音视频裸数据

返回说明

number - Native层实例句柄

setChannelProfile

设置频道模式

public setChannelProfile(channelProfile: AliRtcChannelProfile): number

说明

相同频道内的用户必须使用同一种频道场景

参数说明

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

返回说明

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

setClientRole

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

public setClientRole(clientRole: AliRtcClientRole): number

参数说明

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

返回说明

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

getCurrentClientRole

获取当前用户角色

public getCurrentClientRole(): AliRtcClientRole

返回说明

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

joinChannel

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

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

参数说明

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

返回说明

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

joinChannelWithToken

加入频道

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: 失败

joinChannelWithChannelParam

加入频道

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

参数说明

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

返回说明

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

joinAIChannel

加入AI频道

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

参数说明

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

返回说明

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

leaveChannel

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

public leaveChannel(): number

返回说明

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

getCurrentConnectionStatus

获取当前网络链接状态

public getCurrentConnectionStatus(): AliRtcConnectionStatus

返回说明

AliRtcConnectionStatus - 当前链接状态

isInCall

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

public isInCall(): boolean

返回说明

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

refreshAuthInfo

刷新鉴权信息

public refreshAuthInfo(authInfo: AliRtcEngineAuthInfo): number

参数说明

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

返回说明

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

refreshAuthInfoWithToken

刷新鉴权信息

public refreshAuthInfoWithToken(token: string): number

参数说明

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

返回说明

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

isAudioOnlyMode

查询是否纯音频模式

public isAudioOnlyMode(): boolean

返回说明

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

publishLocalVideoStream

是否推送本地视频(摄像头)流

public publishLocalVideoStream(enabled: boolean): number

参数说明

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

返回说明

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

isLocalVideoStreamPublished

查询是否设置推送视频流

public isLocalVideoStreamPublished(): boolean

返回说明

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

publishLocalDualVideoStream

是否推送次要视频流

public publishLocalDualVideoStream(enable: boolean): number

参数说明

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

返回说明

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

isLocalDualVideoStreamPublished

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

public isLocalDualVideoStreamPublished(): boolean

返回说明

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

publishLocalAudioStream

是否推送本地音频流

public publishLocalAudioStream(enabled: boolean): number

参数说明

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

返回说明

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

isLocalAudioStreamPublished

查询是否设置推送音频流

public isLocalAudioStreamPublished(): boolean

返回说明

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

publishLocalDualAudioStream

是否推送次要音频流

public publishLocalDualAudioStream(enabled: boolean): number

参数说明

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

返回说明

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

isLocalDualAudioStreamPublished

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

public isLocalDualAudioStreamPublished(): boolean

返回说明

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

setDefaultSubscribeAllRemoteAudioStreams

设置是否默认接收音频流

public setDefaultSubscribeAllRemoteAudioStreams(sub: boolean): number

参数说明

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

返回说明

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

setDefaultSubscribeAllRemoteVideoStreams

设置是否默认订阅视频流

public setDefaultSubscribeAllRemoteVideoStreams(sub: boolean): number

参数说明

参数	类型	描述
sub	boolean	是否默认订阅视频流；true:(Default)默认订阅视频流；false:默认不订阅视频流

返回说明

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

setRemoteVideoStreamType

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

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

参数说明

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

返回说明

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

setRemoteDefaultVideoStreamType

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

public setRemoteDefaultVideoStreamType(streamType: AliRtcVideoStreamType): number

参数说明

参数	类型	描述
streamType	AliRtcVideoStreamType	流类型

返回说明

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

subscribeAllRemoteAudioStreams

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

public subscribeAllRemoteAudioStreams(sub: boolean): number

参数说明

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

返回说明

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

subscribeAllRemoteDualAudioStreams

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

public subscribeAllRemoteDualAudioStreams(sub: boolean): number

参数说明

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

返回说明

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

subscribeAllRemoteVideoStreams

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

public subscribeAllRemoteVideoStreams(sub: boolean): number

参数说明

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

返回说明

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

subscribeRemoteAudioStream

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

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

参数说明

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

返回说明

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

subscribeRemoteAudioStreamByTrack

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

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: 失败

subscribeRemoteVideoStream

停止/恢复订阅视频流

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

参数说明

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

返回说明

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

subscribeRemoteMediaStream

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

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

subscribeRemoteDestChannelStream

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

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: 失败

setAudioProfile

设置音频profile

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

说明

只支持 joinChannel 前设置有效

参数说明

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

返回说明

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

SetAudioCapability

设置音频能力

public SetAudioCapability(ability: AliRtcAudioCapability): number

参数说明

参数	类型	描述
ability	AliRtcAudioCapability	能力项

返回说明

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

startAudioCapture

开启音频采集

public startAudioCapture(): number

返回说明

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

stopAudioCapture

开启音频采集

public stopAudioCapture(): number

返回说明

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

startAudioPlayer

开启音频播放设备

public startAudioPlayer(): number

返回说明

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

stopAudioPlayer

关闭音频播放

public stopAudioPlayer(): number

返回说明

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

muteLocalMic

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

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

说明

静音是指音频流发送静音帧,采集和编码模块仍然在工作

参数说明

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

返回说明

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

setRecordingVolume

设置录音音量

public setRecordingVolume(volume: number): number

参数说明

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

返回说明

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

setPlayOutVolume

设置播放音量

public setPlayOutVolume(volume: number): number

参数说明

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

返回说明

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

setDefaultAudioRouteToSpeakerphone

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

public setDefaultAudioRouteToSpeakerphone(defaultToSpeakerphone: boolean): number

参数说明

参数	类型	描述
defaultToSpeakerphone	boolean	true: 扬声器模式(默认扬声器)；false: 听筒模式

返回说明

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

enableSpeakerphone

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

public enableSpeakerphone(enable: boolean): number

参数说明

参数	类型	描述
enable	boolean	true:扬声器模式；false:听筒模式(默认听筒)

返回说明

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

isSpeakerOn

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

public isSpeakerOn(): boolean

返回说明

boolean

setRemoteAudioVolume

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

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

参数说明

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

返回说明

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

muteRemoteAudioPlaying

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

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

说明

拉流和解码不受影响, 支持joinChannel之前和之后设置

参数说明

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

返回说明

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

muteAllRemoteAudioPlaying

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

public muteAllRemoteAudioPlaying(mute: boolean): number

说明

拉流和解码不受影响, 支持joinChannel之前和之后设置

参数说明

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

返回说明

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

enableAudioVolumeIndication

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

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

说明

设置之后，音频音量和说话人uid会分别通过 AliRtcEngineEventListener#onAudioVolumeCallback 和 AliRtcEngineEventListener#onActiveSpeaker 回调

参数说明

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

返回说明

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

enableEarBack

启用耳返

public enableEarBack(enable: boolean): number

说明

所有设备都支持耳返，建议戴耳机的情况下开启耳返，效果更好

参数说明

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

返回说明

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

setEarBackVolume

设置耳返音量

public setEarBackVolume(volume: number): number

参数说明

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

返回说明

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

startAudioCaptureTest

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

public startAudioCaptureTest(): number

说明

只能入会前调用此接口

返回说明

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

stopAudioCaptureTest

关闭音频采集检测

public stopAudioCaptureTest(): number

说明

只能入会前调用此接口

返回说明

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

playAudioFileTest

测试播放音频文件

public playAudioFileTest(filePath: string): number

说明

只能入会前调用此接口

参数说明

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

返回说明

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

stopAudioFileTest

停止测试播放音频文件

public stopAudioFileTest(): number

说明

只能入会前调用此接口

返回说明

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

setLocalViewConfig

设置本地预览显示视图

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

参数说明

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

startPreview

开启本地视频预览

public startPreview(): number

说明

如果没有调用 setLocalViewConfig 设置显示的view，则无法预览。可以在 joinChannel 之前就开启预览会自动打开摄像头。

返回说明

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

stopPreview

关闭本地视频预览

public stopPreview(): number

说明

leaveChannel 会自动停止本地预览；如果没有在推相机流，则会自动关闭摄像头。

返回说明

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

setCameraCaptureConfiguration

设置摄像头采集偏好

public setCameraCaptureConfiguration(cameraCaptureConfiguration: AliRtcCameraCaptureConfiguration): number

说明

必须在打开摄像头之前设置，如 startPreview，joinChannel 之前设置

参数说明

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

返回说明

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

enableLocalVideo

禁用或启用本地视频采集

public enableLocalVideo(enabled: boolean): number

说明

默认为开启状态, 通过监听 AliRtcEngineEventListener#onUserVideoEnabled 获取用户是否禁用或启用本地视频采集状态。

参数说明

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

返回说明

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

enableVideoCapture

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

public enableVideoCapture(enabled: boolean): number

说明

关闭摄像头后，发送黑色的视频帧。编码，发送模块仍然工作，只是视频内容是黑色帧

参数说明

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

返回说明

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

muteLocalCamera

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

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

说明

此接口只是控制指定视频流上是否发送黑帧，采集和数据发送不会停止

参数说明

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

返回说明

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

isCameraOn

检查当前是否打开摄像头

public isCameraOn(): boolean

说明

该接口用于检查当前camera的状态

返回说明

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

muteAllRemoteVideoRendering

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

public muteAllRemoteVideoRendering(mute: boolean): number

说明

拉流和解码不受影响。支持joinChannel之前和之后设置

参数说明

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

返回说明

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

setVideoEncoderConfiguration

设置相机流视频编码属性

public setVideoEncoderConfiguration(config: AliRtcVideoEncoderConfiguration): number

说明

该方法在入会前和入会后都可以调用，如果每次入会只需要设置一次相机流视频编码属性，建议在入会前调用

参数说明

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

返回说明

number - 0 成功；<0:失败

setVideoDecoderConfiguration

设置相机流视频解码属性

public setVideoDecoderConfiguration(config: AliRtcVideoDecoderConfiguration): void

说明

该方法在入会前调用

参数说明

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

setVideoMirrorMode

设置预览和推流镜像能力

public setVideoMirrorMode(mirrorMode: AliRtcVideoPipelineMirrorMode): number

说明

此接口在入会前和入会后均可以动态设置，SDK内部会记录状态，并在可以操作预览及编码的时候对视频进行操作；使用此接口的优先级会高于 setLocalViewConfig 与 setVideoEncoderConfiguration；此接口与 setLocalViewConfig 与 setVideoEncoderConfiguration 里面的mirror重合，建议只用一个方式

参数说明

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

返回说明

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

setCapturePipelineScaleMode

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

public setCapturePipelineScaleMode(mode: AliRtcCapturePipelineScaleMode): void

说明

必须在打开摄像头之前设置，如 startPreview，joinChannel 之前设置

参数说明

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

setRemoteViewConfig

设置远端视频显示视图

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

说明

支持joinChannel之前和之后切换窗口。如果canvas或者 AliRtcVideoCanvas#view 为null，则停止显示

参数说明

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

返回说明

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

switchCamera

切换前后摄像头

public switchCamera(): number

返回说明

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

getCurrentCameraDirection

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

public getCurrentCameraDirection(): AliRtcCameraDirection

说明

AliRtcCameraDirectionFront 前置；AliRtcCameraDirectionBack 后置；AliRtcCameraDirectionInvalid 无效

返回说明

AliRtcCameraDirection - 摄像头方向

setCameraZoom

设置摄像头缩放比例

public setCameraZoom(zoom: number): number

参数说明

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

返回说明

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

getCameraMaxZoomFactor

获取摄像头最大缩放比例

public getCameraMaxZoomFactor(): number

返回说明

number - 摄像头最大缩放比例

getCurrentZoom

获取摄像头缩放比例

public getCurrentZoom(): number

返回说明

number - 摄像头缩放比例

setExposure

设置摄像头曝光度

public setExposure(exposure: number): number

参数说明

参数	类型	描述
exposure	number	曝光度

返回说明

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

getCurrentExposure

获取摄像头曝光度

public getCurrentExposure(): number

返回说明

number - 摄像头曝光度

getMinExposure

获取摄像头最小曝光度

public getMinExposure(): number

返回说明

number - 摄像头最小曝光度

getMaxExposure

获取摄像头最大曝光度

public getMaxExposure(): number

返回说明

number - 摄像头最大曝光度

setCameraFlash

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

public setCameraFlash(flash: boolean): number

参数说明

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

返回说明

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

isCameraFocusPointSupported

摄像头是否支持手动聚焦

public isCameraFocusPointSupported(): boolean

返回说明

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

isCameraExposurePointSupported

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

public isCameraExposurePointSupported(): boolean

返回说明

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

setCameraFocusPoint

设置摄像头手动聚焦

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

参数说明

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

返回说明

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

setCameraExposurePoint

设置摄像头曝光点

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

参数说明

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

返回说明

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

getVideoCodecType

获取视频编解码格式

public getVideoCodecType(codeKind: AliRtcVideoCodecKindType): AliRtcVideoFormat

参数说明

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

返回说明

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

getCurrentEncoderManufacturer

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

public getCurrentEncoderManufacturer(track: AliRtcVideoTrack): AliRtcVideoCodecManufacturer

参数说明

参数	类型	描述
track	AliRtcVideoTrack	AliRtcVideoTrack

返回说明

AliRtcVideoCodecManufacturer - 编码器类型

snapshotVideo

视频截图功能

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

说明

视频截图功能为异步接口, 通过监听 AliRtcEngineEventListener#onSnapshotCompleted 回调获取当前截图画面。

参数说明

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

返回说明

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

setScreenShareEncoderConfiguration

设置屏幕流视频编码属性

public setScreenShareEncoderConfiguration(config: AliRtcScreenShareEncoderConfiguration): number

说明

该方法在入会前和入会后都可以调用，如果每次入会只需要设置一次屏幕流视频编码属性，建议在入会前调用

参数说明

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

startScreenShare

开启屏幕帧监听

public startScreenShare(mode: AliRtcScreenShareMode): number

参数说明

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

stopScreenShare

停止屏幕共享

public stopScreenShare(): number

返回说明

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

isScreenSharePublished

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

public isScreenSharePublished(): boolean

说明

SDK默认设置不推送屏幕分享，如果需要推送屏幕共享，可以通过 startScreenShare 开启

返回说明

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

registerAudioFrameObserver

注册音频数据回调

public registerAudioFrameObserver(observer: AliRtcEngineAudioFrameListener | null): void

说明

需要调用EnableAudioFrameObserver开启具体AliRtcAudioSource的回调

参数说明

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

enableAudioFrameObserver

订阅音频数据

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

说明

只支持ReadOnly模式

参数说明

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

返回说明

number - 0: success

addExternalAudioStream

新增外部音频流

public addExternalAudioStream(config: AliRtcExternalAudioStreamConfig): number

参数说明

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

返回说明

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

pushExternalAudioStreamRawData

输入外部音频数据

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

说明

为了保证语音连续性，sdk内部会有buffer缓存送进来的音频数据，以每次送10ms数据为例，如果返回 AliRtcErrorCode#ERR_SDK_AUDIO_INPUT_BUFFER_FULL 时，说明内部缓冲区已满，建议等待20ms后再重新送当前数据帧；

参数说明

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

返回说明

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

setExternalAudioStreamPlayoutVolume

设置外部音频流播放音量

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

参数说明

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

返回说明

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

getExternalAudioStreamPlayoutVolume

获取外部音频流播放音量

public getExternalAudioStreamPlayoutVolume(streamId: number): number

参数说明

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

返回说明

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

setExternalAudioStreamPublishVolume

设置外部音频流推流音量

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

参数说明

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

返回说明

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

getExternalAudioStreamPublishVolume

获取外部音频流推流音量

public getExternalAudioStreamPublishVolume(streamId: number): number

参数说明

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

返回说明

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

removeExternalAudioStream

移除外部音频流

public removeExternalAudioStream(streamId: number): number

参数说明

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

返回说明

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

setExternalVideoSource

启用外部视频输入源

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

输入视频数据

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

说明

如果返回值为errorCode中的AliRtcErrVideoBufferFull，代表当前buffer队列塞满，需要等待后再继续输送数据

参数说明

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

返回说明

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

setExternalImageData

输入视频数据

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

参数说明

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

返回说明

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

setAudioEffectPitchValue

设置变调参数

public setAudioEffectPitchValue(value: number): number

说明

加入频道前和频道过程中调用都生效

参数说明

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

返回说明

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

setAudioEffectVoiceChangerMode

设置变声音效模式

public setAudioEffectVoiceChangerMode(mode: AliRtcAudioEffectVoiceChangerMode): number

说明

加入频道前和频道过程中调用都生效

参数说明

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

返回说明

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

setAudioEffectReverbMode

设置混响音效模式

public setAudioEffectReverbMode(mode: AliRtcAudioEffectReverbMode): number

说明

加入频道前和频道过程中调用都生效

参数说明

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

返回说明

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

setAudioEffectBeautifyMode

设置美声音效模式

public setAudioEffectBeautifyMode(mode: AliRtcAudioEffectBeautifyMode): number

说明

加入频道前和频道过程中调用都生效

参数说明

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

返回说明

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

setAudioEffectReverbParamType

设置混响音效类型

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

说明

需要在 setAudioEffectReverbMode 之后调用

参数说明

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

返回说明

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

setAudioEffectEqualizationParam

设置均衡器音效类型

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

说明

需要在 setAudioEffectBeautifyMode 之后调用

参数说明

参数	类型	描述
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：失败

startAudioAccompany

开始伴奏混音

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

说明

异步接口，可通过 AliRtcEngineEventListener#onAudioAccompanyStateChanged 监听播放器状态

参数说明

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

返回说明

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

stopAudioAccompany

停止伴奏混音

public stopAudioAccompany(): number

返回说明

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

setAudioAccompanyVolume

设置伴奏音量

public setAudioAccompanyVolume(volume: number): number

说明

同时设置伴奏本地播放音量与伴奏推流音量；设置音量需要在 startAudioAccompany 后才能生效

参数说明

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

返回说明

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

setAudioAccompanyPublishVolume

设置伴奏推流音量

public setAudioAccompanyPublishVolume(volume: number): number

说明

设置音量需要在 startAudioAccompany 后才能生效

参数说明

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

返回说明

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

getAudioAccompanyPublishVolume

获取伴奏推流音量

public getAudioAccompanyPublishVolume(): number

返回说明

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

setAudioAccompanyPlayOutVolume

设置伴奏本地播放音量

public setAudioAccompanyPlayOutVolume(volume: number): number

说明

设置音量需要在 startAudioAccompany 后才能生效

参数说明

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

返回说明

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

getAudioAccompanyPlayOutVolume

获取伴奏本地播放音量

public getAudioAccompanyPlayOutVolume(): number

返回说明

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

pauseAudioAccompany

暂停伴奏混音

public pauseAudioAccompany(): number

返回说明

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

resumeAudioAccompany

重新开始伴奏混音

public resumeAudioAccompany(): number

返回说明

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

getAudioAccompanyDuration

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

public getAudioAccompanyDuration(): number

返回说明

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

getAudioAccompanyCurrentPosition

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

public getAudioAccompanyCurrentPosition(): number

返回说明

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

setAudioAccompanyPosition

设置伴奏文件的播放位置

public setAudioAccompanyPosition(pos: number): number

参数说明

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

返回说明

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

preloadAudioEffect

预加载音效文件

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

说明

音效相关接口为同步接口, 建议使用本地文件

参数说明

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

返回说明

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

unloadAudioEffect

删除预加载的音效文件

public unloadAudioEffect(soundId: number): number

说明

音效soundId应与预加载 preloadAudioEffect 时传入的ID相同

参数说明

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

返回说明

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

playAudioEffect

开始播放音效

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

说明

开始播放音效接口，可以多次调用该方法传入不同的soundId和filePath，同时播放多个音效文件，音效文件播放结束后，SDK 会触发 AliRtcEngineEventListener#onAudioEffectFinished 回调

参数说明

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

返回说明

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

pauseAudioEffect

暂停音效

public pauseAudioEffect(soundId: number):number

参数说明

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

返回说明

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

pauseAllAudioEffects

暂停所有音效

public pauseAllAudioEffects(): number

返回说明

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

resumeAudioEffect

恢复指定音效文件

public resumeAudioEffect(soundId: number): number

参数说明

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

返回说明

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

resumeAllAudioEffects

恢复所有音效文件

public resumeAllAudioEffects (): number

返回说明

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

stopAudioEffect

停止播放音效

public stopAudioEffect(soundId: number): number

参数说明

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

返回说明

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

stopAllAudioEffects

停止播放所有音效

public stopAllAudioEffects(): number

返回说明

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

setAudioEffectPublishVolume

设置音效推流混音音量

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

说明

该方法需要在 playAudioEffect 后调用

参数说明

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

返回说明

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

getAudioEffectPublishVolume

获取音效推流混音音量

public getAudioEffectPublishVolume(soundId: number): number

说明

音效推流混音音量有效范围为：[0, 100]，该方法需要在 playAudioEffect 后调用

参数说明

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

返回说明

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

setAudioEffectPlayOutVolume

设置音效本地播放音量

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

说明

该方法需要在 playAudioEffect 后调用

参数说明

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

返回说明

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

getAudioEffectPlayOutVolume

获取音效本地播放音量

public getAudioEffectPlayOutVolume(soundId: number): number

说明

音效本地播放音量有效范围为：[0, 100]，该方法需要在 playAudioEffect 后调用

参数说明

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

返回说明

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

setAllAudioEffectsPublishVolume

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

public setAllAudioEffectsPublishVolume(soundId: number): number

参数说明

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

返回说明

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

setAllAudioEffectsPlayoutVolume

设置所有音效本地播音量

public setAllAudioEffectsPlayoutVolume(soundId: number): number

参数说明

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

返回说明

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

enableSEIVideoStream

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

public enableSEIVideoStream(enabled: boolean): number

参数说明

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

返回说明

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

sendMediaExtensionMsg

发送媒体扩展信息

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

说明

SDK提供了发送和接收媒体扩展信息的功能，接收端参考 AliRtcEngineEventListener#onMediaExtensionMsgReceived，使用场景：使用媒体扩展信息传递时间戳，计算端到端的网络延迟，或者跟自身其他业务做数据同步；使用媒体扩展信息传递描述信息。目前可以传递最多 4k Byte数据，可以用来传输少量数据，建议使用Json或者纯字符串；内部使用SEI扩展协议来实现；

参数说明

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

返回说明

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

sendMediaExtensionMsgEx

发送媒体扩展信息

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: 失败

sendDataChannelMsg

发送数据消息

public sendDataChannelMsg(controlMsg: AliRtcDataChannelMsg): number

参数说明

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

返回说明

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

startRecord

开始文件录制

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

参数说明

参数	类型	描述
recordType	AliRtcRecordType	录制类型详细定义见 AliRtcRecordType
recordFormat	AliRtcRecordFormat	录制文件格式，如果录制视频(recordType=AliRtcRecordTypeVideo)，则忽略该配置详细定义见 AliRtcRecordFormat
filePath	string	文件路径
audioConfig	AliRtcRecordAudioConfig \| undefined	音频设置详细定义见 AliRtcRecordAudioConfig
videoConfig	AliRtcRecordVideoConfig \| undefined	视频设置详细定义见 AliRtcRecordVideoConfig

返回说明

boolean - true: 成功；false: 失败

stopRecord

停止文件录制

public stopRecord(): void

startPublishLiveStream

开启旁路直播

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

说明

SDK提供了开启旁路直播的功能，可以把实时音视频流经过混流、混音处理转为标准直播流并推送至指定CDN供应商

参数说明

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

返回说明

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

updatePublishLiveStream

更新旁路直播相关参数

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

说明

SDK提供了更新旁路直播的功能，用于实时更新旁路直播参数

参数说明

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

返回说明

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

stopPublishLiveStream

停止旁路直播

public stopPublishLiveStream(streamURL: string) : number

说明

SDK提供了停止旁路直播的功能

参数说明

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

返回说明

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

getPublishLiveStreamState

获得旁路直播状态

public getPublishLiveStreamState(streamURL: string): AliRtcLiveTranscodingState

参数说明

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

返回说明

AliRtcLiveTranscodingState - 返回 AliRtcLiveTranscodingState

updatePublishLiveStreamWithTaskId

更新旁路直播相关参数

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

说明

SDK提供了更新旁路直播的功能，用于实时更新旁路直播参数

参数说明

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

返回说明

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

stopPublishLiveStreamWithTaskId

停止旁路直播

public stopPublishLiveStreamWithTaskId(taskId: string): number

说明

SDK提供了停止旁路直播的功能

参数说明

参数	类型	描述
taskId	string	任务id

返回说明

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

getPublishLiveStreamStateWithTaskId

获得旁路直播状态

public getPublishLiveStreamStateWithTaskId(taskId: string): AliRtcLiveTranscodingState

参数说明

参数	类型	描述
taskId	string	任务Id

返回说明

AliRtcLiveTranscodingState - 返回 AliRtcLiveTranscodingState

publishStreamByRtsUrl

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

public publishStreamByRtsUrl(rtsUrl: string): number

说明

该接口用于推送本地音视频流到指定的rts url

参数说明

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

返回说明

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

stopPublishStreamByRtsUrl

根据RtsUrl停止推流

public stopPublishStreamByRtsUrl(rtsUrl: string): number

说明

该接口用于停止推送本地音视频流

参数说明

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

返回说明

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

subscribeStreamByRtsUrl

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

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

说明

该接口用于推送本地音视频流到指定的rts url

参数说明

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

返回说明

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

stopSubscribeStreamByRtsUserId

根据Rts user id停止拉流

public stopSubscribeStreamByRtsUserId(uid: string): number

说明

该接口用于停止拉取音视频流

参数说明

参数	类型	描述
uid	string	rts user id

返回说明

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

pauseRtsStreamByRtsUserId

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

public pauseRtsStreamByRtsUserId(uid: string): number

参数说明

参数	类型	描述
uid	string	rts user id

返回说明

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

resumeRtsStreamByRtsUserId

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

public resumeRtsStreamByRtsUserId(uid: string): number

参数说明

参数	类型	描述
uid	string	rts user id

返回说明

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

startLastmileDetect

开始网络质量探测

public startLastmileDetect(config: AliRtcNetworkProbeConfig): number

说明

网络质量探测需要在未入会情况下调用，探测结果在3s左右，粗略的结果会在 onLastmileDetectResultWithQuality: 中回调；在30s左右，更多的结果会在 onLastmileDetectResultWithBandWidth: 中回调

参数说明

参数	类型	描述
config	AliRtcNetworkProbeConfig	探测配置项详细定义见 AliRtcNetworkProbeConfig

返回说明

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

stopLastmileDetect

停止网络质量探测

public stopLastmileDetect(): number

返回说明

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

setLogDirPath

设置SDK日志文件保存路径

public static setLogDirPath(logDirPath: string): number

说明

调用此接口，请在调用其他所有SDK接口前调用本接口，避免日志出现丢失。同时，App必须保证指定的目录已存在并且可以写入。

参数说明

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

返回说明

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

setLogLevel

设置日志等级

public static setLogLevel(logLevel: AliRtcLogLevel): void

说明

设置 SDK 的输出日志等级。默认值为AliRtcLogLevel；调用此接口，请在仅次于 setLogDirPath 接口调用之后再调用本接口，避免因日志等级切换造成的打印丢失。

参数说明

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

enableUploadLog

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

public static enableUploadLog(enable: boolean): void

说明

入会前调用此接口，请在SetLogLevel接口调用之后立即调用本接口。

参数说明

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

setExtras

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

public setExtras(extras: string): number

参数说明

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

返回说明

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

setParameter

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

public setParameter(param: string): number

参数说明

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

返回说明

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

getParameter

获取自定义属性

public getParameter(paramKey: string): string

参数说明

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

返回说明

string - 属性值

enableStatsReport

设置是否上传业务埋点，默认上传

public enableStatsReport(enabled: boolean): void

说明

在调用创建 AliRtcEngine 实例后，应立即调用此接口，避免预期之外的埋点上传

参数说明

参数	类型	描述
enabled	boolean	true 上传业务埋点；false 不上传业务埋点

getNetworkTime

获取时间轴时间

public getNetworkTime(): number

返回说明

number - 时间戳

onRemoteUserOnline

远端用户（通信模式）/（互动模式，主播角色）加入频道回调

onRemoteUserOnline : (func: OnRemoteUserOnLineNotify) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户ID，从App server分配的唯一标示符
online	boolean	是否上线

onRemoteUserOffline

远端用户（通信模式）/（互动模式，主播角色）离开频道回调

onRemoteUserOffline : (func: OnRemoteUserOffLineNotify) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户ID，从App server分配的唯一标示符
reason	AliRtcUserOfflineReason	用户离线的原因

onJoinChannel

加入频道回调

onJoinChannel : (func: OnJoinChannelCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
result	number	加入频道结果，0表示成功，非0表示失败
channel	string	加入频道名
userId	string	用户ID
elapsed	number	加入频道耗时

onLeaveChannel

离开频道回调

onLeaveChannel : (func: OnLeaveChannelCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
result	number	离开频道结果，成功返回0，失败返回错误码
stat	AliRtcStats	本次频道内会话的数据统计信息

onConnectionStatusChange

网络连接状态改变回调

onConnectionStatusChange : (func: OnConnectionStatusChangeCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
status	number	连接状态
reason	number	连接状态变化原因

onBye

被服务器踢出/会议结束频道的消息回调

onBye : (func: OnByeCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
code	number	原因

onAudioPublishStateChanged

音频推流变更回调

onAudioPublishStateChanged : (func: OnAudioPublishStateChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
audioTrack	AliRtcAudioTrack	流标识
oldState	AliRtcPublishState	之前的推流状态
newState	AliRtcPublishState	当前的推流状态
elapseSinceLastState	number	状态变更时间间隔(毫秒)
channel	string	当前频道

onVideoPublishStateChanged

视频推流变更回调

onVideoPublishStateChanged : (func: OnVideoPublishStateChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
oldState	AliRtcPublishState	之前的推流状态
newState	AliRtcPublishState	当前的推流状态
elapseSinceLastState	number	状态变更时间间隔(毫秒)
channel	string	当前频道

onScreenSharePublishStateChanged

屏幕流推流变更回调

onScreenSharePublishStateChanged : (func: OnScreenSharePublishStateChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
oldState	AliRtcPublishState	之前的推流状态
newState	AliRtcPublishState	当前的推流状态
elapseSinceLastState	number	状态变更时间间隔(毫秒)
channel	string	当前频道

onDualVideoStreamPublishStateChanged

视频次要流推流变更回调

onDualVideoStreamPublishStateChanged : (func: OnDualVideoStreamPublishStateChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
oldState	AliRtcPublishState	之前的推流状态
newState	AliRtcPublishState	当前的推流状态
elapseSinceLastState	number	状态变更时间间隔(毫秒)
channel	string	当前频道

onAudioSubscribeStateChanged

音频订阅情况变更回调

onAudioSubscribeStateChanged : (func: OnAudioSubscribeStateChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户ID
audioTrack	AliRtcAudioTrack	音频流类型
oldState	AliRtcSubscribeState	之前的订阅状态
newState	AliRtcSubscribeState	当前的订阅状态
elapseSinceLastState	number	状态变更时间间隔(毫秒)
channel	string	当前频道

onVideoSubscribeStateChanged

相机流订阅情况变更回调

onVideoSubscribeStateChanged : (func: OnVideoSubscribeStateChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户ID
oldState	AliRtcSubscribeState	之前的订阅状态
newState	AliRtcSubscribeState	当前的订阅状态
elapseSinceLastState	number	状态变更时间间隔(毫秒)
channel	string	当前频道

onSubscribeStreamTypeChanged

大小流订阅情况变更回调

onSubscribeStreamTypeChanged : (func: OnSubscribeStreamTypeChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户ID
oldStreamType	AliRtcVideoStreamType	之前的订阅状态
newStreamType	AliRtcVideoStreamType	当前的订阅状态
elapseSinceLastState	number	状态变更时间间隔(毫秒)
channel	string	当前频道

onRemoteTrackAvailableNotify

远端用户的音视频流发生变化回调

onRemoteTrackAvailableNotify : (func: OnRemoteTrackAvailableNotifyCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户ID，从App server分配的唯一标示符
audioTrack	AliRtcAudioTrack	音频流类型
videoTrack	AliRtcVideoTrack	视频流类型

onFirstRemoteVideoFrameDrawn

远端用户的第一帧视频帧显示时触发这个消息

onFirstRemoteVideoFrameDrawn : (func: OnFirstRemoteVideoFrameDrawnCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户ID，从App server分配的唯一标示符
videoTrack	AliRtcVideoTrack	屏幕流或者相机流
width	number	视频宽度
height	number	视频高度
elapsed	number	本地用户加入频道直至该回调触发的延迟总耗时（毫秒）

onFirstLocalVideoFrameDrawn

预览开始显示第一帧视频帧时触发这个消息

onFirstLocalVideoFrameDrawn : (func: OnFirstLocalVideoFrameDrawnCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
width	number	本地预览视频宽度
height	number	本地预览视频高度
elapsed	number	从本地用户加入频道直至该回调触发的延迟总耗时（毫秒）

onFirstVideoPacketSend

视频首包发送回调

onFirstVideoPacketSend : (func: OnFirstVideoPacketSendCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
videoTrack	AliRtcVideoTrack	接收视频track
timeCost	number	发送耗时，从入会开始到视频首包发送的耗时

onFirstVideoPacketReceived

视频首包接收回调

onFirstVideoPacketReceived : (func: OnFirstVideoPacketReceivedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	远端用户ID，从App server分配的唯一标示符
videoTrack	AliRtcVideoTrack	接收视频track
timeCost	number	耗时（毫秒）

onFirstVideoFrameReceived

收到远端用户视频首帧的回调

onFirstVideoFrameReceived : (func: OnFirstVideoFrameReceivedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户ID，从App server分配的唯一标示符
videoTrack	AliRtcVideoTrack	接收视频track
timeCost	number	耗时（毫秒）

onVideoResolutionChanged

分辨率变化回调

onVideoResolutionChanged : (func: OnVideoResolutionChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户id
track	AliRtcVideoTrack	变化视频track
width	number	当前视频宽
height	number	当前视频高

onFirstAudioPacketSend

音频首包发送回调

onFirstAudioPacketSend : (func: OnFirstAudioPacketSendCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
audioTrack	AliRtcAudioTrack	接收音频track
timeCost	number	发送耗时，从入会开始到音频首包发送的耗时

onFirstAudioPacketReceived

音频首包接收回调

onFirstAudioPacketReceived : (func: OnFirstAudioPacketReceivedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	远端用户ID，从App server分配的唯一标识符
audioTrack	AliRtcAudioTrack	接收音频track
timeCost	number	接收耗时，从入会开始到音频首包接收到的耗时

onFirstRemoteAudioDecoded

已解码远端音频首帧回调

onFirstRemoteAudioDecoded : (func: OnFirstRemoteAudioDecodedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	远端用户ID，从App server分配的唯一标识符
audioTrack	AliRtcAudioTrack	接收音频track
elapsed	number	从本地用户加入频道直至该回调触发的延迟, 单位为毫秒

onAudioVolumeCallback

订阅的音频音量回调

onAudioVolumeCallback : (func: OnAudioVolumeCallbackCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
volumeInfo	AliRtcUserVolumeInfo[]	说话人音量信息
volumeInfoCount	number	回调的说话人的个数
totalVolume	number	混音后的总音量，范围[0,255]

onTestAudioVolumeCallback

订通话前音频采集检测的音量回调

onTestAudioVolumeCallback : (func: OnTestAudioVolumeCallbackCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
volume	number	采集到的音量

onActiveSpeaker

订阅的当前说话人回调

onActiveSpeaker : (func: OnActiveSpeakerCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	说话人的用户ID

onAudioAccompanyStateChanged

本地伴奏播放状态回调

onAudioAccompanyStateChanged : (func: OnAudioAccompanyStateChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
playState	AliRtcAudioAccompanyStateCode	当前播放状态
errorCode	AliRtcAudioAccompanyErrorCode	播放错误码

onAudioEffectFinished

本地音效播放结束回调

onAudioEffectFinished : (func: OnAudioEffectFinishedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
soundId	number	用户给该音效文件分配的唯一ID

onNetworkQualityChanged

网络质量变化时发出的消息

onNetworkQualityChanged : (func: OnNetworkQualityChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户ID，为空时表示本地用户上下行网络状态
upQuality	AliRtcNetworkQuality	上行网络状态
downQuality	AliRtcNetworkQuality	下行网络状态

onLastmileDetectResultWithQuality

网络质量探测回调

onLastmileDetectResultWithQuality : (func: OnLastmileDetectResultWithQualityCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
networkQuality	AliRtcNetworkQuality	网络质量

onLastmileDetectResultWithBandWidth

网络质量探测结果的回调

onLastmileDetectResultWithBandWidth : (func: OnLastmileDetectResultWithBandWidthCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
code	number	探测结果，0 成功，-1失败，网络状况较差
result	AliRtcNetworkProbeResult	网络质量

onStats

当前会话统计信息回调

onStats : (func: OnStatsCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
stats	AliRtcStats	会话统计信息

onLocalVideoStats

本地视频统计信息回调

onLocalVideoStats : (func: OnLocalVideoStatsCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
localVideoStats	AliRtcLocalVideoStats	本地视频统计信息

onRemoteVideoStats

远端视频统计信息回调

onRemoteVideoStats : (func: OnRemoteVideoStatsCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
remoteVideoStats	AliRtcRemoteVideoStats	远端视频统计信息

onLocalAudioStats

本地音频统计信息回调

onLocalAudioStats : (func: OnLocalAudioStatsCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
localAudioStats	AliRtcLocalAudioStats	本地视频统计信息

onRemoteAudioStats

远端音频统计信息回调

onRemoteAudioStats : (func: OnRemoteAudioStatsCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
remoteAudioStats	AliRtcRemoteAudioStats	远端视频统计信息

onPublishLiveStreamStateChanged

旁路推流状态改变回调

onPublishLiveStreamStateChanged : (func: OnPublishLiveStreamStateChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
streamUrl	string	流地址
state	AliRtcLiveTranscodingState	推流状态
errCode	AliRtcLiveTranscodingErrorCode	错误码

onPublishLiveStreamStateChangedWithTaskId

旁路推流状态改变回调（基于任务ID）

onPublishLiveStreamStateChangedWithTaskId : (func: OnPublishLiveStreamStateChangedWithTaskIdCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
taskId	string	任务id
state	AliRtcLiveTranscodingState	推流状态
errCode	AliRtcLiveTranscodingErrorCode	错误码

onPublishLiveTaskStatusChanged

旁路任务状态改变回调

onPublishLiveTaskStatusChanged : (func: OnPublishLiveTaskStatusChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
streamUrl	string	流地址
status	AliRtcLiveTranscodingTaskStatus	任务状态

onPublishLiveTaskStatusChangedWithTaskId

旁路任务状态改变回调（基于任务ID）

onPublishLiveTaskStatusChangedWithTaskId : (func: OnPublishLiveTaskStatusChangedWithTaskIdCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
taskId	string	任务id
status	AliRtcLiveTranscodingTaskStatus	任务状态

onUserAudioMuted

远端用户静音/取消静音回调

onUserAudioMuted : (func: OnUserAudioMutedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	远端用户ID
isMute	boolean	该用户是否静音

onUserVideoMuted

对端用户发送视频黑帧数据发送通知

onUserVideoMuted : (func: OnUserVideoMutedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	执行muteVideo的用户ID
isMute	boolean	是否推流黑帧

onUserVideoEnabled

对端用户关闭相机流采集发送通知

onUserVideoEnabled : (func: OnUserVideoEnabledCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	执行EnableLocalVideo的用户ID
isEnable	boolean	是否打开相机流采集

onUpdateRoleNotify

当用户角色发生变化时通知

onUpdateRoleNotify : (func: OnUpdateRoleNotifyCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
oldRole	AliRtcClientRole	变化前角色类型
newRole	AliRtcClientRole	变化后角色类型

onRemoteAudioAccompanyStarted

远端用户伴奏播放开始回调

onRemoteAudioAccompanyStarted : (func: OnRemoteAudioAccompanyStartedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	远端用户ID，从App server分配的唯一标识符

onRemoteAudioAccompanyFinished

远端用户伴奏播放结束回调

onRemoteAudioAccompanyFinished : (func: OnRemoteAudioAccompanyFinishedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	远端用户ID，从App server分配的唯一标识符

onMediaExtensionMsgReceived

收到媒体扩展信息回调

onMediaExtensionMsgReceived : (func: OnMediaExtensionMsgReceivedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	发送用户userId
payloadType	number	消息类型
message	ArrayBuffer	扩展信息内容

onLocalDeviceException

本地设备异常回调

onLocalDeviceException : (func: OnLocalDeviceExceptionCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
deviceType	AliRtcLocalDeviceType	设备类型
exceptionType	AliRtcLocalDeviceExceptionType	设备异常类型
msg	string	异常时携带的信息

onDataChannelMessage

dataChannel消息回调

onDataChannelMessage : (func: OnDataChannelMessageCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户
msg	AliRtcDataChannelMsg	消息

onRemoteVideoChanged

远端视频流发生变化回调

onRemoteVideoChanged : (func: OnRemoteVideoChangedCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	需要被通知的用户
trackType	AliRtcVideoTrack	变化视频track
state	AliRtcVideoState	视频状态的类型
reason	AliRtcVideoReason	触发状态变化的原因

onAuthInfoWillExpire

用户authInfo即将过期通知

onAuthInfoWillExpire : (func: OnAuthInfoWillExpireCallback) => AliRtcEngineEventListener;

onAuthInfoExpired

用户调用需要鉴权的接口，服务端返回信息过期

onAuthInfoExpired : (func: OnAuthInfoExpiredCallback) => AliRtcEngineEventListener;

onAIAgentResult

AI agent处理结果回调

onAIAgentResult : (func: OnAIAgentResultCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
code	number	返回code码
action	string	结果对应的action
result	string	结果

onRemoteUserSubscribedDataChannel

可以开始发送data channel消息回调

onRemoteUserSubscribedDataChannel : (func: OnRemoteUserSubscribedDataChannelCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	用户

onAudioDelayInfo

音频延时信息回调

onAudioDelayInfo : (func: OnAudioDelayInfoCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
sentenceId	number	语句id
questionEndTime	number	提问结束时刻
answerStartTime	number	回答开始时刻

onLocalAudioCaptureStateChanged

本地音频采集设备状态回调

onLocalAudioCaptureStateChanged : (func: (state: AliRtcLocalAudioState, msg: string) => void) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
state	AliRtcLocalAudioState	设备状态
msg	string	设备状态变化的描述信息

onLocalVideoCaptureStateChanged

本地视频采集设备状态回调

onLocalVideoCaptureStateChanged : (func: (state: AliRtcLocalVideoState, msg: string) => void) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
state	AliRtcLocalVideoState	设备状态
msg	string	设备状态变化的描述信息

onRecordEvent

文件录制回调事件

onRecordEvent : (func: OnRecordEventCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
event	number	录制事件
filePath	string	录制文件路径

onOccurWarning

警告通知

onOccurWarning : (func: OnOccurWarningCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
warn	number	警告类型
msg	string	警告消息

onOccurError

错误通知

onOccurError : (func: OnOccurErrorCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
error	number	错误类型
msg	string	错误消息

onPublishStreamByRtsUrlResult

启动RTS URL推流结果

onPublishStreamByRtsUrlResult : (func: OnRtsUrlResultCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
rtsUrl	string	推流链接
result	number	推流结果，成功返回0，失败返回错误码

onStopPublishStreamByRtsUrlResult

结束RTS URL推流结果

onStopPublishStreamByRtsUrlResult : (func: OnRtsUrlResultCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
rtsUrl	string	推流链接
result	number	推流结果，成功返回0，失败返回错误码

onSubscribeStreamByRtsUrlResult

订阅RTS URL结果回调

onSubscribeStreamByRtsUrlResult : (func: OnRtsUrlUidResultCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	订阅的用户ID
result	number	订阅结果，成功返回0，失败返回错误码

onStopSubscribeStreamByRtsUrlResult

取消订阅使用RTS URL结果回调

onStopSubscribeStreamByRtsUrlResult : (func: OnRtsUrlUidResultCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	取消订阅的用户ID
result	number	取消订阅结果，成功返回0，失败返回错误码

onSubscribedRtsStreamBeyondLimit

RTS URL预建联数目超限回调

onSubscribedRtsStreamBeyondLimit : (func: OnSubscribedRtsStreamBeyondLimitCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	销毁订阅RTS流的用户ID
rtsUrl	string	销毁订阅RTS流的URL

onPauseRtsStreamResult

使用RTS UID 暂停订阅结果回调

onPauseRtsStreamResult : (func: OnRtsUrlUidResultCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	暂停订阅的用户ID
result	number	暂停订阅结果，成功返回0，失败返回错误码

onResumeRtsStreamResult

使用RTS UID 恢复订阅结果回调

onResumeRtsStreamResult : (func: OnRtsUrlUidResultCallback) => AliRtcEngineEventListener;

回调函数参数

参数	类型	说明
uid	string	恢复订阅的用户ID
result	number	恢复订阅结果，成功返回0，失败返回错误码

onCapturedAudioFrame

采集裸数据回调

onCapturedAudioFrame : (func: OnAudioFrameFunc) => AliRtcEngineAudioFrameListener;

回调函数参数

参数	类型	说明
audioFrame	AliRtcAudioFrame	音频数据

onProcessCapturedAudioFrame

3A后数据回调

onProcessCapturedAudioFrame : (func: OnAudioFrameFunc) => AliRtcEngineAudioFrameListener;

回调函数参数

参数	类型	说明
audioFrame	AliRtcAudioFrame	音频数据

onPublishAudioFrame

推流数据回调

onPublishAudioFrame : (func: OnAudioFrameFunc) => AliRtcEngineAudioFrameListener;

回调函数参数

参数	类型	说明
audioFrame	AliRtcAudioFrame	音频数据

onPlaybackAudioFrame

播放数据回调

onPlaybackAudioFrame : (func: OnAudioFrameFunc) => AliRtcEngineAudioFrameListener;

回调函数参数

参数	类型	说明
audioFrame	AliRtcAudioFrame	音频数据

onMixedAllAudioFrame

推流数据和播放数据混音后回调

onMixedAllAudioFrame : (func: OnAudioFrameFunc) => AliRtcEngineAudioFrameListener;

回调函数参数

参数	类型	说明
audioFrame	AliRtcAudioFrame	音频数据

onRemoteUserAudioFrame

远端拉流数据回调

onRemoteUserAudioFrame : (func: OnRemoteUserAudioFrameFunc) => AliRtcEngineAudioFrameListener;

回调函数参数

参数	类型	说明
uid	string	用户id
audioFrame	AliRtcAudioFrame	音频数据

目录

基础接口

频道相关接口

发布及订阅相关接口

音频设备管理相关接口

视频设备管理相关接口

桌面共享

配置音频数据回调

自定义音频输入

自定义视频输入

音频变声与混响

播放伴奏

播放音效

SEI

Data Channel

文件录制

旁路直播

推拉RTS裸流

网络质量探测

其他接口

回调接口

接口详情

getInstance

destroyInstance

getSDKVersion

setH5CompatibleMode

getH5CompatibleMode

setRtcEngineEventListener

getNativeHandle

setChannelProfile

setClientRole

getCurrentClientRole

joinChannel

joinChannelWithToken

joinChannelWithChannelParam

joinAIChannel

leaveChannel

getCurrentConnectionStatus

isInCall

refreshAuthInfo

refreshAuthInfoWithToken

isAudioOnlyMode

publishLocalVideoStream

isLocalVideoStreamPublished

publishLocalDualVideoStream

isLocalDualVideoStreamPublished

publishLocalAudioStream

isLocalAudioStreamPublished

publishLocalDualAudioStream

isLocalDualAudioStreamPublished

setDefaultSubscribeAllRemoteAudioStreams

setDefaultSubscribeAllRemoteVideoStreams

setRemoteVideoStreamType

setRemoteDefaultVideoStreamType

subscribeAllRemoteAudioStreams

subscribeAllRemoteDualAudioStreams

subscribeAllRemoteVideoStreams

subscribeRemoteAudioStream

subscribeRemoteAudioStreamByTrack

subscribeRemoteVideoStream

subscribeRemoteMediaStream

subscribeRemoteDestChannelStream

setAudioProfile

SetAudioCapability

startAudioCapture

stopAudioCapture

startAudioPlayer

stopAudioPlayer

muteLocalMic

setRecordingVolume

setPlayOutVolume

setDefaultAudioRouteToSpeakerphone

enableSpeakerphone

isSpeakerOn

setRemoteAudioVolume

muteRemoteAudioPlaying

muteAllRemoteAudioPlaying

enableAudioVolumeIndication

enableEarBack

setEarBackVolume