stop_background_file

View as MarkdownOpen in Claude

Stop the currently playing background audio file.

Parameters

None.

Returns

FunctionResult — self, for chaining.

Example

1from signalwire import AgentBase
2from signalwire import FunctionResult
3
4agent = AgentBase(name="my-agent", route="/agent")
5agent.set_prompt_text("You are a helpful assistant.")
6
7@agent.tool(name="stop_hold_music", description="Stop hold music playback")
8def stop_hold_music(args, raw_data):
9 return (
10 FunctionResult("I'm back.")
11 .stop_background_file()
12 )
13
14agent.serve()