1# IActivityInterface 2 3 4## 概述 5 6定义对行为识别进行基本操作的接口。 7 8接口包含注册回调函数，取消注册回调函数，获取设备支持的行为类型，获取当前设备的行为类型，订阅和取消订阅行为事件，获取设备缓存的行为事件。 9 10**相关模块:** 11 12[HdiActivityRecognition](_hdi_activity_recognition.md) 13 14 15## 汇总 16 17 18### Public 成员函数 19 20 | 名称 | 描述 | 21| -------- | -------- | 22| [RegisterActRecognitionCallback](#registeractrecognitioncallback) ([in] [IActivityChangedCallback](interface_i_activity_changed_callback.md) callbackObj) | 注册回调函数。 | 23| [UnregisterActRecognitionCallback](#unregisteractrecognitioncallback) ([in] [IActivityChangedCallback](interface_i_activity_changed_callback.md) callbackObj) | 取消注册回调函数。 | 24| [GetSupportActivity](#getsupportactivity) ([out] String[] activity) | 获取设备支持的行为类型。 | 25| [GetCurrentActivity](#getcurrentactivity) ([out] struct [ActRecognitionEvent](_act_recognition_event.md)[] event) | 获取当前的行为事件。 | 26| [EnableActRecognitionEvent](#enableactrecognitionevent) ([in] int activity, [in] int eventType, [in] long maxReportLatencyNs, [in] int powerMode) | 订阅某个行为事件。 | 27| [DisableActRecognitionEvent](#disableactrecognitionevent) ([in] int activity, [in] int eventType) | 取消订阅某个行为事件。 | 28| [FlushActivity](#flushactivity) () | 数据刷新。 | 29 30 31## 成员函数说明 32 33 34### DisableActRecognitionEvent() 35 36 37``` 38IActivityInterface::DisableActRecognitionEvent ([in] int activity, [in] int eventType ) 39``` 40 41**描述:** 42 43取消订阅某个之前订阅过的行为事件。 44 45**参数:** 46 47 | 名称 | 描述 | 48| -------- | -------- | 49| activity | 取消订阅的行为，参考[EnableActRecognitionEvent](#enableactrecognitionevent)接口的activity参数。 | 50| eventType | 事件类型，参考[ActRecognitionEventType](_hdi_activity_recognition.md#actrecognitioneventtype)定义。可以填充1（进入）或2（退出），也可以填充3（同时订阅进入和退出）。 | 51 52**返回:** 53 54如果操作成功，则返回0。 55 56如果操作失败，则返回负值。 57 58 59### EnableActRecognitionEvent() 60 61 62``` 63IActivityInterface::EnableActRecognitionEvent ([in] int activity, [in] int eventType, [in] long maxReportLatencyNs, [in] int powerMode ) 64``` 65 66**描述:** 67 68订阅某个行为事件。 69 70订阅某个行为事件后，若该行为事件有发生，则会在一定时间内上报。 71 72**参数:** 73 74 | 名称 | 描述 | 75| -------- | -------- | 76| activity | 订阅的行为，通过[GetSupportActivity](#getsupportactivity)得到设备支持的所有行为，然后将行为列表中需要订阅的行为下标作为参数填充。 | 77| eventType | 事件类型，参考[ActRecognitionEventType](_hdi_activity_recognition.md#actrecognitioneventtype)定义。可以填充1（进入）或2（退出），也可以填充3（同时订阅进入和退出）。 | 78| maxReportLatencyNs | 最大上报时间间隔，单位是纳秒。若该时间间隔内有订阅的行为事件发生，则会上报。若存在多个订阅的行为，取最小的时间间隔。 | 79| powerMode | 功耗模式。参考[ActRecognitionPowerMode](_hdi_activity_recognition.md#actrecognitionpowermode)定义。 | 80 81**返回:** 82 83如果操作成功，则返回0。 84 85如果操作失败，则返回负值。 86 87 88### FlushActivity() 89 90 91``` 92IActivityInterface::FlushActivity () 93``` 94 95**描述:** 96 97数据刷新。 98 99刷新设备缓存的所有行为事件并上报。 100 101**返回:** 102 103如果操作成功，则返回0。 104 105如果操作失败，则返回负值。 106 107 108### GetCurrentActivity() 109 110 111``` 112IActivityInterface::GetCurrentActivity ([out] struct ActRecognitionEvent[] event) 113``` 114 115**描述:** 116 117获取当前的行为事件。 118 119在调用该接口前，必须先要调用[EnableActRecognitionEvent](#enableactrecognitionevent)接口对行为进行使能。 120 121**参数:** 122 123 | 名称 | 描述 | 124| -------- | -------- | 125| event | 返回当前设备的行为事件，可能有多个行为共存，详见[ActRecognitionEvent](_act_recognition_event.md)。 | 126 127**返回:** 128 129如果操作成功，则返回0。 130 131如果操作失败，则返回负值。 132 133 134### GetSupportActivity() 135 136 137``` 138IActivityInterface::GetSupportActivity ([out] String[] activity) 139``` 140 141**描述:** 142 143获取设备支持的行为类型。 144 145**参数:** 146 147 | 名称 | 描述 | 148| -------- | -------- | 149| activity | 参数类型为字符串，输出设备支持的行为类型。 包括："inVehicle" 、"onBicycle"、"walking"、"running"、"still"、"fast_walking"、"high_speed_rail" "unknown"、"elevator"、"relative_still"、"walking_handhold"、"lying_posture"、"plane"、"metro"等。对应[ActRecognitionEventType](_hdi_activity_recognition.md#actrecognitioneventtype)中的类型。 | 150 151**返回:** 152 153如果操作成功，则返回0。 154 155如果操作失败，则返回负值。 156 157 158### RegisterActRecognitionCallback() 159 160 161``` 162IActivityInterface::RegisterActRecognitionCallback ([in] IActivityChangedCallback callbackObj) 163``` 164 165**描述:** 166 167注册回调函数。 168 169用户在获得订阅的行为事件或获取设备缓存的行为事件前，需要先注册该回调函数。数据会通过回调函数进行上报。 170 171**参数:** 172 173 | 名称 | 描述 | 174| -------- | -------- | 175| callbackObj | 要注册的回调函数，只需成功订阅一次，无需重复订阅。详见[IActivityChangedCallback](interface_i_activity_changed_callback.md)。 | 176 177**返回:** 178 179如果注册回调函数成功，则返回0。 180 181如果注册回调函数失败，则返回负值。 182 183 184### UnregisterActRecognitionCallback() 185 186 187``` 188IActivityInterface::UnregisterActRecognitionCallback ([in] IActivityChangedCallback callbackObj) 189``` 190 191**描述:** 192 193取消注册回调函数。 194 195取消之前注册的回调函数。当不需要使用行为识别功能，或需要更换回调函数时，需要取消注册回调函数。 196 197**参数:** 198 199 | 名称 | 描述 | 200| -------- | -------- | 201| callbackObj | 要取消注册的回调函数，只需成功取消订阅一次，无需重复取消订阅。详见[IActivityChangedCallback](interface_i_activity_changed_callback.md)。 | 202 203**返回:** 204 205如果取消注册回调函数成功，则返回0。 206 207如果取消注册回调函数失败，则返回负值。 208