TCCC Agent API
List of all members
tccc::ITCCCWorkstation Class Referenceabstract

Public Member Functions

登录相关接口函数
virtual void login (const TCCCLoginParams &loginParam, ITXValueCallback< TCCCLoginInfo > *callback)=0
 
virtual void logout (ITXCallback *callback)=0
 
呼叫相关接口函数
virtual void call (const TCCCStartCallParams &param, ITXCallback *startCallback)=0
 
virtual void terminate ()=0
 
virtual void answer (ITXCallback *answerCallback)=0
 
virtual void sendDTMF (const char digit, ITXCallback *callback)=0
 
音频相关接口函数
virtual void mute ()=0
 
virtual void unmute ()=0
 
virtual void enableAudioVolumeEvaluation (uint32_t interval, bool enable_vad)=0
 
virtual void startPlayMusic (const char *path, int loopCount)=0
 
virtual void stopPlayMusic ()=0
 
设备管理相关接口
virtual ITCCCDeviceManagergetDeviceManager ()=0
 
调试相关接口
virtual const char * getSDKVersion ()=0
 
virtual void callExperimentalAPI (const char *commandType, const char *jsonStr)=0
 
virtual void setLogLevel (TCCCLogLevel level)=0
 
virtual void setConsoleEnabled (bool enabled)=0
 
virtual void setLogDirectory (const char *logPath)=0
 
virtual void resetSip (bool isNeedCallReLogin)=0
 
virtual void checkLogin (ITXCallback *callback)=0
 
virtual void genTestTokenByUser (const char *secretId, const char *secretKey, const char *userId, uint32_t sdkAppId, ITXCallback *callback)=0
 

创建实例和事件回调

static tccc::ITCCCWorkstationgetShareInstance ()
 
static void destroyShareInstance ()
 
virtual void addCallback (ITCCCCallback *callback)=0
 
virtual void removeCallback (ITCCCCallback *callback)=0
 

Member Function Documentation

◆ addCallback()

virtual void tccc::ITCCCWorkstation::addCallback ( ITCCCCallback callback)
pure virtual

1.3 设置 TCCC 事件回调

您可以通过 ITCCCCallback 获得来自 SDK 的各类事件通知(比如:错误码,警告码,音视频状态参数等)。

Parameters
callback回调

◆ answer()

virtual void tccc::ITCCCWorkstation::answer ( ITXCallback answerCallback)
pure virtual

3.3 接听

Parameters
answerCallback接听成功与否回调

◆ call()

virtual void tccc::ITCCCWorkstation::call ( const TCCCStartCallParams param,
ITXCallback startCallback 
)
pure virtual

3.1 发起呼出

Parameters
param呼出参数
startCallback呼出回调,仅仅表示发起呼叫是否成功。当onNewSession回调了表示新会话, 对端接听用onAccepted,对端挂断用onEnded

◆ callExperimentalAPI()

virtual void tccc::ITCCCWorkstation::callExperimentalAPI ( const char *  commandType,
const char *  jsonStr 
)
pure virtual

12.2 调用实验性接口

Parameters
commandType类型
jsonStr参数

◆ destroyShareInstance()

static void tccc::ITCCCWorkstation::destroyShareInstance ( )
static

1.2 销毁 TCCCWorkstation 实例(单例模式)

◆ enableAudioVolumeEvaluation()

virtual void tccc::ITCCCWorkstation::enableAudioVolumeEvaluation ( uint32_t  interval,
bool  enable_vad 
)
pure virtual

4.7 启用音量大小提示。

开启此功能后,SDK 会在 ITCCCCallback 中的 onVoiceVolume 回调中反馈远端音频的音量大小。

Note
如需打开此功能,请在 接听或者发起呼叫 之前调用才可以生效。
Parameters
interval设置 onVoiceVolume 回调的触发间隔,单位为ms,最小间隔为100ms,如果小于等于 0
enable_vadtrue:打开本地人声检测 ;false:关闭本地人声检测。默认是FALSE 则会关闭回调,建议设置为300ms;

◆ getDeviceManager()

virtual ITCCCDeviceManager * tccc::ITCCCWorkstation::getDeviceManager ( )
pure virtual

10.1 获取设备管理类(ITCCCDeviceManager)

◆ getSDKVersion()

virtual const char * tccc::ITCCCWorkstation::getSDKVersion ( )
pure virtual

12.1 获取 SDK 版本信息

◆ getShareInstance()

static tccc::ITCCCWorkstation * tccc::ITCCCWorkstation::getShareInstance ( )
static

1.1 创建 TCCCWorkstation 实例(单例模式)

Parameters
context仅适用于 Android 平台,SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Androud System API。 如果传入的 context 参数为空,SDK 内部会自动获取当前进程的 ApplicationContext。
Note
  1. 如果您使用 delete ITCCCWorkstation* 会导致编译错误,请使用 destroyTCCCShareInstance 释放对象指针。
  2. 在 Windows、Mac 和 iOS 平台上,请调用 getTCCCShareInstance() 接口。
  3. 在 Android 平台上,请调用 getTCCCShareInstance(void *context) 接口。

◆ login()

virtual void tccc::ITCCCWorkstation::login ( const TCCCLoginParams loginParam,
ITXValueCallback< TCCCLoginInfo > *  callback 
)
pure virtual

2.1 登录 TCCC 呼叫中心

Parameters
loginParam登录参数
callback登录成功与否回调

◆ logout()

virtual void tccc::ITCCCWorkstation::logout ( ITXCallback callback)
pure virtual

2.2 退出 TCCC 呼叫中心

Parameters
callback退出成功与否回调

◆ mute()

virtual void tccc::ITCCCWorkstation::mute ( )
pure virtual

4.1 静音

◆ removeCallback()

virtual void tccc::ITCCCWorkstation::removeCallback ( ITCCCCallback callback)
pure virtual

1.4 移除 TCCC 事件回调

Parameters
callback回调

◆ sendDTMF()

virtual void tccc::ITCCCWorkstation::sendDTMF ( const char  digit,
ITXCallback callback 
)
pure virtual

3.8 发送 DTMF(双音多频信号)

Parameters
digitsDTMF参数是一个字符串,可以包含字符 0-9、*、#。
callback发送 DTMF成功与否回调,调用一次就会播放一次按键声音
Note
该方法仅仅在通话建立后才生效

◆ setConsoleEnabled()

virtual void tccc::ITCCCWorkstation::setConsoleEnabled ( bool  enabled)
pure virtual

12.4 启用/禁用控制台日志打印

Parameters
enabled指定是否启用,默认:禁止状态

◆ setLogDirectory()

virtual void tccc::ITCCCWorkstation::setLogDirectory ( const char *  logPath)
pure virtual

12.5 设置日志文件夹,登录前调用才有效

Parameters
logPath日志文件夹路径

◆ setLogLevel()

virtual void tccc::ITCCCWorkstation::setLogLevel ( TCCCLogLevel  level)
pure virtual

12.3 设置 Log 输出级别,该方法必须在login前调用才生效

Parameters
level参见 TCCCLogLevel,默认值:TCCCLogLevelInfo

◆ startPlayMusic()

virtual void tccc::ITCCCWorkstation::startPlayMusic ( const char *  path,
int  loopCount 
)
pure virtual

4.8 开始播放音乐

Parameters
path音乐路径。
loopCount音乐循环播放的次数。取值范围为0 - 任意正整数,默认值:1。1 表示播放音乐一次,以此类推。0表示无限循环,手动停止

◆ stopPlayMusic()

virtual void tccc::ITCCCWorkstation::stopPlayMusic ( )
pure virtual

4.9 停止播放音乐

◆ terminate()

virtual void tccc::ITCCCWorkstation::terminate ( )
pure virtual

3.2 结束会话

◆ unmute()

virtual void tccc::ITCCCWorkstation::unmute ( )
pure virtual

4.2 取消静音


The documentation for this class was generated from the following file: