Package 

Class AudioRequest

  • All Implemented Interfaces:
    android.os.Parcelable

    
    public final class AudioRequest
     implements Parcelable
                        

    if client wants audio guidance service to generate particular type audio, client should construct audio request first and call AudioGuidanceService::generateAudio by this request request contains two parts, one is request type indicate audio guidance service to find audio string and another is additional info, with which audio guidance will enrich the final string

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public final class AudioRequest.Builder

      Data model representing builder.

      Instances are typically immutable after construction. Use builders or factory methods where provided.

    • Constructor Summary

      Constructors 
      Constructor Description
      AudioRequest(Integer type, Integer distance, Integer eta, String info, Integer distance2, Integer distance3, String countryBorder, String countryCode, String currentStreetName, String nextStreetName, String nearbyStreetName, Boolean isCurrentStreetNameRouteNumber, Boolean isNextStreetNameRouteNumber, Boolean isNearbyStreetNameRouteNumber, String cityName, String stateName, String countryName, String highwayExitNumber, Integer ete, String arrivalTime, String isTimezoneChanged, String dateTime, Boolean is24h)
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final Integer getType()
      final Integer getDistance() prime distance value in meter
      final Integer getEta() value: eta time value in minute
      final String getInfo() additional info string which will be prompt in final audio
      final Integer getDistance2() secondary distance value in meter
      final Integer getDistance3() third distance value in meter
      final String getCountryBorder() any string(not "")
      final String getCountryCode() 3 characters ISO country code
      final String getCurrentStreetName() the name of street where vehicle locates currently
      final String getNextStreetName() the name of next upcoming street when driving
      final String getNearbyStreetName() nearby street name when off road
      final Boolean isCurrentStreetNameRouteNumber() "true" when type of "current_street_name" type is route number, if true, tasdk will process it into a more understandable string.
      final Boolean isNextStreetNameRouteNumber() "true" when type of "next_street_name" type is route number, if true, tasdk will process it into a more understandable string.
      final Boolean isNearbyStreetNameRouteNumber() "true" when type of "nearby_street_name" type is route number, if true, tasdk will process it into a more understandable string.
      final String getCityName() the name of the city where the vehicle is located
      final String getStateName() the name of the state where the vehicle is located
      final String getCountryName() the name of the country where the vehicle is located
      final String getHighwayExitNumber() highway exit number, tasdk will process it into a more understandable string.
      final Integer getEte() time spent from current location to next stop(waypoint or destination), unit: minute
      final String getArrivalTime() arrive next stop time value, time format should follow the tts engine's rule
      final String isTimezoneChanged() "true" when timezone of next stop is different from current one, "false" when timezone of next stop is same with current one, Default: "false", If client use other string except for "true" and "false", this value is always false.
      final String getDateTime() Estimated arrival local time for templates that use key datetime (e.g.
      final Boolean is24h() When true, native audio uses 24-hour format for arrival time (key is_24h).
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AudioRequest

        AudioRequest(Integer type, Integer distance, Integer eta, String info, Integer distance2, Integer distance3, String countryBorder, String countryCode, String currentStreetName, String nextStreetName, String nearbyStreetName, Boolean isCurrentStreetNameRouteNumber, Boolean isNextStreetNameRouteNumber, Boolean isNearbyStreetNameRouteNumber, String cityName, String stateName, String countryName, String highwayExitNumber, Integer ete, String arrivalTime, String isTimezoneChanged, String dateTime, Boolean is24h)
    • Method Detail

      • getDistance

         final Integer getDistance()

        prime distance value in meter

      • getEta

         final Integer getEta()

        value: eta time value in minute

      • getInfo

         final String getInfo()

        additional info string which will be prompt in final audio

      • getDistance2

         final Integer getDistance2()

        secondary distance value in meter

      • getDistance3

         final Integer getDistance3()

        third distance value in meter

      • getCountryCode

         final String getCountryCode()

        3 characters ISO country code

      • getCurrentStreetName

         final String getCurrentStreetName()

        the name of street where vehicle locates currently

      • getNextStreetName

         final String getNextStreetName()

        the name of next upcoming street when driving

      • isCurrentStreetNameRouteNumber

         final Boolean isCurrentStreetNameRouteNumber()

        "true" when type of "current_street_name" type is route number, if true, tasdk will process it into a more understandable string. "false" when type of "current_street_name" type is not route number. Default: "false".

      • isNextStreetNameRouteNumber

         final Boolean isNextStreetNameRouteNumber()

        "true" when type of "next_street_name" type is route number, if true, tasdk will process it into a more understandable string. "false" when type of "next_street_name" type is not route number,. Default: "false".

      • isNearbyStreetNameRouteNumber

         final Boolean isNearbyStreetNameRouteNumber()

        "true" when type of "nearby_street_name" type is route number, if true, tasdk will process it into a more understandable string. "false" when type of "nearby_street_name" type is not route number, not. Default: "false".

      • getCityName

         final String getCityName()

        the name of the city where the vehicle is located

      • getStateName

         final String getStateName()

        the name of the state where the vehicle is located

      • getCountryName

         final String getCountryName()

        the name of the country where the vehicle is located

      • getHighwayExitNumber

         final String getHighwayExitNumber()

        highway exit number, tasdk will process it into a more understandable string.

      • getEte

         final Integer getEte()

        time spent from current location to next stop(waypoint or destination), unit: minute

      • getArrivalTime

         final String getArrivalTime()

        arrive next stop time value, time format should follow the tts engine's rule

      • isTimezoneChanged

         final String isTimezoneChanged()

        "true" when timezone of next stop is different from current one, "false" when timezone of next stop is same with current one, Default: "false", If client use other string except for "true" and "false", this value is always false.

      • is24h

         final Boolean is24h()

        When true, native audio uses 24-hour format for arrival time (key is_24h). When null (not set), the key is omitted and native treats it the same as false.