ChannelEngine 编辑文档

类
public enum AudioQuality
public enum AudioMode
public enum ChannelRole
public interface DataObserver
Public成员函数
int setAudioConfig(AudioQuality quaity, AudioMode mode)
int setRecordDataObserver(DataObserver observer, int samplerate, int channels, int bufSize)
int setPlaybackDataObserver(DataObserver observer, int samplerate, int channels, int bufSize)
int setExternalRecorder(boolean enable, int samplerate, int channels)
int pushExternalRecordFrame(byte[] buffer, int offset, int len)
int pushExternalRecordFrame(ByteBuffer byteBuffer, int len)
int setExternalPlayer(boolean enable, DataObserver observer, int samplerate, int channels, int bufSize)
int join(String token, String roomName,long uid, String name)
int changeRole(ChannelRole role)
int setSpeakerOn(boolean isSpeaker)
boolean isSpeakerOn()
int muteLocalAudio( boolean mute)
int muteRemoteAudio(long uid, boolean mute)
int muteAllRemoteAudio(boolean mute)
int setDefaultMuteAllRemoteAudio(boolean mute)
int enableVideo()
int disableVideo()
int setVideoEncoderConfiguration(VideoEncoderConfiguration config)
int setupLocalVideo(View view, int renderMode, int mirrorMode)
int setupRemoteVideo(View view, long uid, int renderMode, int mirrorMode)
int setLocalRenderMode(int renderMode, int mirrorMode)
int setRemoteRenderMode(long uid,int renderMode, int mirrorMode)
int startPreview()
int stopPreview()
int enableLocalVideo(boolean mute)
int muteLocalVideoStream(boolean mute)
int muteRemoteVideoStream(long uid,boolean mute)
int muteAllRemoteVideoStreams(boolean mute)
int registerVideoFrameObserver(IVideoFrameObserver observer)
int setExternalVideoSource(boolean enable, boolean useTexture)
int pushExternalVideoFrame(ExternalVideoFrame frame)
int setBeautyEffectOptions(boolean enabled,BeautyOptions options)
int adjustUserPlaybackVolume(long uid, int vol)
int adjustRecordingVolume(int vol)
int adjustPlaybackVolume(int vol)
int setVolumeDetection(int inervalMs)
int enableInEarMonitoring(int inervalMs)
int setInEarMonitoringVolume(int inervalMs)
int startRecord(String wavFile)
int stopRecord()
int startSoundMixing(String filePath, int cycle, boolean publish)
int stopSoundMixing()
int pauseSoundMixing()
int resumeSoundMixing()
int setSoundMixingPosition()
int getSoundMixingCurrentPosition()
int getSoundMixingDuration()
int setSoundMixingPitch(int pitch)
int adjustSoundMixingVolume(int vol)
int adjustSoundMixingPlayoutVolume(int vol)
int adjustSoundMixingPublishVolume(int vol)
int getSoundMixingPlayoutVolume()
int getSoundMixingPublishVolume()
int switchCamera()
boolean isCameraZoomSupported()
boolean isCameraTorchSupported()
boolean isCameraFocusSupported()
boolean isCameraExposurePositionSupported()
boolean isCameraAutoFocusFaceModeSupported()
int setCameraZoomFactor(float factor)
float getCameraMaxZoomFactor()
int setCameraFocusPositionInPreview(float positionX, float positionY)
int setCameraExposurePosition(float positionX, float positionY)
int setCameraTorchOn(boolean isOn)
int setCameraAutoFocusFaceModeEnabled(boolean enabled)
int playEffect(int effectId, String filePath, int cycle, boolean publish)
int stopEffect(int effectId)
int stopAllEffects()
int pauseEffect(int effectId)
int pauseAllEffects()
int resumeEffect(int effectId)
int resumeAllEffects()
int getEffectsVolume()
int setEffectsVolume(int volume)
int setVolumeOfEffect(int effectId, int vol)
int leave()
静态 Public 成员函数
static void GetChannelInstance(Context context, String appKey, ChannelObserver observer)
static void SetLogFile(String logFile)
static void SetLogFile(String logFile,int maxSize)
static void SetLogLevel(LogLevel level)
static String GetQttVersion()
static String GetError()
static void Destroy()
static SurfaceView CreateRendererView(Context context)

详细描述

QTT SDK将通话抽象为进入频道，同一个频道内的用户可互相语聊，频道引擎（ChannelEngine）就是所有频道控制功能的集合。

方法

GetChannelInstance

定义
public static ChannelEngine GetChannelInstance(Context context, String appKey, ChannelObserver observer)
说明

创建 ChannelEngine 实例,单例

参数
参数名 说明
context 安卓活动 (Android Activity) 的上下文
appKey appKey字符串
observer 房间事件观察者，详见ChannelObserver
返回值

ChannelEngine：ChannelEngine: 调用成功； null: 调用失败

SetLogFile

定义
public static void SetLogFile(String logFile)
说明

设置日志文件。文件大小默认512字节

参数
参数名 说明
logFile log文件绝对路径，必须保证log文件所在目录存在且可写
返回值

无

SetLogFile

定义
public static void SetLogFile(String logFile,int maxSize)
说明

设置日志文件。文件大小默认512字节

参数
参数名 说明
logFile log文件绝对路径，必须保证log文件所在目录存在且可写
maxSize -1为不限制大小, 单位为KB, 默认为512KB
返回值

无

SetLogLevel

定义
public static void SetLogLevel(LogLevel level)
说明

设置日志输出等级
日志级别顺序依次为 OFF、FATAL、ERROR、WARNING、MESSAGE 和 DEBUG。可以看到设置的级别之前所有级别的日志信息

参数
参数名 说明
LogLevel 日志输出等级。详见LogLevel
返回值

无

GetQttVersion

定义
public static String GetQttVersion()
说明

获取SDK版本号

返回值

SDK版本号


GetError

定义
public static String GetError()
说明

如果GetEngineInstance返回nil，调用该接口获取出错信息

返回值

出错信息


定义
public static void Destroy()
说明

销毁 ChannelEngine 实例，释放QttAudio所有资源

参数

无

返回值

无

setAudioConfig

定义
public int setAudioConfig(AudioQuality quality, AudioMode mode)
说明

根据用户对音质、声道、场景等的不同需求，预制了不同模式，用户可以选择不同的音频属性，获得最佳实时互动效果。

注： 设置音频属性需要在加入频道进行通话之前设置。

参数
参数名 说明
quality 音频质量
mode 音频模式
返回值

int：0: 调用成功； < 0: 调用失败

setRecordDataObserver

定义
public int setRecordDataObserver(DataObserver observer, int samplerate, int channels, int bufSize)
说明

设置原始音频采集数据监听器，可修改数据，但不能改变数据大小。

参数
参数名 说明
observer 数据监听器
samplerate 采样率
channels 声道数，可以为1或者2
bufSize 数据回调大小，小于等于0为默认值
返回值

int：0: 调用成功； < 0: 调用失败

setPlaybackDataObserver

定义
public int setPlaybackDataObserver(DataObserver observer, int samplerate, int channels, int bufSize)
说明

设置原始音频播放数据监听器，可修改数据，但不能改变数据大小

参数
参数名 说明
observer 数据监听器
samplerate 采样率
channels 声道数，可以为1或者2
bufSize 数据回调大小，小于等于0为默认值
返回值

int：0: 调用成功； < 0: 调用失败

setExternalRecorder

定义
public int setExternalRecorder(boolean enable, int samplerate, int channels)
说明

设置自定义音频采集

参数
参数名 说明
enable 数据监听器
samplerate 采样率，8000,16000,32000,44100,48000
channels 声道数，1或者2
返回值

int：0: 调用成功； < 0: 调用失败

pushExternalRecordFrame

定义
public int pushExternalRecordFrame(byte[] buffer, int offset, int len)
说明

写入外部音频采集数据

参数
参数名 说明
buffer 数据内容
offset 偏移量
len 数据长度
返回值

int：0: 调用成功； < 0: 调用失败

pushExternalRecordFrame

定义
public int pushExternalRecordFrame(ByteBuffer byteBuffer, int len)
说明

写入外部音频采集数据

参数
参数名 说明
buffer 数据内容
len 数据长度
返回值

int：0: 调用成功； < 0: 调用失败

setExternalPlayer

定义
public int setExternalPlayer(boolean enable, DataObserver observer, int samplerate, int channels, int bufSize)
说明

设置外部音频播放

参数
参数名 说明
buffer true，启用自定义音频播放；false，不启用自定义音频播放
observer 数据监听器
samplerate 播放采样率，8000,16000,32000,44100,48000
channels 播放声道数，1或者2
bufSize 数据回调大小，影响observer回调长度，如设置小于等于0为默认值(10ms的数据长度)
返回值

int：0: 调用成功； < 0: 调用失败

join

定义
public int join(String token, String roomName,long uid,String name)
说明

进入频道，进入成功还是失败的结果在回调通知

参数
参数名 说明
token 验证token
roomName 频道名称
uid 用户id
name 字符串用户id
返回值

int：0: 调用成功； < 0: 调用失败

changeRole

定义
public int changeRole(ChannelRole role)
说明

改变角色，改变的结果在回调通知

参数
参数名 说明
role TALKER:主播，可说可听; AUDIENCE:听众，只能听不能说
返回值

int：0: 调用成功； < 0: 调用失败

setSpeakerOn

定义
public int setSpeakerOn(boolean isSpeaker)
说明

开启(关闭)扬声器输出

参数
参数名 说明
isSpeaker true为扬声器输出；false为听筒输出
返回值

int：0: 调用成功； < 0: 调用失败

isSpeakerOn

定义
public boolean isSpeakerOn()
说明

获取扬声器输出状态

参数

无

返回值

boolean：true: 扬声器输出； false: 听筒输出

muteLocalAudio

定义
public int muteLocalAudio( boolean mute)
说明

取消或恢复发布本地音频流

参数
参数名 说明
mute true为静音；false为不静音
返回值

int：0: 调用成功； < 0: 调用失败

muteRemoteAudio

定义
public int muteRemoteAudio(long uid, boolean mute)
说明

取消或恢复订阅指定远端用户的音频流

参数
参数名 说明
uid 用户id
mute true为静音；false为不静音
返回值

int：0: 调用成功； < 0: 调用失败

muteAllRemoteAudio

定义
public int muteAllRemoteAudio(boolean mute)
说明

mute频道内所有成员

参数
参数名 说明
mute true为静音；false为不静音
返回值

int：0: 调用成功； < 0: 调用失败

setDefaultMuteAllRemoteAudio

定义
public int setDefaultMuteAllRemoteAudio(boolean mute)
说明

设置是否默认接收远端用户音频流

参数
参数名 说明
mute true：默认不接收所有远端音频流 false：默认接收所有远端音频流（默认）
返回值

int：0: 调用成功； < 0: 调用失败

enableVideo

定义
public int enableVideo()
说明

启用视频模块。

可以在加入频道前或者通话中调用，在加入频道前调用，则自动开启视频模式，在通话中调用则由音频模式切换为视频模式。

成功调用该方法后，远端会触发 onUserEnableVideo(true) 回调。

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

disableVideo

定义
public int disableVideo()
说明

关闭视频模块

成功调用该方法后，远端会触发 onUserEnableVideo(false) 回调。

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

setVideoEncoderConfiguration

定义
public int setVideoEncoderConfiguration(VideoEncoderConfiguration config)
说明

设置视频编码属性。
每个属性对应一套视频参数，如分辨率、帧率、码率、视频方向等。
所有设置的参数均为理想情况下的最大值。当视频引擎因网络环境等原因无法达到设置的分辨率、帧率或码率的最大值时，会取最接近最大值的那个值。

参数
参数名 说明
config 视频编码属性，详见 VideoEncoderConfiguration
返回值

int：0: 调用成功； < 0: 调用失败

CreateRendererView

定义
public static SurfaceView  CreateRendererView(Context context)
说明

创建 RendererView。请在主线程调用该方法

参数
参数名 说明
context 安卓活动 (Android Activity) 的上下文
返回值

SurfaceView：视图预览SurfaceView

setupLocalVideo

定义
public int setupLocalVideo(View view, int renderMode, int mirrorMode)
说明

初始化本地视图。

该方法初始化本地视图并设置本地用户视频显示信息，只影响本地用户看到的视频画面，不影响本地发布视频。
调用该方法绑定本地视频流的显示视窗（View），并设置本地用户视图的渲染模式和镜像模式。
如果在通话中更新本地用户视图的渲染或镜像模式，请使用 setLocalRenderMode 方法。
必须在主线程调用该方法。

参数
参数名 说明
view 通过CreateRendererView创建的SurfaceView
renderMode 视频渲染模式，详见 MirrorMode
mirrorMode 视频镜像模式，详见 RenderMode
返回值

int：0: 调用成功； < 0: 调用失败

setupRemoteVideo

定义
public int setupRemoteVideo(View view,long uid,int renderMode, int mirrorMode)
说明

初始化远端用户视图。

该方法绑定远端用户和显示视图，并设置远端用户视图在本地显示时的渲染模式和镜像模式，只影响本地用户看到的视频画面。
如果 App 不能事先知道对方的用户 ID，可以在 APP 收到 onOtherJoin 事件时设置。
如果在通话中更新远端用户的渲染或镜像模式，请使用 setRemoteRenderMode 方法。
必须在主线程调用该方法。

参数
参数名 说明
view 通过CreateRendererView创建的SurfaceView
uid 远端用户ID
renderMode 视频渲染模式，详见 MirrorMode
mirrorMode 视频镜像模式，详见 RenderMode
返回值

int：0: 调用成功； < 0: 调用失败

setLocalRenderMode

定义
public int setLocalRenderMode(int renderMode, int mirrorMode)
说明

设置本地视频显示模式。

初始化本地用户视图后，可以调用该方法更新本地用户视图的渲染和镜像模式。
该方法只影响本地用户看到的视频画面，不影响本地发布视频。
必须在调用 setupLocalVideo 方法初始化本地视图后，才能调用该方法。
可以在通话中多次调用该方法，多次更新本地用户视图的显示模式。

参数
参数名 说明
renderMode 视频渲染模式，详见 MirrorMode
mirrorMode 视频镜像模式，详见 RenderMode
返回值

int：0: 调用成功； < 0: 调用失败

setRemoteRenderMode

定义
public int setRemoteRenderMode(long uid,int renderMode, int mirrorMode)
说明

设置远端视频显示模式。

初始化远端用户视图后，可以调用该方法更新远端用户在本地显示时的渲染和镜像模式。该方法只影响本地用户看到的视频画面。
必须在调用 setupRemoteVideo 方法初始化远端视图后，才能调用该方法。
可以在通话中多次调用该方法，多次更新远端用户视图的显示模式。

参数
参数名 说明
uid 远端用户ID
renderMode 视频渲染模式，详见 MirrorMode
mirrorMode 视频镜像模式，详见 RenderMode
返回值

int：0: 调用成功； < 0: 调用失败

startPreview

定义
public int startPreview()
说明

开启视频预览。

该方法用于在进入频道前启动本地视频预览。调用该 API 前，必须：

- 调用 enableVideo 开启视频功能
- 调用 setupLocalVideo 设置预览窗口及属性

本地预览默认开启镜像功能。

使用该方法启用了本地视频预览后，如果直接调用 leaveChannel 退出频道，并不会关闭预览。如需关闭预览，请调用 stopPreview。

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

stopPreview

定义
public int stopPreview()
说明

停止本地视频预览。

在加入频道前或离开频道后调用该方法。

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

enableLocalVideo

定义
public int enableLocalVideo(boolean mute)
说明

开启/关闭本地视频采集。

该方法禁用或重新启用本地视频采集,不影响接收远端视频。

调用 enableVideo 后，本地视频即默认开启。

可以调用 enableLocalVideo(false) 关闭本地视频采集。关闭后如果想重新开启，则可调用 enableLocalVideo(true)。

成功禁用或启用本地视频采集后，远端会触发 onUserEnableLocalVideo 回调。

该方法设置的是内部引擎为启用或禁用状态，在 leaveChannel 后仍然有效。

可以在通话中多次调用该方法，多次更新远端用户视图的显示模式。

参数
参数名 说明
mute true:开启本地采集和渲染(默认)；false:关闭本地采集和渲染，但不影响接收远端视频
返回值

int：0: 调用成功； < 0: 调用失败

muteLocalVideoStream

定义
public int muteLocalVideoStream(boolean mute)
说明

取消或恢复发布本地视频流。

成功调用该方法后，远端会触发 onUserMuteVideo 回调。

该方法不会改变视频采集设备的使用状态。

参数
参数名 说明
mute 是否取消发布本地视频流。 true:取消发布；false:发布(默认)
返回值

int：0: 调用成功； < 0: 调用失败

muteRemoteVideoStream

定义
public int muteRemoteVideoStream(long uid,boolean mute)
说明

取消或恢复订阅指定远端用户的视频流。

该方法需要在加入频道后调用。

参数
参数名 说明
uid 指定用户的用户 ID
mute 是否取消订阅指定远端用户的视频流。true:取消订阅；false:订阅(默认)
返回值

int：0: 调用成功； < 0: 调用失败

muteAllRemoteVideoStreams

定义
public int muteAllRemoteVideoStreams(boolean mute)
说明

取消或恢复订阅所有远端用户的视频流。

成功调用该方法后，本地用户会取消或恢复订阅所有远端用户的视频流，包括在调用该方法后加入频道的用户的视频流。

该方法需要在加入频道后调用。

参数
参数名 说明
mute 是否取消订阅所有远端用户的视频流。true:取消订阅；false:订阅(默认)
返回值

int：0: 调用成功； < 0: 调用失败

registerVideoFrameObserver

定义
public int registerVideoFrameObserver(IVideoFrameObserver observer)
说明

注册原始视频数据监听器。
成功注册原始视频数据观测器后，SDK 会在捕捉到每个视频帧时，触发在 VideoFrameObserver接口中实现的回调。

该方法须要在加入频道前调用。

通过观测器获取的视频宽高可能会因网络情况变差和用户自行调整分辨率而变化。

参数
参数名 说明
observer 数据监听器，详见IVideoFrameObserver。传空表示取消注册原始视频数据观测器。
返回值

int：0: 调用成功； < 0: 调用失败

setExternalVideoSource

定义
public int setExternalVideoSource(boolean enable, boolean useTexture)
说明

配置外部视频源。该方法需要在加入频道前调用。

参数
参数名 说明
enable 是否使用外部视频源：true: 使用外部视频源；false: （默认）不使用外部视频源。
useTexture 是否使用 Texture 作为输入：true: 使用 texture 作为输入；false: （默认）不使用 texture 作为输入
返回值

int：0: 调用成功； < 0: 调用失败

pushExternalVideoFrame

定义
public int pushExternalVideoFrame(ExternalVideoFrame frame)
说明

使用 ExternalVideoFrame 将视频帧数据传递给 Qtt SDK。

请确保在你调用本方法前已调用 setExternalVideoSource，并将参数 pushMode 设为 true，不然调用本方法后会一直报错。 该方法需要在加入频道后调用。

参数
参数名 说明
frame 视频帧的数据信息, 详见ExternalVideoFrame。传空表示取消注册原始视频数据观测器。
返回值

int：0: 调用成功； < 0: 调用失败

setBeautyEffectOptions

定义
public int setBeautyEffectOptions(boolean enabled,BeautyOptions options)
说明

开启本地美颜功能，并设置美颜效果选项

参数
参数名 说明
observer 是否开启美颜功能。true：开启；false：（默认）关闭
options 美颜选项，详见BeautyOptions
返回值

int：0: 调用成功； < 0: 调用失败

adjustUserPlaybackVolume

定义
public int adjustUserPlaybackVolume(long uid, int vol)
说明

调节频道内uid用户说话的音量

参数
参数名 说明
uid 用户id
vol [0-400],默认为100，0为无声
返回值

int：0: 调用成功； < 0: 调用失败

adjustRecordingVolume

定义
public int adjustRecordingVolume(int vol)
说明

调节mic采集音量

参数
参数名 说明
vol [0-400],默认为100，0为无声
返回值

int：0: 调用成功； < 0: 调用失败

adjustPlaybackVolume

定义
public int adjustPlaybackVolume(int vol)
说明

调节总的播放音量

参数
参数名 说明
vol [0-400],默认为100，0为无声
返回值

int：0: 调用成功； < 0: 调用失败

setVolumeDetection

定义
public int setVolumeDetection(int inervalMs)
说明

开启（关闭）音量检测

参数
参数名 说明
inervalMs 检测间隔，毫秒；如果小于等于0，表示关闭音量检测
返回值

int：0: 调用成功； < 0: 调用失败

enableInEarMonitoring

定义
public int enableInEarMonitoring(boolean enable)
说明

开启（关闭）耳返，默认关闭

参数
参数名 说明
enable true：开启耳返，false：关闭耳返
返回值

int：0: 调用成功； < 0: 调用失败

setInEarMonitoringVolume

定义
public int setInEarMonitoringVolume(int volume)
说明

设置耳返声音

参数
参数名 说明
volume 设置耳返音量，取值范围在 [0,100]。默认值为 100
返回值

int：0: 调用成功； < 0: 调用失败

startRecord

定义
public int startRecord(String wavFile)
说明

录制声音

参数
参数名 说明
wavFile 录音文件在本地保存的绝对路径，需精确到文件名及格式
返回值

int：0: 调用成功； < 0: 调用失败

stopRecord

定义
public int startRecord()
说明

停止录制

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

startSoundMixing

定义
public int startSoundMixing(String filePath, int cycle, boolean publish)
说明

开始播放音乐文件

成功调用该方法后，后续的播放状态变化通过onSoundStateChanged回调获取

参数
参数名 说明
filePath 指定需要播放的音乐文件的绝对路径
cycle 循环播放次数。正整数表示具体的循环播放的次数，-1表示无限循环播放
publish true: 本地用户和远端用户都能听到播放的声音
false: 只有本地用户可以听到播放的声音
返回值

int：0: 调用成功； < 0: 调用失败

stopSoundMixing

定义
public int stopSoundMixing()
说明

停止播放音乐文件

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

pauseSoundMixing

定义
public int pauseSoundMixing()
说明

暂停播放音乐文件

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

resumeSoundMixing

定义
public int resumeSoundMixing()
说明

恢复播放音乐文件

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

setSoundMixingPosition

定义
public int setSoundMixingPosition(int pos)
说明

设置音乐文件的播放位置

参数
参数名 说明
pos 音乐文件的播放位置，单位为毫秒
返回值

int：0: 调用成功； < 0: 调用失败

getSoundMixingCurrentPosition

定义
public int getSoundMixingCurrentPosition()
说明

获取音乐文件的播放进度，单位为毫秒

参数

无

返回值

int：>= 0: 音乐文件当前播放进度； < 0: 调用失败

getSoundMixingDuration

定义
public int getSoundMixingDuration()
说明

获取音乐文件总时长，单位为毫秒

参数

无

返回值

int：
>= 0: 音乐文件时长。
< 0: 失败.

setSoundMixingPitch

定义
public int setSoundMixingPitch(int pitch)
说明

调整播放的音乐文件的音调

参数
参数名 说明
pitch 按半音音阶调整本地播放的音乐文件的音调，默认值为0，即不调整音调，取值范围为 [-12,12]
返回值

int：0: 调用成功； < 0: 调用失败

adjustSoundMixingVolume

定义
public int adjustSoundMixingVolume(int vol)
说明

调节音乐文件播放音量

参数
参数名 说明
vol 音乐文件音量范围为 0~100。100（默认值）为原始文件音量
返回值

int：0: 调用成功； < 0: 调用失败

adjustSoundMixingPlayoutVolume

定义
public int adjustSoundMixingPlayoutVolume(int vol)
说明

调节音乐文件本地播放音量

参数
参数名 说明
vol 音乐文件音量范围为 0~100。100（默认值）为原始文件音量
返回值

int：0: 调用成功； < 0: 调用失败

adjustSoundMixingPublishVolume

定义
public int adjustSoundMixingPublishVolume(int vol)
说明

调节音乐文件远端播放音量

参数
参数名 说明
vol 音乐文件音量范围为 0~100。100（默认值）为原始文件音量
返回值

int：0: 调用成功； < 0: 调用失败

getSoundMixingPlayoutVolume

定义
public int getSoundMixingPlayoutVolume()
说明

获取音乐文件的本地播放音量

参数

参数名 | 说明
无

返回值

int：
>= 0: 音乐文件的远端播放音量，范围为 [0, 100]。

​ < 0: 失败.

getSoundMixingPublishVolume

定义
public int getSoundMixingPublishVolume()
说明

获取音乐文件的远端播放音量

参数

无

返回值

int：
>= 0: 音乐文件的远端播放音量，范围为 [0, 100]。

​ < 0: 失败.

switchCamera

定义
public int switchCamera()
说明

切换前置/后置摄像头。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

isCameraZoomSupported

定义
public boolean isCameraZoomSupported()
说明

检测设备是否支持摄像头缩放功能。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数

无

返回值

boolean：true: 支持相机缩放功能； false: 不支持相机缩放功能

isCameraTorchSupported

定义
public boolean isCameraTorchSupported()
说明

检查设备是否支持打开闪光灯。

SDK 默认使用前置摄像头，因此如果直接调用 isCameraTorchSupported，可以从返回值中了解使用前置摄像头时是否支持打开闪光灯。
如果想检查使用后置摄像头时设备是否支持打开闪光灯，请先调用 switchCamera 切换 SDK 使用的摄像头为后置摄像头，再调用 isCameraTorchSupported。
该方法需在摄像头启动后调用。

参数

无

返回值

boolean：true: 支持打开闪光灯； false: 不支持打开闪光灯

isCameraFocusSupported

定义
public boolean isCameraFocusSupported()
说明

检测设备是否支持手动对焦功能。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数

无

返回值

boolean：true: 支持手动对焦功能； false: 不支持手动对焦功能

isCameraExposurePositionSupported

定义
public boolean isCameraExposurePositionSupported()
说明

检测设备是否支持手动曝光功能。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数

无

返回值

boolean：true: 支持手动曝光功能； false: 不支持手动曝光功能

isCameraAutoFocusFaceModeSupported

定义
public boolean isCameraAutoFocusFaceModeSupported()
说明

检测设备是否支持人脸对焦功能。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数

无

返回值

boolean：true: 支持支持人脸对焦功能； false: 不支持支持人脸对焦功能

setCameraZoomFactor

定义
public int setCameraZoomFactor(float factor)
说明

设置摄像头缩放比例。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数
参数名 说明
factor 相机缩放比例，有效范围从 1.0 到最大缩放
返回值

int：>0: 返回缩放的值； <0: 调用失败

getCameraMaxZoomFactor

定义
public float getCameraMaxZoomFactor()
说明

获取摄像头支持最大缩放比例。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数

无

返回值

int：>0: 返回相机支持的最大缩放比例； <0: 调用失败

setCameraFocusPositionInPreview

定义
public int setCameraFocusPositionInPreview(float positionX, float positionY)
说明

设置手动对焦位置，并触发对焦。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数
参数名 说明
positionX 触摸点相对于视图的横坐标
positionY 触摸点相对于视图的纵坐标
返回值

int：>0: 调用成功； <0: 调用失败

setCameraExposurePosition

定义
public int setCameraExposurePosition(float positionX, float positionY)
说明

设置手动曝光位置。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数
参数名 说明
positionX 触摸点相对于视图的横坐标
positionY 触摸点相对于视图的纵坐标
返回值

int：>0: 调用成功； <0: 调用失败

setCameraTorchOn

定义
public int setCameraTorchOn(boolean isOn)
说明

设置是否打开闪光灯。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数
参数名 说明
isOn true: 打开闪光灯；false: 关闭闪光灯
返回值

int：>0: 调用成功； <0: 调用失败

setCameraAutoFocusFaceModeEnabled

定义
public int setCameraAutoFocusFaceModeEnabled(boolean enabled)
说明

设置是否开启人脸对焦功能。

该方法需要在相机启动（如通过调用 startPreview 或 joinChannel 实现）后调用。

参数
参数名 说明
enabled 是否开启人脸自动对焦。true: 开启人脸自动对焦；false: 关闭人脸自动对焦
返回值

int：>0: 调用成功； <0: 调用失败

playEffect

定义
public int playEffect(int effectId, String filePath, int cycle, boolean publish)
说明

开始播放音效文件
可以多次调用该方法，同时播放多个音效文件，实现音效叠加
播放音效结束后，会触发onEffectFinished回调

参数
参数名 说明
effectId 音效文件ID
filePath 指定需要播放的音效文件的绝对路径
cycle 循环播放次数。正整数表示具体的循环播放的次数，-1表示无限循环播放
publish true: 本地用户和远端用户都能听到播放的声音
false: 只有本地用户可以听到播放的声音
返回值

int：0: 调用成功； < 0: 调用失败

stopEffect

定义
public int stopEffect(int effectId)
说明

停止播放音效文件

参数
参数名 说明
effectId 音效文件ID
返回值

int：0: 调用成功； < 0: 调用失败

stopAllEffects

定义
public int stopAllEffects()
说明

停止播放所有音效文件

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

pauseEffect

定义
public int pauseEffect(int effectId)
说明

暂停播放音效文件

参数
参数名 说明
effectId 音效文件ID
返回值

int：0: 调用成功； < 0: 调用失败

pauseAllEffects

定义
public int pauseAllEffects()
说明

暂停播放所有音效文件

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

resumeEffect

定义
public int resumeEffect(int effectId)
说明

恢复播放音效文件

参数
参数名 说明
effectId 音效文件ID
返回值

int：0: 调用成功； < 0: 调用失败

resumeAllEffects

定义
public int resumeAllEffects()
说明

恢复播放所有音效文件

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

getEffectsVolume

定义
public int getEffectsVolume()
说明

获取播放音效文件音量

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

setEffectsVolume

定义
public int setEffectsVolume(int volume)
说明

设置音效文件的播放音量

参数
参数名 说明
vol 音效文件音量范围为 0~100。100（默认值）为原始文件音量
返回值

int：0: 调用成功； < 0: 调用失败

setVolumeOfEffect

定义
public int setVolumeOfEffect(int effectId, int vol)
说明

设置指定音效文件的音量

参数
参数名 说明
effectId 音效文件ID
vol 音效文件音量范围为 0~100。100（默认值）为原始文件音量
返回值

int：0: 调用成功； < 0: 调用失败

leave

定义
public int leave()
说明

离开频道

参数

无

返回值

int：0: 调用成功； < 0: 调用失败

野狗新手？
立即注册，为你提供安全可靠的实时通信云服务。
免费注册
没找到需要的文档？
你可以提交工单反馈 或 阅读常见问题
客服工单常见问题