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