首页 > 其他分享 >FreeSWITCH学习笔记:Lua脚本

FreeSWITCH学习笔记:Lua脚本

时间:2022-12-22 20:33:42浏览次数:34  
标签:DBH APP 笔记 Lua SESSION freeswitch 事件 FreeSWITCH EVENT

本文更新于2022-06-03,使用FreeSWITCH 1.10.7。

目录

argv

命令行参数。argv[0]为脚本文件名。

freeswitch.API

API = freeswitch.API()

API:execute

执行API。

REPLY = API:execute(APINAME [, ARG [, ...]])

freeswitch.bridge

会阻塞。

freeswitch.consoleLog

输出日志。

freeswitch.consoleLog(LEVEL, MSG)

freeswitch.Dbh

创建数据库句柄。可连接SQLite或任何支持ODBC的数据库。

DBH = freeswitch.Dbh(SQLITEFILEPATH|"odbc://DSN USERNAME PASSWORD")

DBH:affected_rows

返回上一个DBH:query影响的行数。

N = DBH:affected_rows()

DBH:connected

测试数据库是否连接成功。

OK = DBH:connected()

DBH:test_reactive

确认数据库表存在。如果SELECTSQL执行不行功,则先试图运行DROPSQL删除数据库表,再运行CREATESQL重新创建数据库表。

DBH:test_reactive(SELECTSQL, DROPSQL, CREATESQL)

DBH:query

执行查询语句。

DBH:query(SQL, [function (row) end])

回调函数中可以row.COLUMN的形式,用数据库表的列名来引用值。

DBH:release

释放数据库句柄。

DBH:release()

freeswitch.email

freeswitch.Event

初始化一个事件。

EVENT = freeswitch.Event(EVENTTYPE [, SUBCLASS])

事件类型TYPE需要在switch_event_types_t枚举类型中有定义,它是在switch_types.h中定义的。如果使用未定义的类型,则统一为"MESSAGE"。

当TYPE为"CUSTOM"时,SUBCLASS可为任意字符串,它将作为事件中的Event-Subclass。

EVENT:addBody

给事件添加正文。

EVENT:addBody(BODY)

EVENT:addHeader

给事件增加一个事件头。

EVENT:addHeader(HEADER, VALUE)

HEADER为"Content-Type"用于表示正文的类型。

EVENT:delHeadder

从事件中删除一个事件头。

EVENT:delHeader(HEADER)

EVENT:fire

产生事件。

EVENT:fire()

EVENT:getBody

从事件中获取正文。

BODY = EVENT:getBody()

EVENT:getHeader

从事件中获取事件头的值。

VALUE = EVENT:getHeader(HEADER)

EVENT:getType

获取事件的类型(名字),即freeswitch.Event的TYPE参数的值。等价于EVENT:getHeader("Event-Name")

EVENTTYPE = EVENT:getType()

EVENT:serialize

将事件序列化成字符串。

STR = EVENT:serialize([FORMAT])

FORMAT省略时为简单文本格式,"json"为JSON格式,"xml"为XML格式。

freeswitch.EventConsumer

创建事件消费者。

EVENTCONSUMER = freeswitch.EventConsumer(EVENTTYPE)

EVENTCONSUMER.pop

取出事件。

EVENTCONSUMER.pop(N)

N为0是非阻塞的,为1是阻塞的。

freeswitch.msleep

freeswitch.msleep(MS)

freeswitch.Session

发起一个呼叫,并一直等待对方应答。

SESSION = freeswitch.Session(CALLURL)

SESSION:answer

给主叫回送应答消息(200)。相当于answer APP。

SESSION:answer()

SESSION:execute

执行APP。大部分session函数与APP是一一对应的。不会触发SESSION:setInputCallback的回调。

SESSION:execute(APPNAME [, ARG [, ...]])

SESSION:get_uuid

获取当前Session的UUID。相当于SESSION:getVariable("uuid")

UUID = SESSION:get_uuid()

SESSION:getVariable

获取通道变量的值。

VALUE = SESSION:getVariable(VAR)

SESSION:hangup

挂断通话。相当于hangup APP。默认执行完脚本后会自动挂断通话,可不显式调用。

SESSION:hangup([REASON])

SESSION:hangupCause

返回挂机原因。

REASON = SESSION:hangupCause()

SESSION:playAndGetDigits

播放声音并等待接收DTMF按键。相当于play_and_get_digits APP。

DIGITS = SESSION:playAndGetDigits(MINDIGITS, MAXDIGITS, MAXATTEMPTS, TIMEOUTMS, TERMINATORS, MUSIC, INVALIDMUSIC, REGEX [, INTERDIGITTIMEOUTMS [, "FAILEXTENSION [FAILDIALPLAN [FAILCONTEXT]]"]])

SESSION:preAnswer

SESSION:read

播放声音并等待接收DTMF按键。相当于read APP。

DIGITS = SESSION:read(MINDIGITS, MAXDIGITS, MUSIC, INTERDIGITTIMEOUTMS, TERMINATORS)

SESSION:ready

检查Session是否可正常使用,如已挂机则返回false。

OK = SESSION:ready()

在脚本中,如有循环,一定要检测SESSION.ready()是否返回true,否则Session挂机后脚本仍可能死循环运行。

SESSION:recordFile

录音。相当于record APP。

SESSION:recordFile(FILENAME [, MAXSECONDS, SILENCETHRESHOLD, SILENCESECONDS])

FILENAME为录音文件名。

MAXSECONDS为录音最长秒数。

SILENCETHRESHOLD为静音阈值,低于此值的声音认为是静音。

SILENCESECONDS为静音时长大于此秒数则停止录音。

SESSION:setAutoHangup

设置执行完脚本后是否自动挂断通话。

SESSION:setAutoHangup(BOOL)

SESSION:setInputCallback

设置收到外部输入时的回调函数。

SESSION:setInputCallback(STRFUNCTIONNAME, "")

回调函数共有4个参数:

  • s:即session。
  • type:如:dtmf,event。
  • obj:输入对象。当type为dtmf时,有两个键:digit为按键,duration为时长。
  • arg:

回调函数如返回"break"则停止当前正在执行的APP,后面没有其它脚本语句的话Lua APP就会退出;如果返回空值(如空字符串)则什么也不做。

SESSION:set_tts_params

设置TTS参数。

SESSION:set_tts_params(TTSENGINE, TTSVOICE)

SESSION:setVariable

设置通道变量的值。相当于set APP。

SESSION:setVariable(VAR, VALUE)

SESSION:sleep

暂停若干毫秒。相当于sleep APP。

SESSION:sleep(MS)

SESSION:speak

使用TTS播放声音。相当于speak APP。

SESSION:speak(TEXT)

SESSION:streamFile

播放声音。相当于playback APP。

SESSION:streamFile(MUSIC)

SESSION:unsetInputCallback

取消收到外部输入时的回调函数。

message

在Chatplan中自动获得此对象。其与freeswitch.Event创建的对象是一样的。此外还有以下函数。

message:chat_execute

执行文本消息支持的动作。

message:chat_execute(ACTION)

ACTION可为:

  • fire:产生一个MESSAGE事件。
  • info:显示信息。
  • reply:回复消息。
  • send:发送消息。
  • set:设置变量。
  • stop:停止消息路由。
  • system:调用system函数执行系统调用。

session

在Dialplan中会自动获得此对象。其与freeswitch.Session创建的对象是一样的。

XML_REQUEST

XML绑定请求中,会自动获得此对象。

XML_STRING

XML绑定请求中,脚本执行完成后,FreeSWITCH从此变量得到XML文本,进行解析以执行下一步的动作。

标签:DBH,APP,笔记,Lua,SESSION,freeswitch,事件,FreeSWITCH,EVENT
From: https://www.cnblogs.com/garvenc/p/freeswitch_learning_lua.html

相关文章

  • Node.js(笔记04) - 时钟示例 - fs 和 path 模块结合应用
    案例需求将素材目录​./files​ 中的index.html 页面,拆分成三个文件,分别是:index.cssindex.jsindex.html并且将拆分出来的3个文件,存放到​./files/clock​ 目录中;这个i......
  • Spring IOC官方文档学习笔记(三)之依赖项
    1.依赖注入(1)依赖注入(DI)的概念:某个bean的依赖项,由容器来负责注入维护,而非我们自己手动去维护,以此来达到bean之间解耦的目的,如下//情况一:不使用依赖注入publicclass......
  • leetcode笔记——单调栈
    在leetcode中,使用单调栈的题大多是寻找下一个更大的数类似,我感觉其他变形问题还是挺难搞的实际处理时候可能还是先暴力,再想着怎么通过单调栈去优化吧列一下今天遇到的三......
  • Node.js(笔记03) - path 路径模块
    path 路径模块path 模块是Node.js 官方提供的、用来处理路径的模块。它提供了一系列方法和属性,来满足用户对路径的处理需求。 官方文档:​​https://nodejs.org/dist/la......
  • (笔记)伺服电机三环(电流环、速度环、位置环)控制原理及参数调节
     运动伺服一般都是三环控制系统,从内到外依次是电流环、速度环、位置环。  一、理解三环1、电流环电流环的输入是速度环PID调节后的输出,我们称为“电流环给定”吧......
  • #yyds干货盘点# react笔记之学习之完成添加功能
    前言我是歌谣我有个兄弟巅峰的时候排名c站总榜19叫前端小歌谣曾经我花了三年的时间创作了他现在我要用五年的时间超越他今天又是接近兄弟的一天人生难免坎坷大不了从......
  • 梦断代码读书笔记01
    看到这本书的封面就给我一种气势磅礴的感觉——两打程序员,三年时间,4732个bug,只为打造超卓软件。看起来像是要搞一个多么伟大的工程一样,没看这本书之前,倒是对这本书有一些了......
  • #yyds干货盘点# react笔记之学习之完成删除功能
    前言我是歌谣我有个兄弟巅峰的时候排名c站总榜19叫前端小歌谣曾经我花了三年的时间创作了他现在我要用五年的时间超越他今天又是接近兄弟的一天人生难免坎坷大不了从......
  • 梦断代码读书笔记02
    卡普尔的团队开始问自己一个看似简单的问题:我们如何组织信息?如何对这种信息组织法建模——需要怎样的数据结构才能让计算机也能回答这个问题?软件没有磁芯。它就像洋葱般层......
  • Docker学习笔记十四:Docker安装Grafana
    介绍是一个开源的度量分析和可视化工具,可以通过将采集的数据分析、查询,然后进行可视化的展示,并能实现报警。参考官网地址:https://grafana.com/docs/grafana/latest/inst......