This state table turns background music on or off, as requested by the on_or_off parameter, to simulate music on hold. The encapsulation of this function keeps the IBMTromboneCall state table much simpler.
This state table has to communicate with the juke_box custom server to provide this function. Any problems encountered with this communication return a non-zero status (with an exit edge of 1).
The most likely area that might need customizing is the fading in or out of the music (see the ControlMusic statements in the source code). As a default, this state table fades the music in over a period of 1 second and out over a period of 0.1 second.
A value of 0 means turn music off; a value of 1 means turn music on; any other value generates a return status of 252.
Name of the music file to play to simulate music on hold.
The returned status that indicates if music on hold was provided.
If the value is zero, the “music on hold” operation was successful (and the State table exits with edge 0).
If the value is non-zero, the music on hold operation failed for some reason (and the state table exits with edge 1). The possible status codes are given in Table 1 under the definition of the IBMTromboneCall state table (see status return values greater than 251).