diff options
| author | Andrzej Zaborowski <andrew.zaborowski@intel.com> | 2010-10-06 12:35:00 +0200 |
|---|---|---|
| committer | Denis Kenzior <denkenz@gmail.com> | 2010-10-06 19:04:09 -0500 |
| commit | 8080f233f3a1b1e87867445a35c75705cb6d7a81 (patch) | |
| tree | 2e708f10c46819354f935d1e191811a4c493989d /doc/stk-api.txt | |
| parent | f1be4b2375a12645643ad40d7c172ecd9147b834 (diff) | |
| download | ofono-8080f233f3a1b1e87867445a35c75705cb6d7a81.tar.bz2 | |
doc: Play Tone command proposed d-bus API.
Diffstat (limited to 'doc/stk-api.txt')
| -rw-r--r-- | doc/stk-api.txt | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/stk-api.txt b/doc/stk-api.txt index 3b478199..f5b9ebc6 100644 --- a/doc/stk-api.txt +++ b/doc/stk-api.txt @@ -203,6 +203,46 @@ Methods byte RequestSelection(string title, byte icon_id, Possible Errors: [service].Error.SimToolkit.EndSession + void PlayTone(string tone, string text, byte icon_id) + + Tells the agent to play an audio tone once. The + method should return once the tone is finished + playing. The text parameter contains an optional + text to be displayed to the user. The following + tones are defined: + "dial-tone" + "busy" + "congestion" + "radio-path-acknowledge" + "radio-path-not-available" + "error" + "call-waiting" + "ringing-tone" + "general-beep" + "positive-acknowledgement" + "negative-acknowledgement" + "user-ringing-tone" + "user-sms-alert" + "critical" (high priority) + "vibrate" + "happy" + "sad" + "urgent-action" + "question" + "message-received" + + Possible Errors: [service].Error.SimToolkit.EndSession + + void LoopTone(string tone, string text, byte icon_id) + + Tells the agent to reproduce an audio tone in a + loop until the method call is cancelled. See + PlayTone() above for the list of possible tone names. + The text parameter contains an optional text to + be displayed to the user. + + Possible Errors: [service].Error.SimToolkit.EndSession + void Cancel() Asks the agent to cancel any ongoing operation in |