ufancrecapi
v1.0.3
Published
unify telephone announcement recorder API
Downloads
1
Readme
Enums
Enumeration: RecorderState
电话录音机状态定义
Table of contents
Enumeration Members
Enumeration Members
None
• None = 0
未启用录音电话
Playing
• Playing = 4
正在回放录音
Preparing
• Preparing = 1
呼叫准备录音电话机
Ready
• Ready = 2
录音电话就绪
Recording
• Recording = 3
正在录音
ufancrecapi
Table of contents
Enumerations
Type Aliases
Functions
- recorderPlaybackStart
- recorderPlaybackStop
- recorderSave
- recorderStart
- recorderStatePoll
- recorderStop
- setServerURL
Type Aliases
ResultOfRecorderPoll
Ƭ ResultOfRecorderPoll: Object
轮询录音机状态结果
Type declaration
| Name | Type | Description |
| :------ | :------ | :------ |
| fileReady
| boolean
| 录音文件是否生成 |
| state
| RecorderState
| 录音机状态 |
Functions
recorderPlaybackStart
▸ recorderPlaybackStart(telNumber
): Promise
<ResultOfRecorderPoll
>
开始录音回放
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| telNumber
| string
| 录音电话号码 |
Returns
Promise
<ResultOfRecorderPoll
>
recorderPlaybackStop
▸ recorderPlaybackStop(telNumber
): Promise
<ResultOfRecorderPoll
>
停止录音回放
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| telNumber
| string
| 录音电话号码 |
Returns
Promise
<ResultOfRecorderPoll
>
recorderSave
▸ recorderSave(telNumber
, filePath
): Promise
<void
>
保存录音文件,并关闭录音机
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| telNumber
| string
| 录音电话号码 |
| filePath
| string
| 录音文件路径 |
Returns
Promise
<void
>
recorderStart
▸ recorderStart(telNumber
): Promise
<ResultOfRecorderPoll
>
启动录音
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| telNumber
| string
| 录音电话号码 |
Returns
Promise
<ResultOfRecorderPoll
>
recorderStatePoll
▸ recorderStatePoll(telNumber
): Promise
<ResultOfRecorderPoll
>
轮询录音机状态
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| telNumber
| string
| 录音电话号码 |
Returns
Promise
<ResultOfRecorderPoll
>
录音机状态(ResultOfRecorderPoll)
recorderStop
▸ recorderStop(telNumber
): Promise
<ResultOfRecorderPoll
>
停止录音
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| telNumber
| string
| 录音电话号码 |
Returns
Promise
<ResultOfRecorderPoll
>
setServerURL
▸ setServerURL(url
): void
设置后端服务器URL
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| url
| string
| 服务器URL: 默认为http://localhost:3006 |
Returns
void