• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# moving_photo_capi.h
2
3## 概述
4
5定义与动态照片相关的API。提供获取动态照片信息的功能。
6
7**库:** libmedia_asset_manager.so
8
9**引用文件:** <multimedia/media_library/moving_photo_capi.h>
10
11**系统能力:** SystemCapability.FileManagement.PhotoAccessHelper.Core
12
13**起始版本:** 13
14
15**相关模块:** [MediaAssetManager](capi-mediaassetmanager.md)
16
17## 汇总
18
19### 函数
20
21| 名称 | 描述 |
22| -- | -- |
23| [MediaLibrary_ErrorCode OH_MovingPhoto_GetUri(OH_MovingPhoto* movingPhoto, const char** uri)](#oh_movingphoto_geturi) | 获取动态照片的uri。 |
24| [MediaLibrary_ErrorCode OH_MovingPhoto_RequestContentWithUris(OH_MovingPhoto* movingPhoto, char* imageUri, char* videoUri)](#oh_movingphoto_requestcontentwithuris) | 同时请求动态照片的图片内容和视频内容,并写入参数指定的对应的uri中。 |
25| [MediaLibrary_ErrorCode OH_MovingPhoto_RequestContentWithUri(OH_MovingPhoto* movingPhoto, MediaLibrary_ResourceType resourceType, char* uri)](#oh_movingphoto_requestcontentwithuri) | 请求指定资源类型的动态照片内容,并写入参数指定的uri中。 |
26| [MediaLibrary_ErrorCode OH_MovingPhoto_RequestContentWithBuffer(OH_MovingPhoto* movingPhoto, MediaLibrary_ResourceType resourceType, const uint8_t** buffer, uint32_t* size)](#oh_movingphoto_requestcontentwithbuffer) | 请求指定资源类型的动态照片内容,以ArrayBuffer的形式返回。 |
27| [MediaLibrary_ErrorCode OH_MovingPhoto_Release(OH_MovingPhoto* movingPhoto)](#oh_movingphoto_release) | Release [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)实例。 |
28
29## 函数说明
30
31### OH_MovingPhoto_GetUri()
32
33```
34MediaLibrary_ErrorCode OH_MovingPhoto_GetUri(OH_MovingPhoto* movingPhoto, const char** uri)
35```
36
37**描述**
38
39获取动态照片的uri。
40
41**起始版本:** 13
42
43
44**参数:**
45
46| 参数项 | 描述 |
47| -- | -- |
48| [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)* movingPhoto | [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)实例。 |
49| const char** uri | 动态照片的uri。 |
50
51**返回:**
52
53| 类型 | 说明 |
54| -- | -- |
55| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | MEDIA_LIBRARY_OK:方法调用成功。<br>      MEDIA_LIBRARY_PARAMETER_ERROR:参数错误。可能的原因:<br>                                      1. 未指定强制参数。<br>                                      2. 参数类型不正确。<br>                                      3. 参数验证失败。<br>      MEDIA_LIBRARY_INTERNAL_SYSTEM_ERROR:内部系统错误。 |
56
57### OH_MovingPhoto_RequestContentWithUris()
58
59```
60MediaLibrary_ErrorCode OH_MovingPhoto_RequestContentWithUris(OH_MovingPhoto* movingPhoto, char* imageUri,char* videoUri)
61```
62
63**描述**
64
65同时请求动态照片的图片内容和视频内容,并写入参数指定的对应的uri中。
66
67**需要权限:** ohos.permission.READ_IMAGEVIDEO
68
69**起始版本:** 13
70
71
72**参数:**
73
74| 参数项 | 描述 |
75| -- | -- |
76| [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)* movingPhoto | [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)实例。 |
77| char* imageUri | 用于保存图像数据的目标文件uri。 |
78| char* videoUri | 用于保存视频数据的目标文件uri。 |
79
80**返回:**
81
82| 类型 | 说明 |
83| -- | -- |
84| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | MEDIA_LIBRARY_OK:方法调用成功。<br>      MEDIA_LIBRARY_PARAMETER_ERROR:参数错误。可能的原因:<br>                                      1. 未指定强制参数。<br>                                      2. 参数类型不正确。<br>                                      3. 参数验证失败。<br>      MEDIA_LIBRARY_PERMISSION_DENIED:没有权限。<br>      MEDIA_LIBRARY_INTERNAL_SYSTEM_ERROR:内部系统错误。 |
85
86### OH_MovingPhoto_RequestContentWithUri()
87
88```
89MediaLibrary_ErrorCode OH_MovingPhoto_RequestContentWithUri(OH_MovingPhoto* movingPhoto,MediaLibrary_ResourceType resourceType, char* uri)
90```
91
92**描述**
93
94请求指定资源类型的动态照片内容,并写入参数指定的uri中。
95
96**需要权限:** ohos.permission.READ_IMAGEVIDEO
97
98**起始版本:** 13
99
100
101**参数:**
102
103| 参数项 | 描述 |
104| -- | -- |
105| [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)* movingPhoto | [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)实例。 |
106| [MediaLibrary_ResourceType](capi-media-asset-base-capi-h.md#medialibrary_resourcetype) resourceType | 指定的资源类型[MediaLibrary_ResourceType](capi-media-asset-base-capi-h.md#medialibrary_resourcetype)。 |
107| char* uri | 保存数据的目标文件uri。 |
108
109**返回:**
110
111| 类型 | 说明 |
112| -- | -- |
113| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | MEDIA_LIBRARY_OK:方法调用成功。<br>      MEDIA_LIBRARY_PARAMETER_ERROR:参数错误。可能的原因:<br>                                      1. 未指定强制参数。<br>                                      2. 参数类型不正确。<br>                                      3. 参数验证失败。<br>      MEDIA_LIBRARY_PERMISSION_DENIED:没有权限。<br>      MEDIA_LIBRARY_INTERNAL_SYSTEM_ERROR:内部系统错误。 |
114
115### OH_MovingPhoto_RequestContentWithBuffer()
116
117```
118MediaLibrary_ErrorCode OH_MovingPhoto_RequestContentWithBuffer(OH_MovingPhoto* movingPhoto,MediaLibrary_ResourceType resourceType, const uint8_t** buffer, uint32_t* size)
119```
120
121**描述**
122
123请求指定资源类型的动态照片内容,以ArrayBuffer的形式返回。
124
125**需要权限:** ohos.permission.READ_IMAGEVIDEO
126
127**起始版本:** 13
128
129
130**参数:**
131
132| 参数项 | 描述 |
133| -- | -- |
134| [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)* movingPhoto | [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)实例。 |
135| [MediaLibrary_ResourceType](capi-media-asset-base-capi-h.md#medialibrary_resourcetype) resourceType | 指定的资源类型[MediaLibrary_ResourceType](capi-media-asset-base-capi-h.md#medialibrary_resourcetype)。 |
136| const uint8_t** buffer | 保存目标文件数据的缓冲区。 |
137| uint32_t* size | 缓冲区的大小。 |
138
139**返回:**
140
141| 类型 | 说明 |
142| -- | -- |
143| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | MEDIA_LIBRARY_OK:方法调用成功。<br>      MEDIA_LIBRARY_PARAMETER_ERROR:参数错误。可能的原因:<br>                                      1. 未指定强制参数。<br>                                      2. 参数类型不正确。<br>                                      3. 参数验证失败。<br>      MEDIA_LIBRARY_PERMISSION_DENIED:没有权限。<br>      MEDIA_LIBRARY_INTERNAL_SYSTEM_ERROR:内部系统错误。 |
144
145### OH_MovingPhoto_Release()
146
147```
148MediaLibrary_ErrorCode OH_MovingPhoto_Release(OH_MovingPhoto* movingPhoto)
149```
150
151**描述**
152
153Release [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)实例。
154
155**起始版本:** 13
156
157
158**参数:**
159
160| 参数项 | 描述 |
161| -- | -- |
162| [OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)* movingPhoto | 要释放的[OH_MovingPhoto](capi-mediaassetmanager-oh-movingphoto.md)实例。 |
163
164**返回:**
165
166| 类型 | 说明 |
167| -- | -- |
168| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | MEDIA_LIBRARY_OK:方法调用成功。<br>      MEDIA_LIBRARY_PARAMETER_ERROR:参数错误。可能的原因:<br>                                      1. 未指定强制参数。<br>                                      2. 参数类型不正确。<br>                                      3. 参数验证失败。 |
169
170
171