sipgate AI Flow icon

sipgate AI Flow

Control sipgate AI Flow calls with various actions

Mix Audio

AI-generated

Summary

Start a looping background audio track mixed under speech in a sipgate AI Flow call session or stop any currently playing background audio loop.

Inputs

  • Session ID (required) — The session ID from the AI Flow event to identify the call session to control.
  • Mode (required) — Choose 'Start / Replace Loop' to begin or replace the background audio loop, or 'Stop Loop' to stop any currently playing background audio loop.
  • Audio Source — Specify the source of the audio data to loop if starting a loop: either 'Base64 String' or 'Binary Data'.
  • Audio (Base64) (required) — Base64 encoded WAV audio (16kHz, mono, 16-bit PCM) provided as a string to start the loop (required when Audio Source is 'Base64 String' and Mode is 'Start / Replace Loop').
  • Binary Property (required) — Name of the binary property containing the audio file to start the loop (required when Audio Source is 'Binary Data' and Mode is 'Start / Replace Loop').
  • Volume — Volume to play the loop at, between 0.0 and 1.0 (default 0.5, applicable when starting the loop).

Output shape

a single JSON action object indicating the mix_audio action with session_id, audio data if starting, volume, or a stop flag if stopping the loop

Throws an error if required parameters are missing or invalid. No direct outputs beyond the action JSON object for the AI Flow call control.

Links

Discussion