This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
To Top
To Bottom
PerformAudioPassThru
- Type
- Function
- Sender
- SDL
- Purpose
- Start audio capturing and sending PCM data to SDL
Request
Must
Send BC.OnResetTimeout notification to SDL to reset the timeout in case HMI needs more time to process the request.
Parameters
| Name | Type | Mandatory | Additional |
|---|---|---|---|
| appID | Integer | true | |
| audioPassThruDisplayTexts | Common.TextFieldStruct | true | array: true minsize: 0 maxsize: 2 |
| maxDuration | Integer | true | minvalue: 1 maxvalue: 1000000 |
| muteAudio | Boolean | true |
Response
Parameters
This RPC has no additional parameter requirements
Sequence Diagrams
JSON Message Examples
Example Request
{ "id" : 79, "jsonrpc" : "2.0", "method" : "UI.PerformAudioPassThru", "params" : { "audioPassThruDisplayTexts" : [ { "fieldName" : "audioPassThruDisplayText1", "fieldText" : "The audio capturing is in progress" } ], "maxDuration" : 10000, "muteAudio" : false, "appID": 65368 } }
Example Response
{ "id" : 79, "jsonrpc" : "2.0", "result" : { "code" : 0, "method" : "UI.PerformAudioPassThru" } }
Example Error
{ "id" : 79, "jsonrpc" : "2.0", "error" : { "code" : 7, "message" : "The user interrupted the RPC and indicated to start over", "data" : { "method" : "UI.PerformAudioPassThru" } } }