class TsTone

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-ToneSenderService
+-TsTone

This MO represents a tone as used by the Tone Sender (TS) service in the node. An instance of this MO exists for each tone type used. The MO instances are created automatically by the system when the ToneSenderService MO instance is created.

The Relative Distinguished Name (RDN) for this MO type is:
TsTone=<toneId>


This MO is created by the system.

Attributes
CarrierSuppressionMode
mandatory
segment1Carrier
Carrier suppression information.
This attribute cannot be set to CARRIER_SUPPRESSED if the attribute segment1Level4 is set to 0 and the attribute segment1SigType is set to MODULATED_TONE.
uint32
mandatory
segment1Freq1 { 1..3999 }
1st Frequency applicable to this segment.

Unit: 1 Hz (Herz)
uint32
mandatory
segment1Freq2 { 1..3999, 65535 }
2nd frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment1Freq3 { 1..3999, 65535 }
3rd frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment1Freq4 { 1..3999, 65535 }
4th frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
int32
mandatory
segment1Level1 { -40..0 }
For composite tones, level of 1st frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment1Level2 { -40..0 }
For composite tones, level of 2nd frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment1Level3 { -40..0 }
For composite tones, level of 3rd frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment1Level4 { -40..100 }
For composite tones, level of 4th frequency in this segment. (-40 .. 0).
For modulated tones, modulation depth, in % (0 .. 100).
This attribute cannot be set to 0 if the attribute segment1Carrier is set to CARRIER_SUPPRESSED and the attribute segment1SigType is set to MODULATED_TONE.


Unit: 1 dBm0 for composite tones, for modulated tones % (percent)
Dependencies: Modulated tones means that the first 1 - 3 frequencies of the segment are modulated by the 4th one with a certain modulation depth.
SegmentSignalType
mandatory
segment1SigType
Type of tone to be played in this segment.
This attribute cannot be set to MODULATED_TONE if the attribute segment1Level4 is set to 0 and the attribute segment1Carrier is set to CARRIER_SUPPRESSED.
uint32
mandatory
segment1TimeOff { 0..60000 }
Segment pause time after the played segment.

Unit: 1 ms (millisecond)

Resolution: 5
uint32
mandatory
segment1TimeOn { 0..60000 }
Segment play time.

Unit: 1 ms (millisecond)

Resolution: 5
CarrierSuppressionMode
mandatory
segment2Carrier
Carrier suppression information.
This attribute cannot be set to CARRIER_SUPPRESSED if the attribute segment2Level4 is set to 0 and the attribute segment2SigType is set to MODULATED_TONE.
uint32
mandatory
segment2Freq1 { 1..3999, 65535 }
1st Frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment2Freq2 { 1..3999, 65535 }
2nd frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment2Freq3 { 1..3999, 65535 }
3rd frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment2Freq4 { 1..3999, 65535 }
4th frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
int32
mandatory
segment2Level1 { -40..0 }
For composite tones, level of 1st frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment2Level2 { -40..0 }
For composite tones, level of 2nd frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment2Level3 { -40..0 }
For composite tones, level of 3rd frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment2Level4 { -40..100 }
For composite tones, level of 4th frequency in this segment. (-40 .. 0).
For modulated tones, modulation depth, in % (0 .. 100).
This attribute cannot be set to 0 if the attribute segment2Carrier is set to CARRIER_SUPPRESSED and the attribute segment2SigType is set to MODULATED_TONE.


Unit: 1 dBm0 for composite tones, for modulated tones % (percent)
Dependencies: Modulated tones means that the first 1 - 3 frequencies of the segment are modulated by the 4th one with a certain modulation depth.
SegmentSignalType
mandatory
segment2SigType
Type of tone to be played in this segment.
This attribute cannot be set to MODULATED_TONE if the attribute segment2Level4 is set to 0 and the attribute segment2Carrier is set to CARRIER_SUPPRESSED.
uint32
mandatory
segment2TimeOff { 0..60000 }
Segment pause time after the played segment.

Unit: 1 ms (millisecond)

Resolution: 5
uint32
mandatory
segment2TimeOn { 0..60000 }
Segment play time.

Unit: 1 ms (millisecond)

Resolution: 5
CarrierSuppressionMode
mandatory
segment3Carrier
Carrier suppression information.
This attribute cannot be set to CARRIER_SUPPRESSED if the attribute segment3Level4 is set to 0 and the attribute segment3SigType is set to MODULATED_TONE.
uint32
mandatory
segment3Freq1 { 1..3999, 65535 }
1st Frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment3Freq2 { 1..3999, 65535 }
2nd frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment3Freq3 { 1..3999, 65535 }
3rd frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment3Freq4 { 1..3999, 65535 }
4th frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
int32
mandatory
segment3Level1 { -40..0 }
For composite tones, level of 1st frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment3Level2 { -40..0 }
For composite tones, level of 2nd frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment3Level3 { -40..0 }
For composite tones, level of 3rd frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment3Level4 { -40..100 }
For composite tones, level of 4th frequency in this segment. (-40 .. 0).
For modulated tones, modulation depth, in % (0 .. 100).
This attribute cannot be set to 0 if the attribute segment3Carrier is set to CARRIER_SUPPRESSED and the attribute segment3SigType is set to MODULATED_TONE.


Unit: 1 dBm0 for composite tones, for modulated tones % (percent)
Dependencies: Modulated tones means that the first 1 - 3 frequencies of the segment are modulated by the 4th one with a certain modulation depth.
SegmentSignalType
mandatory
segment3SigType
Type of tone to be played in this segment.
This attribute cannot be set to MODULATED_TONE if the attribute segment3Level4 is set to 0 and the attribute segment3Carrier is set to CARRIER_SUPPRESSED.
uint32
mandatory
segment3TimeOff { 0..60000 }
Segment pause time after the played segment.

Unit: 1 ms (millisecond)

Resolution: 5
uint32
mandatory
segment3TimeOn { 0..60000 }
Segment play time.

Unit: 1 ms (millisecond)

Resolution: 5
CarrierSuppressionMode
mandatory
segment4Carrier
Carrier suppression information.
This attribute cannot be set to CARRIER_SUPPRESSED if the attribute segment4Level4 is set to 0 and the attribute segment4SigType is set to MODULATED_TONE.
uint32
mandatory
segment4Freq1 { 1..3999, 65535 }
1st Frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment4Freq2 { 1..3999, 65535 }
2nd frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment4Freq3 { 1..3999, 65535 }
3rd frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
uint32
mandatory
segment4Freq4 { 1..3999, 65535 }
4th frequency applicable to this segment.
The value 65535 (H'FFFF) indicates that frequency in this segment is not generated (silent).


Unit: 1 Hz (Herz)
int32
mandatory
segment4Level1 { -40..0 }
For composite tones, level of 1st frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment4Level2 { -40..0 }
For composite tones, level of 2nd frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment4Level3 { -40..0 }
For composite tones, level of 3rd frequency in this segment. (-40 .. 0).

Unit: 1 dBm0
int32
mandatory
segment4Level4 { -40..100 }
For composite tones, level of 4th frequency in this segment. (-40 .. 0).
For modulated tones, modulation depth, in % (0 .. 100).
This attribute cannot be set to 0 if the attribute segment4Carrier is set to CARRIER_SUPPRESSED and the attribute segment4SigType is set to MODULATED_TONE.


Unit: 1 dBm0 for composite tones, for modulated tones % (percent)
Dependencies: Modulated tones means that the first 1 - 3 frequencies of the segment are modulated by the 4th one with a certain modulation depth.
SegmentSignalType
mandatory
segment4SigType
Type of tone to be played in this segment.
This attribute cannot be set to MODULATED_TONE if the attribute segment4Level4 is set to 0 and the attribute segment4Carrier is set to CARRIER_SUPPRESSED.
uint32
mandatory
segment4TimeOff { 0..60000 }
Segment pause time after the played segment.

Unit: 1 ms (millisecond)

Resolution: 5
uint32
mandatory
segment4TimeOn { 0..60000 }
Segment play time.

Unit: 1 ms (millisecond)

Resolution: 5
SegmentInfo1Mode
mandatory
segmentInfo1
Indicates whether segment1 will be played or not.
SegmentInfo2Mode
mandatory
segmentInfo2
Indicates whether segment2 will be played or not.
SegmentInfo3Mode
mandatory
segmentInfo3
Indicates whether segment3 will be played or not.
SegmentInfo4Mode
mandatory
segmentInfo4
Indicates whether segment4 will be played or not.
SpeechPathMode
mandatory
speechPathInfo
Indicates whether the tone should interrupt the speech path.
uint32
mandatory
toneDuration { 0..65535 }
The total time to play the tone in milliseconds. It can be composed of several tone periods.
The value 65535 is infinite playing of the tone.


Unit: 1 ms (millisecond)

Resolution: 5
uint32
mandatory
noNotification
restricted
toneId { 48..106 }
The attribute ToneId is used to uniquely identify the tone.
string
mandatory
noNotification
restricted
toneName
The textual representation of the tone.
uint32
mandatory
tonePeriod { 0..60000 }
The total time for the tone to be played (including pauses).

Unit: 1 ms (millisecond)

Resolution: 5
Dependencies: Must be greater than or equal to the combined ON&OFF times for all defined segments.
string
key
mandatory
noNotification
restricted
tsToneId
The value component of the RDN.
string[0..1]
userLabel
Label for free use.

  class TsTone