版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

说明

本接口包含两类功能

  • 语音文件的播放和停止
  • 语音告警相关文件的生成

播报语音文件方法

...

  • pkaudio.playSound(audioFilePath, isLoop)。开始播报某个语音文件
    • audioFilePath。要播报的语音文件名称,需要是服务端文件。
      • 系统缺省有一个报警语音文件可以直接使用:/dist/sound/default_alarm.mp3
      • 可以上传文件到/page/upsnd文件夹下的文件
    • isLoop:是否循环播放。true表示循环播放该文件,false表示仅仅播放一次就停下
    • 示例:
      • pkaudio.playSound("/dist/sound/default_alarm.mp3",true)  播放缺省文件,并循环一直播放
      • pkaudio.playSound("/page/upsnd/xxxx.mp3",false) 播放上传的语音文件/page/upsnd/xxxx.mp3,仅播放一次
  • pkaudio.stopSound() 停止播放正在进行的语音文件
    • 不需要参数

生成语音告警文件方法

规则

  • 语音告警,是在发生报警时,筛选其中符合条件的部分,进行语音播报,提醒用户。
  • 一个示例:管理员,一跑道北下滑 超上限告警,请及时处理
  • 通常播放有多个部分组成,每部分是一个单独的 文件名。可组成的部分包括:
    • 播放后缀,文件位置和名称固定:/page/tts/other/suffix.wav
    • 可变的名称
      • 播放前缀,文件位置和名称固定:/page/tts/other/prefix.wav
      • 对象名称,/page/tts/objectname/{实际对象名}.wav
      • 报警类型,/page/tts/alarmtype/{实际告警类型名}.wav
      • 用户名称,/page/tts/username/{实际登录的用户名(非登录名)}.wav
      • 系统名/page/tts/sysname/{实际系统名}.wav
  • 上述几个不同的类型,可以根据配置组合,组合,规则:
    • 播放具体内容规则,配置规则在表t_alarm_voice_rule的content_body字段中,如:对象名称+报警类型
    • 播放前缀名称,在t_alarm_voice_rule的content_prefix,需要输入以上四种类型中的一个,如:用户名称
    • 播放后缀文本,在t_alarm_voice_rule的content_suffix,需要输入一个任意需要的文本,如:请快速处理
    • 以上示例组合结果就是:
      • {用户名称}+{对象名称}+{报警类型}+{播放后缀},实际播报可能是:
      • 时俊普,一跑道北下滑 超下限告警 请快速处理

方法

  • pkaudio.generateAndDownloadTts(text, sex,voiceFileName) 根据一个文本,生成一个文件名的语音
    • text,文本内容,如“一跑道北航向报警”
    • sex,女生或者男生,women/man
    • voiceFileName,生成的文件名,需要以.wav结束。如果为空,则生成tts.wav
    • 示例:
      • pktts.generateAndDownloadTts("一跑道北航向报警", "women","test.wav");
      • 将会自动打开一个下载窗口,将test.wav下载到浏览器中
  • pkalarmaudio.generateVoiceFileByText(text, sex,voiceFileName) 根据一个文本,生成一个语音文件名,并存在服务端(不下载)
    • text,文本内容,如“一跑道北航向报警”
    • sex,女生或者男生,women/man
    • voiceFileName,生成的文件名,需要以.wav结束。如果为空,则生成tts.wav
    • 生成的文件存在: /page/tts/other
    • 示例:
      • pkalarmaudio.generateVoiceFileByText("一跑道北航向报警", "women","test.wav");
      • 将会自动打开一个下载窗口,将test.wav下载到浏览器中
  • pkalarmaudio.generateVoiceFileByType:function (objectTypeNameobjectType, sex,callback)  根据对象类型名称,生成所有该对象类型对应的语音文件,并存在服务端根据对象类型名称,生成所有该对象类型对应的语音文件,并存在服务端
    • objectType,对象类型,支持如下字符串表示的类型:
      • username,所有系统配置的用户名,各自生成一个声音文件

        • 存放在目录:/page/tts/username

        • 文件名称:{用户名}.wav

        • 如:/page/tts/username/时俊普.wav

      • alarmtype,所有数据库中配置的每个报警类型,都会生成一个声音文件

        • 存放在目录:/page/tts/alarmtype

        • 文件名称:{alarmtype}.wav

        • 如:/page/tts/alarmtype/超下限预警.wav

      • objectname,为每个配置的对象,生成一个声音文件

        • 存放在目录:/page/tts/objectname

        • 文件名称:{objectname}.wav

        • 如:/page/tts/objectname/一跑道南下滑.wav,/page/tts/objectname/一类运行.wav

      • sysname,为每个配置的子系统,生成一个声音文件

        • 存放在目录:/page/tts/sysname

        • 文件名称:{sysname}.wav

        • 如:/page/tts/sysname/五跑道南下滑DME.wav

      • undefined或空字符串(生成所有以上几种类型,username、alarmtype、objectname、sysname中的一种)
    • objectTypeNameobjectTypeName可为:空对象或空字符串(生成所有,usernamealarmtypeobjectnamesysname中的一种)
      • username,存放在目录:

      • alarmtype

      • objectname

      • sysname

    • 同时生成播报前缀 和后缀声音文件
      • prefix.wav

      • suffix.wav
    • sex,女生或者男生,women/man
    • callback,生成文件结束后的回调函数
    • 特别说明:在产生某种类型声音的同时,会:生成的文件存在:
      • 根据数据库表t_alarm_voice_rule的content_prefix的内容,生成对应的语音前缀文件。如果该列内容是上述4中对象的一种,则产生固定规则文件;否则产生一个文本对应的语音文件(规则见上面),文件放在:/page/tts/other/prefix.wav
      • 根据数据库表t_alarm_voice_rule的content_suffix的内容,生成对应的语音后缀文件。后缀只能是一个文本对应的语音文件,文件放在:
      • /page/tts/other/suffix.wav
    • 示例:
      • pkalarmaudio.generateVoiceFileByType("objectname", "women");
      • pkalarmaudio.generateVoiceFileByTextgenerateVoiceFileByType("一跑道北航向报警alarmtype", "women");
      • pkalarmaudio.generateVoiceFileByType("username", "women");
      • pkalarmaudio.generateVoiceFileByType("sysname", "women"test.wav");
      • 将会自动打开一个下载窗口,将test.wav下载到浏览器中pkalarmaudio.generateVoiceFileByType("", "women");