Module cc
模块功能:通话管理
Info:
- Copyright: openLuat
- Release: 2017.11.2
- License: MIT
- Author: openLuat
Functions
anyCallExist () | 是否存在通话 |
getState (num) | 查询某个号码的通话状态 |
dial (num[, delay=0]) | 呼出电话 |
hangUp (num) | 挂断通话 |
accept (num) | 接听电话 |
transVoice (data[, loop=nil][, downLinkPlay=nil]) | 通话中发送声音到对端,必须是12.2K AMR格式 |
dtmfDetect ([enable=nil][, sens=3]) | 设置dtmf检测是否使能以及灵敏度 |
sendDtmf (str[, playtime=100][, intvl=100]) | 发送dtmf到对端 |
Fields
CONNECTED | 通话中 |
HOLD | 通话保持中 |
DIALING | 正在呼出 |
INCOMING | 正在呼入 |
DISCONNECTING | 正在挂断通话 |
DISCONNECTED | 通话已挂断 |
Functions
- anyCallExist ()
-
是否存在通话
Returns:
-
bool result 存在通话返回true,否则返回false
Usage:
result = cc.anyCallExist()
-
- getState (num)
-
查询某个号码的通话状态
Parameters:
- num
string
查询号码
Returns:
-
number state 通话状态,状态值参考本模块Fields定义
Usage:
state = cc.getState('10086')
- num
string
- dial (num[, delay=0])
-
呼出电话
Parameters:
- num
string
呼出号码
- delay
number
[此参数可选,默认值为: 0]
延时delay毫秒后,才发起呼叫
Returns:
-
bool result,true表示允许发送at命令拨号并且发送at,false表示不允许at命令拨号
Usage:
cc.dial('10086')
- num
string
- hangUp (num)
-
挂断通话
Parameters:
- num
string
号码,若指定号码通话状态不对 则直接退出 不会执行挂断,若挂断时会挂断所有电话
Returns:
-
nil
Usage:
cc.hangUp('10086')
- num
string
- accept (num)
-
接听电话
Parameters:
- num
string
号码,若指定号码通话状态不对 则直接退出 不会接通
Returns:
-
nil
Usage:
cc.accept('10086')
- num
string
- transVoice (data[, loop=nil][, downLinkPlay=nil])
-
通话中发送声音到对端,必须是12.2K AMR格式
Parameters:
- data
string
12.2K AMR格式的数据
- loop
bool
[此参数可选,默认值为: nil]
是否循环发送,true为循环,其余为不循环
- downLinkPlay
bool
[此参数可选,默认值为: nil]
声音是否在本端播放,true为播放,其余为不播放
Returns:
-
bool result true为成功,false为失败
Usage:
cc.transVoice("#!AMR\010\060*********") cc.transVoice("#!AMR\010\060*********",true) cc.transVoice("#!AMR\010\060*********",true,true)
- data
string
- dtmfDetect ([enable=nil][, sens=3])
-
设置dtmf检测是否使能以及灵敏度
Parameters:
- enable
bool
[此参数可选,默认值为: nil]
true使能,false或者nil为不使能
- sens
number
[此参数可选,默认值为: 3]
灵敏度,最灵敏为1
Returns:
-
nil
Usage:
cc.dtmfDetect(true)
- enable
bool
[此参数可选,默认值为: nil]
- sendDtmf (str[, playtime=100][, intvl=100])
-
发送dtmf到对端
Parameters:
- str
string
dtmf字符串,仅支持数字、ABCD*#
- playtime
number
[此参数可选,默认值为: 100]
每个dtmf播放时间,单位毫秒
- intvl
number
[此参数可选,默认值为: 100]
两个dtmf间隔,单位毫秒
Returns:
-
nil
Usage:
cc.sendDtmf("123")
- str
string