Help Center
soundplayer

Soundplayer

  • Basic

    • No subcategories available.

Navigation

Definition: The file name of the audio used for navigation.

Note: The file must be in WAV format and the file suffix does not need to be added.

naviAheadTime

What it means: The duration of audio before navigating

Explanation:

navigationLoop

What it means: Whether the audio loop plays while navigating.

Explanation:

Astern

What it means: The file name of the audio in reverse.

Explanation:

turnleft

The file name of the audio when turning left.

Explanation:

turn right

Meaning: The file name of the audio when turning right.

Explanation:

block

The name of the file that is causing the audio to be blocked.

Explanation:

lowBattery

Definition: the name of the audio when the battery is low.

Note: The priority is the highest.

Error

Please provide the name of the audio file when reporting the error.

Explanation:

useErrorCode

Decide whether to play incorrect audio based on the error code.

Note: If an error is reported with an error code for the audio file, play the changed audio. Otherwise, play the default audio error.

Collision

The name of the audio file at the time of the collision.

Explanation:

openSound()

What it means: Should music be played or not?

Explanation:

Audio Instruction

During normal operation, the AGV controls audio playback based on the sound mechanism configuration in the model file or the parameters passed into the task.

Model file soundplayer configuration

The soundplayer model file controls the AGV to play the appropriate audio in different states.

The corresponding states are: starting task execution, reversing, encountering obstacles, rotating in place, low battery, blocked, control error

  • navigation: Indicates the audio file to be played during the task. Only the file name without the suffix needs to be written.
  • navigationAheadTime: Indicates how long before the task execution the audio starts playing.
  • navigationLoop: Indicates whether to loop the audio during the task.
  • astern: Indicates the audio played when moving backwards.
  • "turnleft": Indicates the audio message played when turning left in place.
  • turnright: Indicates the audio message played when turning right in place.
  • block: Indicates the audio played when blocking.
  • lowBattery: Indicates the audio played when the battery is low.
  • error: Indicates the audio played when an error is reported.
  • collision: Indicates the audio played when the collision bar is triggered.
  • openSound: Controls whether to play audio.
  • useErrorCode: Indicates whether to report the audio that corresponds to the error code.

Configuration of Audio in Task Instructions

  • audio_name: indicates whether to play audio after the AGV arrives
  • audio_loop: indicates whether to loop the audio after the point is reached
{
    "id": "LM1",
    "audio_name": "reached",
    "audio_loop": true
}

1
2
3
4
5
6
json

According to Instruction 3051, once the AGV navigation reaches LM1, the audio file "reaches.wav" will be played in a loop.

Please note that if a new command is issued immediately, the navigation or start audio will interrupt this audio. To ensure that the audio plays after the point of arrival, add a waiting or blocking time at the end of the task.

Audio Configuration in the Advanced Area

In the advanced zone properties, the "openSound" option is used to enable or disable audio in the zone.

"openSound" takes precedence over "openSound" in the model file in the advanced area.

By using the "openSound" feature in the advanced settings, we can enable or disable audio in specific areas.

Audio Priority

OpenSound > OpenSound in model file > Blocking during navigation > Low battery > Error > Navigation > Script audio

RoboShop user controls the audio

  • When the battery is low, it takes priority over user audio playback.
  • During navigation, user audio will not be played. User audio will only be played when there are no tasks or when a task is suspended.
  • If the region or global audio is disabled, users will not be able to play audio.
Last updated 2023/05/04
Article content

Soundplayer

Audio Instruction

Model file soundplayer configuration

Configuration of Audio in Task Instructions

Audio Configuration in the Advanced Area

Audio Priority

RoboShop user controls the audio