com.agora.iotsdk20.ICallkitMgr接口 参考

呼叫系统接口。

成员函数说明

callAnswer()

int com.agora.iotsdk20.ICallkitMgr.callAnswer

(

)

接听当前来电。

返回值

错误码，详见 ErrCode。

callDial()

int com.agora.iotsdk20.ICallkitMgr.callDial	(	IotDevice	iotDevice,
		String	attachMsg
	)

呼叫设备。

参数

参数名	描述
iotDevice	要呼叫的设备，详见 IotDevice。
attachMsg	呼叫时附带的信息。

返回值

错误码，详见 ErrCode。

callHangup()

int com.agora.iotsdk20.ICallkitMgr.callHangup

(

)

挂断当前通话。

返回值

错误码，详见 ErrCode。

capturePeerVideoFrame()

Bitmap com.agora.iotsdk20.ICallkitMgr.capturePeerVideoFrame

(

)

截屏对端视频帧图像。

返回值

抓取到的视频帧图像。

getAudioEffect()

AudioEffectId com.agora.iotsdk20.ICallkitMgr.getAudioEffect

(

)

获取当前通话中设置的音效。

返回值

当前通话中设置的音效：AudioEffectId。

getNetworkStatus()

RtcNetworkStatus com.agora.iotsdk20.ICallkitMgr.getNetworkStatus

(

)

获取当前网络状态。

返回值

RTC网络状态信息，详见 RtcNetworkStatus。

getOnlineUserCount()

int com.agora.iotsdk20.ICallkitMgr.getOnlineUserCount

(

)

获取当前通话中的用户数。

返回值

当前通话中的用户数。该数值包含用户自己，但不包含设备端用户。

getStateMachine()

int com.agora.iotsdk20.ICallkitMgr.getStateMachine

(

)

获取当前设备管理状态机。

返回值

设置管理状态状态机。

isTalkingRecording()

boolean com.agora.iotsdk20.ICallkitMgr.isTalkingRecording

(

)

获取是否正在录制当前通话。

返回值

• true: 录制
• false: 未录制

muteLocalAudio()

int com.agora.iotsdk20.ICallkitMgr.muteLocalAudio

(

boolean

mute

)

停止/恢复发布本地音频流。

参数

参数名	描述
mute	是否停止发布本地音频流： true: 是 false: 否

返回值

错误码，详见 ErrCode。

muteLocalVideo()

int com.agora.iotsdk20.ICallkitMgr.muteLocalVideo

(

boolean

mute

)

停止/恢复发布本地视频流。

参数

参数名	描述
mute	是否停止发布本地视频流： true: 是 false: 否

返回值

错误码，详见 ErrCode。

mutePeerAudio()

int com.agora.iotsdk20.ICallkitMgr.mutePeerAudio

(

boolean

mute

)

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

参数

参数名	描述
mute	是否停止订阅远端音频流： true: 是 false: 否

返回值

错误码，详见 ErrCode。

mutePeerVideo()

int com.agora.iotsdk20.ICallkitMgr.mutePeerVideo

(

boolean

mute

)

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

参数

参数名	描述
mute	是否停止订阅远端视频流： true: 是 false: 否

返回值

错误码，详见 ErrCode。

registerListener()

int com.agora.iotsdk20.ICallkitMgr.registerListener

(

ICallkitMgr.ICallback

callback

)

注册回调接口。

参数

参数名	描述
callback	回调接口，详见 ICallback。

返回值

错误码，详见 ErrCode。

setAudioEffect()

int com.agora.iotsdk20.ICallkitMgr.setAudioEffect

(

AudioEffectId

effectId

)

设置音效效果（通常是变声等音效）。

参数

参数名	描述
effectId	音效类型，详见 AudioEffectId。

返回值

错误码，详见 ErrCode。

setLocalVideoView()

int com.agora.iotsdk20.ICallkitMgr.setLocalVideoView

(

SurfaceView

localView

)

设置本地视频显示控件，如果不设置则不显示本地视频。

参数

参数名	描述
localView	本地视频显示控件。

返回值

错误码，详见 ErrCode。

setPeerVideoView()

int com.agora.iotsdk20.ICallkitMgr.setPeerVideoView

(

SurfaceView

peerView

)

设置对端视频显示控件，如果不设置则不显示对端视频。

参数

参数名	描述
peerView	对端视频显示控件。

返回值

错误码，详见 ErrCode。

setRtcPrivateParam()

int com.agora.iotsdk20.ICallkitMgr.setRtcPrivateParam

(

String

privateParam

)

设置 RTC 私有参数。

参数

参数名	描述
privateParam	要设置的私参。

返回值

错误码，详见 ErrCode。

setVolume()

int com.agora.iotsdk20.ICallkitMgr.setVolume

(

int

volumeLevel

)

设置音频播放的音量。

参数

参数名	描述
volumeLevel	音量级别，取值范围为 [0,100]。

返回值

错误码，详见 ErrCode。

talkingRecordStart()

int com.agora.iotsdk20.ICallkitMgr.talkingRecordStart

(

final String

outFilePath

)

开始录制当前通话（包括音视频流），仅在通话状态下才能调用。

注解

请确保你指定的路径存在并且可写。

参数

参数名	描述
outFilePath	录制文件在本地保存的绝对路径，需精确到文件名及格式。

返回值

错误码，详见 ErrCode。

talkingRecordStop()

int com.agora.iotsdk20.ICallkitMgr.talkingRecordStop

(

)

停止录制当前通话，仅在通话状态下才能调用。

返回值

错误码，详见 ErrCode。

unregisterListener()

int com.agora.iotsdk20.ICallkitMgr.unregisterListener

(

ICallkitMgr.ICallback

callback

)

注销回调接口。

参数

参数名	描述
callback	回调接口，详见 ICallback。

返回值

错误码，详见 ErrCode。

类成员变量说明

static

CALLKIT_STATE_ANSWER_REQING

final int com.agora.iotsdk20.ICallkitMgr.CALLKIT_STATE_ANSWER_REQING = 0x0007

0x0007: 正在发送接听请求中。

static

CALLKIT_STATE_ANSWER_RSPING

final int com.agora.iotsdk20.ICallkitMgr.CALLKIT_STATE_ANSWER_RSPING = 0x0008

0x0008: 正在等待接听响应中。

static

CALLKIT_STATE_DIAL_REQING

final int com.agora.iotsdk20.ICallkitMgr.CALLKIT_STATE_DIAL_REQING = 0x0005

0x0005: 正在发送主叫请求中。

static

CALLKIT_STATE_DIAL_RSPING

final int com.agora.iotsdk20.ICallkitMgr.CALLKIT_STATE_DIAL_RSPING = 0x0006

0x0006: 正在等待主叫响应中。

static

CALLKIT_STATE_DIALING

final int com.agora.iotsdk20.ICallkitMgr.CALLKIT_STATE_DIALING = 0x0002

0x0002: 正在呼叫设备中。

static

CALLKIT_STATE_HANGUP_REQING

final int com.agora.iotsdk20.ICallkitMgr.CALLKIT_STATE_HANGUP_REQING = 0x0009

0x0009: 正在发送挂断请求中。

static

CALLKIT_STATE_IDLE

final int com.agora.iotsdk20.ICallkitMgr.CALLKIT_STATE_IDLE = 0x0001

0x0001: 呼叫系统当前为空闲状态。

static

CALLKIT_STATE_INCOMING

final int com.agora.iotsdk20.ICallkitMgr.CALLKIT_STATE_INCOMING = 0x0003

0x0003: 正在有来电中。

static

CALLKIT_STATE_TALKING

final int com.agora.iotsdk20.ICallkitMgr.CALLKIT_STATE_TALKING = 0x0004

0x0004: 正在通话中。