• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# media_asset_change_request_capi.h
2
3## Overview
4
5The file declares the APIs related to media asset change requests. You can use the APIs to change media assets.
6
7**Library**: libmedia_asset_manager.so
8
9**File to include**: <multimedia/media_library/media_asset_change_request_capi.h>
10
11**System capability**: SystemCapability.FileManagement.PhotoAccessHelper.Core
12
13**Since**: 12
14
15**Related module**: [MediaAssetManager](capi-mediaassetmanager.md)
16
17## Summary
18
19### Functions
20
21| Name| Description|
22| -- | -- |
23| [OH_MediaAssetChangeRequest* OH_MediaAssetChangeRequest_Create(OH_MediaAsset* mediaAsset)](#oh_mediaassetchangerequest_create) | Creates an [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md) instance.|
24| [MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_AddResourceWithUri(OH_MediaAssetChangeRequest* changeRequest,MediaLibrary_ResourceType resourceType, char* fileUri)](#oh_mediaassetchangerequest_addresourcewithuri) | Adds a resource of the given URI.|
25| [MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_AddResourceWithBuffer(OH_MediaAssetChangeRequest* changeRequest,MediaLibrary_ResourceType resourceType, uint8_t* buffer, uint32_t length)](#oh_mediaassetchangerequest_addresourcewithbuffer) | Adds a resource using ArrayBuffer data.|
26| [MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_GetWriteCacheHandler(OH_MediaAssetChangeRequest* changeRequest,int32_t* fd)](#oh_mediaassetchangerequest_getwritecachehandler) | Obtains the handler used for writing a file to cache.|
27| [MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_SaveCameraPhoto(OH_MediaAssetChangeRequest* changeRequest,MediaLibrary_ImageFileType imageFileType)](#oh_mediaassetchangerequest_savecameraphoto) | Saves the photo taken by the camera.|
28| [MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_DiscardCameraPhoto(OH_MediaAssetChangeRequest* changeRequest)](#oh_mediaassetchangerequest_discardcameraphoto) | Discards the photo taken by the camera.|
29| [MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_Release(OH_MediaAssetChangeRequest* changeRequest)](#oh_mediaassetchangerequest_release) | Releases an [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md) instance.|
30
31## Function Description
32
33### OH_MediaAssetChangeRequest_Create()
34
35```
36OH_MediaAssetChangeRequest* OH_MediaAssetChangeRequest_Create(OH_MediaAsset* mediaAsset)
37```
38
39**Description**
40
41Creates an [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md) instance.
42
43**Since**: 12
44
45
46**Parameters**
47
48| Parameter| Description|
49| -- | -- |
50| [OH_MediaAsset](capi-mediaassetmanager-oh-mediaasset.md)* mediaAsset | Pointer to an [OH_MediaAsset](capi-mediaassetmanager-oh-mediaasset.md) instance.|
51
52**Return value**
53
54| Type| Description|
55| -- | -- |
56| [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md)* | **MEDIA_LIBRARY_OK**: operation success.<br>**MEDIA_LIBRARY_PARAMETER_ERROR**: incorrect parameters. Possible causes:<br>                                      1. A mandatory parameter is not specified.<br>                                      2. A parameter type is incorrect.<br>                                      3. Parameter verification fails.<br>**MEDIA_LIBRARY_INTERNAL_SYSTEM_ERROR**: internal system error.|
57
58### OH_MediaAssetChangeRequest_AddResourceWithUri()
59
60```
61MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_AddResourceWithUri(OH_MediaAssetChangeRequest* changeRequest,MediaLibrary_ResourceType resourceType, char* fileUri)
62```
63
64**Description**
65
66Adds a resource of the given URI.
67
68**Since**: 13
69
70
71**Parameters**
72
73| Parameter| Description|
74| -- | -- |
75| [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md)* changeRequest | Pointer to an [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md) instance.|
76| [MediaLibrary_ResourceType](capi-media-asset-base-capi-h.md#medialibrary_resourcetype) resourceType | Type of the resource to add, which is specified by [MediaLibrary_ResourceType](capi-media-asset-base-capi-h.md#medialibrary_resourcetype).|
77| char* fileUri | Pointer to the URI of the file.|
78
79**Return value**
80
81| Type| Description|
82| -- | -- |
83| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | **MEDIA_LIBRARY_OK**: operation success.<br>**MEDIA_LIBRARY_PARAMETER_ERROR**: incorrect parameters. Possible causes:<br>                                      1. A mandatory parameter is not specified.<br>                                      2. A parameter type is incorrect.<br>                                      3. Parameter verification fails.<br>**MEDIA_LIBRARY_NO_SUCH_FILE**: The file does not exist.<br>**MEDIA_LIBRARY_INTERNAL_SYSTEM_ERROR**: internal system error.<br>**MEDIA_LIBRARY_OPERATION_NOT_SUPPORTED**: unsupported operation.|
84
85### OH_MediaAssetChangeRequest_AddResourceWithBuffer()
86
87```
88MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_AddResourceWithBuffer(OH_MediaAssetChangeRequest* changeRequest,MediaLibrary_ResourceType resourceType, uint8_t* buffer, uint32_t length)
89```
90
91**Description**
92
93Adds a resource using ArrayBuffer data.
94
95**Since**: 12
96
97
98**Parameters**
99
100| Parameter| Description|
101| -- | -- |
102| [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md)* changeRequest | Pointer to an [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md) instance.|
103| [MediaLibrary_ResourceType](capi-media-asset-base-capi-h.md#medialibrary_resourcetype) resourceType | Type of the resource to add.|
104| uint8_t* buffer | Pointer to the data buffer.|
105| uint32_t length | Length of the data buffer.|
106
107**Return value**
108
109| Type| Description|
110| -- | -- |
111| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | **MEDIA_LIBRARY_OK**: operation success.<br>**MEDIA_LIBRARY_PARAMETER_ERROR**: incorrect parameters. Possible causes:<br>                                      1. A mandatory parameter is not specified.<br>                                      2. A parameter type is incorrect.<br>                                      3. Parameter verification fails.<br>**MEDIA_LIBRARY_INTERNAL_SYSTEM_ERROR**: internal system error.<br>**MEDIA_LIBRARY_OPERATION_NOT_SUPPORTED**: unsupported operation.|
112
113### OH_MediaAssetChangeRequest_GetWriteCacheHandler()
114
115```
116MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_GetWriteCacheHandler(OH_MediaAssetChangeRequest* changeRequest,int32_t* fd)
117```
118
119**Description**
120
121Obtains the handler used for writing a file to cache.
122
123**Required permissions**: ohos.permission.WRITE_IMAGEVIDEO
124
125**Since**: 13
126
127
128**Parameters**
129
130| Parameter| Description|
131| -- | -- |
132| [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md)* changeRequest | Pointer to an [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md) instance.|
133| int32_t* fd | Pointer to the file descriptor (FD) obtained.|
134
135**Return value**
136
137| Type| Description|
138| -- | -- |
139| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | **MEDIA_LIBRARY_OK**: operation success.<br>**MEDIA_LIBRARY_PARAMETER_ERROR**: incorrect parameters. Possible causes:<br>                                      1. A mandatory parameter is not specified.<br>                                      2. A parameter type is incorrect.<br>                                      3. Parameter verification fails.<br>**MEDIA_LIBRARY_INTERNAL_SYSTEM_ERROR**: internal system error.<br>**MEDIA_LIBRARY_PERMISSION_DENIED**: no access permission.<br>**MEDIA_LIBRARY_OPERATION_NOT_SUPPORTED**: unsupported operation.|
140
141### OH_MediaAssetChangeRequest_SaveCameraPhoto()
142
143```
144MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_SaveCameraPhoto(OH_MediaAssetChangeRequest* changeRequest,MediaLibrary_ImageFileType imageFileType)
145```
146
147**Description**
148
149Saves the photo taken by the camera.
150
151**Since**: 12
152
153
154**Parameters**
155
156| Parameter| Description|
157| -- | -- |
158| [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md)* changeRequest | Pointer to an [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md) instance.|
159| [MediaLibrary_ImageFileType](capi-media-asset-base-capi-h.md#medialibrary_imagefiletype) imageFileType | Type of the image file of the photo.|
160
161**Return value**
162
163| Type| Description|
164| -- | -- |
165| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | **MEDIA_LIBRARY_OK**: operation success.<br>**MEDIA_LIBRARY_PARAMETER_ERROR**: incorrect parameters. Possible causes:<br>                                      1. A mandatory parameter is not specified.<br>                                      2. A parameter type is incorrect.<br>                                      3. Parameter verification fails.<br>**MEDIA_LIBRARY_INTERNAL_SYSTEM_ERROR**: internal system error.<br>**MEDIA_LIBRARY_OPERATION_NOT_SUPPORTED**: unsupported operation.|
166
167### OH_MediaAssetChangeRequest_DiscardCameraPhoto()
168
169```
170MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_DiscardCameraPhoto(OH_MediaAssetChangeRequest* changeRequest)
171```
172
173**Description**
174
175Discards the photo taken by the camera.
176
177**Since**: 12
178
179
180**Parameters**
181
182| Parameter| Description|
183| -- | -- |
184| [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md)* changeRequest | Pointer to an [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md) instance.|
185
186**Return value**
187
188| Type| Description|
189| -- | -- |
190| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | **MEDIA_LIBRARY_OK**: operation success.<br>**MEDIA_LIBRARY_PARAMETER_ERROR**: incorrect parameters. Possible causes:<br>                                      1. A mandatory parameter is not specified.<br>                                      2. A parameter type is incorrect.<br>                                      3. Parameter verification fails.<br>**MEDIA_LIBRARY_INTERNAL_SYSTEM_ERROR**: internal system error.<br>**MEDIA_LIBRARY_OPERATION_NOT_SUPPORTED**: unsupported operation.|
191
192### OH_MediaAssetChangeRequest_Release()
193
194```
195MediaLibrary_ErrorCode OH_MediaAssetChangeRequest_Release(OH_MediaAssetChangeRequest* changeRequest)
196```
197
198**Description**
199
200Releases an [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md) instance.
201
202**Since**: 12
203
204
205**Parameters**
206
207| Parameter| Description|
208| -- | -- |
209| [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md)* changeRequest | Pointer to an [OH_MediaAssetChangeRequest](capi-mediaassetmanager-oh-mediaassetchangerequest.md) instance.|
210
211**Return value**
212
213| Type| Description|
214| -- | -- |
215| [MediaLibrary_ErrorCode](capi-media-asset-base-capi-h.md#medialibrary_errorcode) | **MEDIA_LIBRARY_OK**: operation success.<br>**MEDIA_LIBRARY_PARAMETER_ERROR**: incorrect parameters. Possible causes:<br>                                      1. A mandatory parameter is not specified.<br>                                      2. A parameter type is incorrect.<br>                                      3. Parameter verification fails.|
216