juke_box_stop_music command

Stops playing a tune.

Input parameters

char music_title[31];

Output parameters

long rc;

Description

The state table wants to stop a tune. SendData sends the same information to the Juke_Box custom server that it sent to start the tune playing, with juke_box_stop_music in place of the juke_box_start_music. The Juke_Box custom server stops the tune playing and releases any associated resources associated.

Use this command only after the call has been set up, and before the call terminates.

On SendData, we recommend that you use a value of 10 seconds for the Timeout parameter.

Parameters

music_title

This character string must exactly match the music title configured earlier by the juke_box_configure_music command or a music title in the configuration file.

Return codes

0

JB_NO_ERROR

Successful. The tune has stopped playing and associated resources have been released. If this tune is no longer being used by any other state table it is deleted from the list of available music. You can view the list of available music (that is, tunes that are currently playing) from the Blueworx Voice Response System Monitor.

1000

JB_ERROR_MUSIC_NOT_CONFIGURED

The music title is not known to the Juke_Box custom server.

1021

JB_ERROR_CANT_STOP_WHAT_ISNT_PLAYING

The tune is not known. Either the tune was not started using juke_box_start_music, or the music player has terminated since the request was made.