Versions Compared

Old Version 10

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: PUT /rest/voicecodecprofile/{identifier}

Creates a Voice Codec Profile given a specific Table ID.

Note
titleNote

The Voice Codec Profile identifier can only be within the range 1-9999 (inclusive)

URL:

https://192.168.0.111/rest/voicecodecprofile/{identifier}

HTTP Method

PUT

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[voicecodecprofile - REST API Methods|Resource - voicecodecprofile]

Page Tree
root@parent

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionNoNostringnone64 - Max LengthIdentifies this profile so it can be easily recognized when selecting a codec.
MediaTypeYesYesEnum3Possible values:
  • 0 - mcNone
  • 1 - mcUnknown
  • 2 - mcG711A
  • 3 - mcG711u
  • 4 - mcG723
  • 5 - mcG726
  • 6 - mcG729A
  • 7 - mcT38Fax
  • 8 - mcCN
  • 9 - mcEventSignal
  • 10 - mcRTPRedundancy
  • 11 - mcTransparent
  • 12 - mcFaxRelay
  • 13 - mcFaxRelayAlaw
  • 14 - mcFaxRelayUlaw
  • 15 - mcModemRelay
  • 16 - mcModemRelayAlaw
  • 17 - mcModemRelayUlaw
  • 18 - mcG722
  • 19 - mcG722_2
  • 20 - mcOPUS
  • 21 - mcSILK
 Specifies the voice coding and encoding scheme used towards the IP side of a VoIP call. The chosen codec affects the audio quality and bandwidth consumption of VoIP calls to which you apply this Voice Codec Profile (in the Media List Profile).
Info

Only the following codecs are currently supported:

  • mcG711A - 2
    - G.711 A-Law
  • mcG711u - 3
    - G.711 Mu-Law
  • mcG723 - 4
    - G.723.1
  • mcG726 - 5
    - G.726
  • mcG729A - 6
    - G.729
  • mcG722 - 18
    - G.722
  • mcG722_2 - 19
    - G.722.2
  • mcOPUS - 20
    - Opus (Supported only on SWe Edge)
  • mcSILK - 21
    - Opus

VoiceRateInBitsPerSecondNoNoint0Possible values:
  • 0 - Minimum
  • 64000510000 - Maximum
 Voice sampling rate in bits/sec to be used by the codec. This setting applies to G.723.1 and G.726 codecs only. For all other codecs, the voice sampling rate is fixed and defined in the appropriate specification for that codec.
Info

This option is available when Codec is set to G.723.1, G.726, G.722, or G.722.2.

  • For G.723.1 - acceptable values are 5300 and 6300.
  • For G.726 - acceptable value is 32000
  • For G.722 - acceptable value is 64000
  • For G.722.2 - acceptable values are 6600, 8850, 12650, 14250, 15850, 18250, 19850, 23050, and 23850
  • For Opus - acceptable values are bwtween 6000 to 510000
  • For SIlk - acceptable values are bwtween 6000 to 510000

PayloadTypeNoNoint0Possible values:
  • 0 - Minimum
  • 127 - Maximum
 Specifies the payload type for this profile. Acceptable values for different codecs are as follows:
  • G.711 Mu-law: 0
  • G.711 A-law: 8
  • G.723.1: 4
  • G.729: 18
  • G.722: 9
  • For G.726 : 2 and any number between 96-127. 2 is the payload at 32Kbps.
  • For G.722.2 : any number between 96-127.
  • For OPUS : any number between 96-127.
  • For SILK : any number between 96-127.
Info

This option is available when Codec is G.726 or G.722.2.

Note

The Payload Type selected for G.726 or G.722.2 must not conflict with that selected for Digit Relay (in Media List Profile).

PTimeInMilliSecondsNoNoint0Possible values:
  • 0 - Minimum
  • 90 - Maximum
Real-Time Transport Protocol (RTP) packet payload size in milliseconds. Smaller payload sizes decrease audio transport latency at the expense of higher bandwidth consumption.
Info

Valid values for the different media types applicable for the SBC 1000/2000 platforms are:

  • G.711 A-law: 10, 20, 30, 40, 50, 60 ms
  • G.711 Mu-law: 10, 20, 30, 40, 50, 60 ms
  • G.723.1: 30, 60, 90 ms
  • G.729: 10, 20, 30, 40, 50, 60, 70, 80 ms
  • G.726: 10, 20, 30, 40, 50, 60 ms
  • G.722: 20 ms
  • G.722.2: 20, 40, 60, 80 ms
  • SILK: 20, 40, 60 ,100 ms
Valid values for the different media types applicable for the SWe Edge platform are:
  • G.711 A-law: 10, 20, 30, 40 ms
  • G.711 Mu-law: 10, 20, 30, 40 ms
  • G.723.1: 30, 60, 90 ms
  • G.729: 10, 20, 30, 40 ms
  • G.726: 10, 20, 30, 40 ms
  • G.722: 20 ms
  • G.722.2: 20, 40, 60, 80 ms
  • Opus: 3, 5, 10, 20, 40, 60 ms

PayloadFormatYesYesEnum0Possible values:
  • 0 - AMR_WB_BWE
  • 1 - AMR_WB_OTA
Payload format for packetization of AMR and AMR-WB encoded speech signals into the Real-time Transport Protocol.
Info

Following payload formats are supported:

  • Bandwidth Efficient Mode
  • Octet Aligned Mode

OpusBandwidthSampleRateNoNoEnum4Possible values:
  • 0 - NB
  • 1 - MB
  • 2 - WB
  • 3 - SWB
  • 4 - FB
VoiceModeBiteRateYesNoEnum1Possible values:
  • 0 - CBR
  • 1 - VBR
 Voice Mode Bitrate Specifies if the decoder prefers the use of a constant bitrate versus a variable bitrate. When cbr is set, the maximum average bitrate can still change, e.g., to adapt to changing network conditions. This is applicable for Opus.
Info

Valid values for the different Voice Mode Bite Rate:

  • CBR: Contstant Bitrate
  • VBR: Variable Bitrate

UseFECYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Forward Error Correction. This FEC scheme adds redundant information about the previous packet (n-1) to the current output packet n. For each frame, the encoder decides whether to use FEC based on (1) an externally-provided estimate of the channel's packet loss rate; (2) an externally-provided estimate of the channel's capacity; (3) the sensitivity of the audio or speech signal to packet loss; (4) whether the receiving decoder has indicated it can take advantage of "in-band" FEC information. The decision to send "in-band" FEC information is entirely controlled by the encoder and therefore no special precautions for the payload or storage format have to be taken. This is applicable for Opus/Silk.
UseDTXYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Discontinuous Transmission. The Opus/Silk codec may operated with an adaptive bit rate. In that case, the bit rate will automatically be reduced for certain input signals like periods of silence. During continuous transmission the bit rate will be reduced, when the input signal allows to do so, but the transmission to the receiver itself will never be interrupted. Therefore, the received signal will maintain the same high level of quality over the full duration of a transmission while minimizing the average bit rate over time. In cases where the bit rate of Opus/Silk needs to be reduced even further or in cases where only constant bit rate is available, the Opus/Silk encoder may be set to use discontinuous transmission (DTX), where parts of the encoded signal that correspond to periods of silence in the input speech or audio signal are not transmitted to the receiver. On the receiving side, the non-transmitted parts will be handled by a frame loss concealment unit in the Opus/Silk decoder which generates a comfort noise signal to replace the non transmitted parts of the speech or audio signal. The DTX mode of Opus/Silk will have a slightly lower speech or audio quality than the continuous mode. Therefore, it is RECOMMENDED to use Opus/Silk
ComplexityNoNoint0Possible values:
  • 0 - Minimum
  • 2 - Maximum
 SILK offers 3 scalable complexity level for the encoder: 0 low, 1 medium, 2 high. Complexity can be scaled to optimize for CPU resources in real-time, mostly in trade-off to network bit rate. This is applicable for Silk.