1# IEffectModel 2 3 4## 概述 5 6音效模型接口。 7 8提供音效模型支持的驱动能力，包括获取描述符列表、创建音效控制器、销毁音效控制器、获取指定描述符等 9 10**起始版本：** 4.0 11 12**相关模块：**[HdiEffect](_hdi_effect.md) 13 14 15## 汇总 16 17 18### Public 成员函数 19 20| 名称 | 描述 | 21| -------- | -------- | 22| [IsSupplyEffectLibs](#issupplyeffectlibs) ([out] boolean supply) | 查询供应商/OEM是否提供效果库。如果提供，请使用提供的效果库。如果没有，请使用系统服务软件效果。 | 23| [GetAllEffectDescriptors](#getalleffectdescriptors) ([out] struct [EffectControllerDescriptor](_effect_controller_descriptor.md)[] descs) | 获取所有支持的音效的描述符 | 24| [CreateEffectController](#createeffectcontroller) ([in]struct [EffectInfo](_effect_info.md) info, [out] [IEffectControl](interface_i_effect_control.md) contoller, [out] struct [ControllerId](_controller_id.md) id) | 创建一个用于操作音效实例的音效控制器。 | 25| [DestroyEffectController](#destroyeffectcontroller) ([in] struct [ControllerId](_controller_id.md) id) | 销毁控制器ID指定的音效控制器。 | 26| [GetEffectDescriptor](#geteffectdescriptor) ([in] String effectId, [out] struct [EffectControllerDescriptor](_effect_controller_descriptor.md) desc) | 获取指定音效的描述符 | 27 28 29## 成员函数说明 30 31 32### CreateEffectController() 33 34``` 35IEffectModel::CreateEffectController ([in] struct EffectInfo info, [out] IEffectControl contoller, [out] struct ControllerId id ) 36``` 37 38**描述** 39 40创建一个用于操作音效实例的音效控制器。 41 42**起始版本：** 4.0 43 44**参数:** 45 46| 名称 | 描述 | 47| -------- | -------- | 48| model | 指向要操作的效果模型的指针 | 49| info | 音效信息 | 50| contoller | 音效控制器对象 | 51| contollerId | 音效控制器ID | 52 53**返回：** 54 55执行成功返回0，执行失败返回其他值 56 57 58### DestroyEffectController() 59 60``` 61IEffectModel::DestroyEffectController ([in] struct ControllerId id) 62``` 63 64**描述** 65 66销毁控制器ID指定的音效控制器。 67 68**起始版本：** 4.0 69 70**参数:** 71 72| 名称 | 描述 | 73| -------- | -------- | 74| model | 指向要操作的效果模型的指针 | 75| contollerId | 音效控制器ID | 76 77**返回：** 78 79执行成功返回0，执行失败返回其他值 80 81 82### GetAllEffectDescriptors() 83 84``` 85IEffectModel::GetAllEffectDescriptors ([out] struct EffectControllerDescriptor[] descs) 86``` 87 88**描述** 89 90获取所有支持的音效的描述符 91 92**起始版本：** 4.0 93 94**参数:** 95 96| 名称 | 描述 | 97| -------- | -------- | 98| model | 指向要操作的效果模型的指针 | 99| descs | 音效描述符列表 | 100 101**返回：** 102 103执行成功返回0，执行失败返回其他值 104 105 106### GetEffectDescriptor() 107 108``` 109IEffectModel::GetEffectDescriptor ([in] String effectId, [out] struct EffectControllerDescriptor desc ) 110``` 111 112**描述** 113 114获取指定音效的描述符 115 116**起始版本：** 4.0 117 118**参数:** 119 120| 名称 | 描述 | 121| -------- | -------- | 122| model | 指向要操作的效果模型的指针 | 123| effectId | 音效ID | 124| desc | 指定音效的描述符 | 125 126**返回：** 127 128执行成功返回0，执行失败返回其他值 129 130 131### IsSupplyEffectLibs() 132 133``` 134IEffectModel::IsSupplyEffectLibs ([out] boolean supply) 135``` 136 137**描述** 138 139查询供应商/OEM是否提供效果库。如果提供，请使用提供的效果库。如果没有，请使用系统服务软件效果。 140 141**起始版本：** 4.0 142 143**参数:** 144 145| 名称 | 描述 | 146| -------- | -------- | 147| model | 指向要操作的效果模型的指针 | 148| supply | 供应商/OEM是否提供效果库的状态 | 149 150**返回：** 151 152执行成功返回0，执行失败返回其他值 153