doc/handsfree-api.txt

   1 Handsfree hierarchy
   2 ===================
   3
   4 Service         org.ofono
   5 Interface       org.ofono.Handsfree
   6 Object path     [variable prefix]/{modem0,modem1,...}
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns properties for the Handsfree Interface. See the
  11                         properties section for available properties.
  12
  13                 void SetProperty(string property, variant value)
  14
  15                         Changes the value of the specified property. Only
  16                         properties that are listed as readwrite are
  17                         changeable. On success a PropertyChanged signal
  18                         will be emitted.
  19
  20                         Possible Errors: [service].Error.InProgress
  21                                          [service].Error.InvalidArguments
  22
  23                 string RequestPhoneNumber()
  24
  25                         Request a phone number from the AG, corresponding to the
  26                         last voice tag recorded in the HF. The AG may accept or
  27                         reject this request depending on its internal state.
  28
  29                         This functionality is generally implemented by using
  30                         the +BINP=1 AT command.
  31
  32                         Possible Errors: [service].Error.InProgress
  33                                          [service].Error.InvalidArguments
  34                                          [service].Error.Failed
  35
  36 Signals         PropertyChanged(string property, variant value)
  37
  38                         Signal is emitted whenever a property has changed.
  39                         The new value is passed as the signal argument.
  40
  41 Properties      array{string} Features [readonly]
  42
  43                         List of features supported by the AG. The currently
  44                         supported values are:
  45                                 "voice-recognition"
  46                                 "attach-voice-tag"
  47
  48                 boolean InbandRinging [readonly]
  49
  50                         Boolean representing whether inband ringing is enabled.
  51
  52                 boolean VoiceRecognition [readwrite]
  53
  54                         Boolean representing whether voice recognition is
  55                         currently active in the AG. This property may be written
  56                         to activate or deactivate the function from the HF, or
  57                         the AG could autonomously initiate it.