Skip to content

Report on MOBILE_API.xml issues(inconsistent range) #257

@Yuki-Shoda-Nexty

Description

@Yuki-Shoda-Nexty

We propose correcting MOBILE_API.xml(inconsistent range)

In current MOBILE_API.xml, some of descriptions about actual operation of the Head Unit (HU) and setting values of related parameters are inconsistent.
By fixing such descriptions, we can provide more accurate RPC documents for SDL developers.
The target items are below two parameters.

  1. Modification of parameter maxDuration of PerformAudioPassThru.
    Since it takes 1-2 sec to start recording by the onboard Mic after the RPC is sent, hence it is inconsistent that the minimum value of maxDuration is 1 ms.
    It is appropriate that the minimum value of maxDuration is 2000 or 3000 ms at least.

  2. Correction of the parameter syncFileName of `PutFile
    Since the maximum length of syncFileName in the RPC SetAppIconDeleteFile is 500, hence it is inconsistent that the maximum length of syncFileName is 255.
    It is appropriate that the maximum length of syncFileName is unified into same value 500.

Modify as shown below.

  1. Modification of parameter maxDuration of PerformAudioPassThru.
-        <param name="maxDuration" type="Integer" minvalue="1" maxvalue="1000000" mandatory="true">
+        <param name="maxDuration" type="Integer" minvalue="3000" maxvalue="1000000" mandatory="true">
             <description>The maximum duration of audio recording in milliseconds. </description>
          </param>
  1. Correction of the parameter syncFileName of `PutFile
-        <param name="syncFileName" type="String" maxlength="255" mandatory="true">
+        <param name="syncFileName" type="String" maxlength="500" mandatory="true">
             <description>File reference name.</description>
          </param>

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions