rfc2897.txt

来自「RFC 的详细文档！」· 文本 代码 · 共 1,740 行 · 第 1/5 页

   new signal will be discarded. Because of this behavior the Advanced
   Audio Package may not interoperate well with some other packages such
   as the Line and Trunk packages.

5.  Parameters

   The PlayAnnouncement, PlayRecord, and PlayCollect events may each be
   qualified by a string of parameters, most of which are optional.
   Where appropriate,  parameters default to reasonable values.  The
   only event with a required parameter is PlayAnnouncement.  If a
   Play-Announcement event is not provided with a parameter specifying
   some form of playable audio an error is returned to the application.

































Cromwell                     Informational                      [Page 7]

RFC 2897              MGCP Advanced Audio Package            August 2000


   These parameters are shown in the following table:

_______________________________________________________________________
| Parameters                                                           |
|______________________________________________________________________|
| Symbol    |  Definition                     |   pl   |  pc    |  pr  |
|___________|_________________________________|________|________|______|
| an        |  announcement                   |   x    |        |      |
| ip        |  initial prompt                 |        |  x     |  x   |
| rp        |  reprompt                       |        |  x     |  x   |
| nd        |  no digits reprompt             |        |  x     |      |
| ns        |  no speech reprompt             |        |        |  x   |
| fa        |  failure announcement           |        |  x     |  x   |
| sa        |  success announcement           |        |  x     |  x   |
| ni        |  non-interruptible play         |        |  x     |  x   |
| it        |  iterations                     |   x    |        |      |
| iv        |  interval                       |   x    |        |      |
| du        |  duration                       |   x    |        |      |
| sp        |  speed                          |   x    |  x     |  x   |
| vl        |  volume                         |   x    |  x     |  x   |
| cb        |  clear digit buffer             |        |  x     |  x   |
| mx        |  maximum # of digits            |        |  x     |      |
| mn        |  minimum # of digits            |        |  x     |      |
| dp        |  digit pattern                  |        |  x     |      |
| fdt       |  first digit timer              |        |  x     |      |
| idt       |  inter digit timer              |        |  x     |      |
| edt       |  extra digit timer              |        |  x     |      |
| prt       |  pre-speech timer               |        |        |  x   |
| pst       |  post-speech timer              |        |        |  x   |
| rlt       |  total recording length timer   |        |        |  x   |
| rsk       |  restart key                    |        |  x     |  x   |
| rik       |  reinput key                    |        |  x     |  x   |
| rtk       |  return key                     |        |  x     |  x   |
| psk       |  position key                   |        |  x     |  x   |
| stk       |  stop key                       |        |  x     |  x   |
| sik       |  start input key                |        |  x     |      |
| eik       |  end input key                  |        |  x     |  x   |
| iek       |  include end input key          |        |  x     |      |
| na        |  number of attempts             |        |  x     |  x   |
|___________|_________________________________|________|________|______|

   Parameters to the Advanced Audio Package events are defined as
   follows:

   Announcement:

      An announcement to be played.  Consists of one or more audio
      segments.



Cromwell                     Informational                      [Page 8]

RFC 2897              MGCP Advanced Audio Package            August 2000


   Initial Prompt:

      The initial announcement prompting the user to either enter DTMF
      digits or to speak.  Consists of one or more audio segments.  If
      not specified (the default), the event immediately begins digit
      collection or recording.

   Reprompt:

      Played after the user has made an error such as entering an
      invalid digit pattern or not speaking.  Consists of one or more
      audio segments.  Defaults to the Initial Prompt.

   No Digits Reprompt:

      Played after the user has failed to enter a valid digit pattern
      during a PlayCollect event.  Consists of one or more audio
      segments.  Defaults to the Reprompt.

   No Speech Reprompt:

      Played after the user has failed to speak during a PlayRecord
      event.  Consists of one or more audio segments.  Defaults to the
      Reprompt.

   Failure Announcement:

      Played when all data entry attempts have failed.  Consists of one
      or more audio segments.  No default.

   Success Announcement:

      Played when data collection has succeeded.  Consists of one or
      more audio segments.  No default.

   Non-Interruptible Play:

      If set to true, initial prompt is not interruptible by either
      voice or digits.  Defaults to false.  Valid values are the text
      strings "true" and "false".

   Iterations:

      The maximum number of times an announcement is to be played.  A
      value of minus one (-1) indicates the announcement is to be
      repeated forever. Defaults to one (1).





Cromwell                     Informational                      [Page 9]

RFC 2897              MGCP Advanced Audio Package            August 2000


   Interval:

      The interval of silence to be inserted between iterative plays.
      Specified in units of 100 milliseconds.  Defaults to 10 (1
      second).

   Duration:

      The maximum amount of time to play and possibly replay an
      announcement. Takes precedence over iteration and interval.
      Specified in units of 100 milliseconds.  No default.

   Speed:

      The relative playback speed of announcement specifiable as a
      positive or negative percentage of the original playback speed.

   Volume:

      The relative playback volume of announcement specifiable as a
      positive or negative decibel variation from the original play-back
      volume.

   Clear Digit Buffer:

      If set to true, clears the digit buffer before playing the initial
      prompt.  Defaults to false.  Valid values are the text strings
      "true" and "false".

   Maximum # Of Digits:

      The maximum number of digits to collect.  Defaults to one.  This
      parameter should not be specified if the Digit Pattern parameter
      is present.

   Minimum # Of Digits:

      The minimum number of digits to collect.  Defaults to one.  This
      parameter should not be specified if the Digit Pattern parameter
      is present.

   Digit Pattern:

      A legal digit map as described in section 7.1.14 of the Megaco
      protocol [6] using the DTMF mappings associated with the Megaco
      DTMF Detection Package described in the Megaco protocol document





Cromwell                     Informational                     [Page 10]

RFC 2897              MGCP Advanced Audio Package            August 2000


      [6].  This parameter should not be specified if one or both of the
      Minimum # Of Digits parameter and the Maximum Number Of Digits
      parameter is present.

   First Digit Timer:

      The amount of time allowed for the user to enter the first digit.
      Specified in units of 100 milliseconds.  50 (5 seconds).

   Inter Digit Timer:

      The amount of time allowed for the user to enter each subsequent
      digit. Specified units of 100 milliseconds seconds.  Defaults to
      30 (3 seconds).

   Extra Digit Timer:

      The amount of time to wait for a user to enter a final digit once
      the maximum expected amount of digits have been entered.
      Typically this timer is used to wait for a terminating key in
      applications where a specific key has been defined to terminate
      input.  Specified in units of 100 milliseconds. If not specified,
      this timer is not activated.

   Pre-speech Timer:

      The amount of time to wait for the user to initially speak.
      Specified in units of 100 milliseconds.  Defaults to 30 (3
      seconds).

   Post-speech Timer:

      The amount of silence necessary after the end of the last speech
      segment for the recording to be considered complete.  Specified in
      units of 100 milliseconds.  Defaults to 20 (2 seconds).

   Recording Length Timer:

      The maximum allowable length of the recording, not including pre
      or post speech silence.  Specified in units of 100 milliseconds.
      This parameter is mandatory.

   Restart Key:

      Defines a key sequence consisting of a command key optionally
      followed by zero or more keys.  This key sequence has the
      following action:  discard any digits collected or recording in
      progress, replay the prompt, and resume digit collection or



Cromwell                     Informational                     [Page 11]

RFC 2897              MGCP Advanced Audio Package            August 2000


      recording.  No default.  An application that defines more than one
      command key sequence, will typically use the same command key for
      all command key sequences.  If more than one command key sequence
      is defined, then all key sequences must consist of a command key
      plus at least one other key.

   Reinput Key:

      Defines a key sequence consisting of a command key optionally
      followed by zero or more keys.  This key sequence has the
      following action: discard any digits collected or recordings in
      progress and resume digit collection or recording. No default.  An
      application that defines more than one command key sequence, will
      typically use the same command key for all command key sequences.
      If more than one command key sequence is defined, then all key
      sequences must consist of a command key plus at least one other
      key.

   Return Key:

      Defines a key sequence consisting of a command key optionally
      followed by zero or more keys.  This key sequence has the
      following action:  terminate the current event and any queued
      event and return the terminating key sequence to the call
      processing agent.  No default.   An application that defines more
      than one command key sequence, will typically use the same command
      key for all command key sequences.  If more than one command key
      sequence is defined, then all key sequences must consist of a
      command key plus at least one other key.

   Position Key:

      Defines a key with the following action.  Stop playing the current
      announcement and resume playing at the beginning of the first,
      last, previous, next, or the current segment of the announcement.
      No default.  The actions for the position key are fst, lst, prv,
      nxt, and cur.

   Stop Key:

      Defines a key with the following action.  Terminate playback of
      the announcement.  No default.

   Start Input Keys:

      Defines a set of keys that are acceptable as the first digit
      collected. This set of keys can be specified to interrupt a
      playing announcement or to not interrupt a playing announcement.



Cromwell                     Informational                     [Page 12]

RFC 2897              MGCP Advanced Audio Package            August 2000


      The default key set is 0-9. The default behavior is to interrupt a
      playing announcement when a Start Input Key is pressed.  This
      behavior can be overidden for the initial prompt only by using the
      ni (Non-Interruptible Play) parameter.  Specification is a list of
      keys with no separators, e.g.  123456789#.

   End Input Key:

      Specifies a key that signals the end of digit collection or voice
      recording. The default end input key is the # key. To specify that
      no End Input Key be used the parameter is set to the string
      "null".  The default behavior not to return the End Input Key in
      the digits returned to the call agent.  This behavior can be
      overidden by the Include End Input Key (eik) parameter.

   Include End Input Key:

      By default the End Input Key is not included in the collected