Adds mark information to a media asset such as a video or audio file for subsequent retrieval, analysis, and management.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ice:AddMediaMarks |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| MediaId |
string |
Yes |
The media asset ID. |
53afdf003a2171ed9c6a16b5feac6402 |
| MediaMarks |
string |
Yes |
The mark information. The string content must conform to the JSONArray format. |
[ { "MarkStartTime": "12.1", "MarkEndTime": "12.2", "MarkTag": "tag-1", "MarkContent": "content-1", "MarkStatus": "a" },{ "MarkStartTime": "12.3", "MarkEndTime": "12.4", "MarkTag": "tag-2", "MarkContent": "content-2", "MarkStatus": "online" } ] |
MediaMark
| Name | Type | Required | Description |
| MarkId | String | No | The mark ID. |
| MarkStartTime | Float | No | The in-point. |
| MarkEndTime | Float | No | The out-point. |
| MarkTag | String | No | The custom tag for classification. |
| MarkContent | String | No | The content information of the mark. |
| MarkStatus | String | No | The status of the mark. |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| MediaId |
string |
The media asset ID. |
53afdf003a******6a16b5feac6402 |
| MediaMarkIds |
string |
The IDs of the added marks. |
mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60 |
| RequestId |
string |
The request ID. |
771A1414-27BF-53E6-AB73-EFCB*****ACF |
Examples
Success response
JSON format
{
"MediaId": "53afdf003a******6a16b5feac6402",
"MediaMarkIds": "mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60",
"RequestId": "771A1414-27BF-53E6-AB73-EFCB*****ACF"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | AddMediaMarksFailed | The request processing has failed due to some unknown error. | |
| 403 | Forbidden | User not authorized to operate on the specified resource. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.