Reviews - Add Video Frame Url

Service:

Azure AI Services

API Version:

1.0

Use this method to add frames for a video review. The timescale parameter is a factor that's used to convert the time stamp on a frame into milliseconds. Timescale is provided in the output of the Content Moderator video media processor on the Azure Media Services platform. Timescale in the video moderation output is Ticks/Second.

POST {Endpoint}/contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/frames

With optional parameters:

POST {Endpoint}/contentmoderator/review/v1.0/teams/{teamName}/reviews/{reviewId}/frames?overload=url&timescale={timescale}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Azure Cognitive Services endpoints (protocol and host name, such as https://westus.api.cognitive.microsoft.com).
reviewId	path	True	string	ID of the review.
teamName	path	True	string	Your team name.
timescale	query		integer	Timescale of the video.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string
Content-Type	True	string	Content type.

Request Body

Name	Required	Type	Description
FrameImage	True	string	Content to review.
Timestamp	True	string	Time stamp of the frame.
Metadata		Metadata[]	Metadata details.
ReviewerResultTags		ReviewerResultTags[]

Responses

Name	Type	Description
204 No Content		No content.
Other Status Codes	APIError	Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Add video frame url input request

Sample request

HTTP

POST {Endpoint}/contentmoderator/review/v1.0/teams/ModeratorTeam/reviews/201711v18ea829372b14f9e9d382621e62429a9/frames?overload=url



[
  {
    "Timestamp": "2334",
    "FrameImage": "https://ae01.alicdn.com/kf/HTB1QMvNMVXXXXbpapXXq6xXFXXXJ/Sexy-Europe-font-b-Racy-b-font-Lingerie-Lace-font-b-Red-b-font-Bow-Bride.jpg",
    "Metadata": [
      {
        "Key": "apiScoreVal",
        "Value": "0.206"
      },
      {
        "Key": "a",
        "Value": "False"
      }
    ]
  }
]

Sample response

Status code:

204

Definitions

Name	Description
APIError	Error information that the API returns.
Error	Error body.
Metadata	Metadata details.
ReviewerResultTags

APIError

Object

Error information that the API returns.

Name	Type	Description
Error	Error	Error body.

Error

Object

Error body.

Name	Type	Description
Code	string
Message	string

Metadata

Object

Metadata details.

Name	Type	Description
Key	string	Your key parameter.
Value	string	Your value parameter.

ReviewerResultTags

Object

Name	Type	Description
Key	string	Your key parameter.
Value	string	Your value parameter.