Reviews Interface

  • Reference
Package:
com.microsoft.azure.cognitiveservices.vision.contentmoderator

public interface Reviews

An instance of this class provides access to all the operations defined in Reviews.

Method Summary

Modifier and Type Method and Description
ReviewsAddVideoFrameDefinitionStages.WithTeamName addVideoFrame()

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
void addVideoFrame(String teamName, String reviewId, AddVideoFrameOptionalParameter addVideoFrameOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
Observable<Void> addVideoFrameAsync(String teamName, String reviewId, AddVideoFrameOptionalParameter addVideoFrameOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
ReviewsAddVideoFrameStreamDefinitionStages.WithTeamName addVideoFrameStream()

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.
void addVideoFrameStream(String teamName, String reviewId, String contentType, byte[] frameImageZip, String frameMetadata, AddVideoFrameStreamOptionalParameter addVideoFrameStreamOptionalParameter)

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.
Observable<Void> addVideoFrameStreamAsync(String teamName, String reviewId, String contentType, byte[] frameImageZip, String frameMetadata, AddVideoFrameStreamOptionalParameter addVideoFrameStreamOptionalParameter)

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.
ReviewsAddVideoFrameUrlDefinitionStages.WithTeamName addVideoFrameUrl()

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.
void addVideoFrameUrl(String teamName, String reviewId, String contentType, List<VideoFrameBodyItem> videoFrameBody, AddVideoFrameUrlOptionalParameter addVideoFrameUrlOptionalParameter)

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.
Observable<Void> addVideoFrameUrlAsync(String teamName, String reviewId, String contentType, List<VideoFrameBodyItem> videoFrameBody, AddVideoFrameUrlOptionalParameter addVideoFrameUrlOptionalParameter)

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.
void addVideoTranscript(String teamName, String reviewId, byte[] vTTfile)

This API adds a transcript file (text version of all the words spoken in a video) to a video review. The file should be a valid WebVTT format.
Observable<Void> addVideoTranscriptAsync(String teamName, String reviewId, byte[] vTTfile)

This API adds a transcript file (text version of all the words spoken in a video) to a video review. The file should be a valid WebVTT format.
void addVideoTranscriptModerationResult(String teamName, String reviewId, String contentType, List<TranscriptModerationBodyItem> transcriptModerationBody)

This API adds a transcript screen text result file for a video review. Transcript screen text result file is a result of Screen Text API . In order to generate transcript screen text result file , a transcript file has to be screened for profanity using Screen Text API.
Observable<Void> addVideoTranscriptModerationResultAsync(String teamName, String reviewId, String contentType, List<TranscriptModerationBodyItem> transcriptModerationBody)

This API adds a transcript screen text result file for a video review. Transcript screen text result file is a result of Screen Text API . In order to generate transcript screen text result file , a transcript file has to be screened for profanity using Screen Text API.
ReviewsCreateJobDefinitionStages.WithTeamName createJob()

A job Id will be returned for the content posted on this endpoint. Once the content is evaluated against the Workflow provided the review will be created or ignored based on the workflow expression. <h3>CallBack Schemas </h3> <p> <h4>Job Completion CallBack Sample</h4><br/> {<br/> "JobId": "&lt;Job Id&gt;,&lt;br/&gt;

"ReviewId": "<Review Id, if the Job resulted in a Review to be created>",&lt;br/&gt;

"WorkFlowId": "default",&lt;br/&gt;

"Status": "<This will be one of Complete, InProgress, Error>",&lt;br/&gt;

"ContentType": "Image",&lt;br/&gt;

"ContentId": "<This is the ContentId that was specified on input>",&lt;br/&gt;

"CallBackType": "Job",&lt;br/&gt;

"Metadata": {&lt;br/&gt;

"adultscore": "0.xxx",&lt;br/&gt;

"a": "False",&lt;br/&gt;

"racyscore": "0.xxx",&lt;br/&gt;

"r": "True"<br/> }<br/> }<br/> </p> <p> <h4>Review Completion CallBack Sample</h4><br/> { "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx", "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
JobId createJob(String teamName, String contentType, String contentId, String workflowName, String jobContentType, String contentValue, CreateJobOptionalParameter createJobOptionalParameter)

A job Id will be returned for the content posted on this endpoint. Once the content is evaluated against the Workflow provided the review will be created or ignored based on the workflow expression. <h3>CallBack Schemas </h3> <p> <h4>Job Completion CallBack Sample</h4><br/> {<br/> "JobId": "&lt;Job Id&gt;,&lt;br/&gt;

"ReviewId": "<Review Id, if the Job resulted in a Review to be created>",&lt;br/&gt;

"WorkFlowId": "default",&lt;br/&gt;

"Status": "<This will be one of Complete, InProgress, Error>",&lt;br/&gt;

"ContentType": "Image",&lt;br/&gt;

"ContentId": "<This is the ContentId that was specified on input>",&lt;br/&gt;

"CallBackType": "Job",&lt;br/&gt;

"Metadata": {&lt;br/&gt;

"adultscore": "0.xxx",&lt;br/&gt;

"a": "False",&lt;br/&gt;

"racyscore": "0.xxx",&lt;br/&gt;

"r": "True"<br/> }<br/> }<br/> </p> <p> <h4>Review Completion CallBack Sample</h4><br/> { "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx", "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
Observable<JobId> createJobAsync(String teamName, String contentType, String contentId, String workflowName, String jobContentType, String contentValue, CreateJobOptionalParameter createJobOptionalParameter)

A job Id will be returned for the content posted on this endpoint. Once the content is evaluated against the Workflow provided the review will be created or ignored based on the workflow expression. <h3>CallBack Schemas </h3> <p> <h4>Job Completion CallBack Sample</h4><br/> {<br/> "JobId": "&lt;Job Id&gt;,&lt;br/&gt;

"ReviewId": "<Review Id, if the Job resulted in a Review to be created>",&lt;br/&gt;

"WorkFlowId": "default",&lt;br/&gt;

"Status": "<This will be one of Complete, InProgress, Error>",&lt;br/&gt;

"ContentType": "Image",&lt;br/&gt;

"ContentId": "<This is the ContentId that was specified on input>",&lt;br/&gt;

"CallBackType": "Job",&lt;br/&gt;

"Metadata": {&lt;br/&gt;

"adultscore": "0.xxx",&lt;br/&gt;

"a": "False",&lt;br/&gt;

"racyscore": "0.xxx",&lt;br/&gt;

"r": "True"<br/> }<br/> }<br/> </p> <p> <h4>Review Completion CallBack Sample</h4><br/> { "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx", "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
ReviewsCreateReviewsDefinitionStages.WithTeamName createReviews()

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
List<String> createReviews(String teamName, String urlContentType, List<CreateReviewBodyItem> createReviewBody, CreateReviewsOptionalParameter createReviewsOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
Observable<List<String>> createReviewsAsync(String teamName, String urlContentType, List<CreateReviewBodyItem> createReviewBody, CreateReviewsOptionalParameter createReviewsOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
ReviewsCreateVideoReviewsDefinitionStages.WithTeamName createVideoReviews()

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
List<String> createVideoReviews(String teamName, String contentType, List<CreateVideoReviewsBodyItem> createVideoReviewsBody, CreateVideoReviewsOptionalParameter createVideoReviewsOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
Observable<List<String>> createVideoReviewsAsync(String teamName, String contentType, List<CreateVideoReviewsBodyItem> createVideoReviewsBody, CreateVideoReviewsOptionalParameter createVideoReviewsOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
Job getJobDetails(String teamName, String jobId)

Get the Job Details for a Job Id.
Observable<Job> getJobDetailsAsync(String teamName, String jobId)

Get the Job Details for a Job Id.
Review getReview(String teamName, String reviewId)

Returns review details for the review Id passed.
Observable<Review> getReviewAsync(String teamName, String reviewId)

Returns review details for the review Id passed.
ReviewsGetVideoFramesDefinitionStages.WithTeamName getVideoFrames()

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
Frames getVideoFrames(String teamName, String reviewId, GetVideoFramesOptionalParameter getVideoFramesOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
Observable<Frames> getVideoFramesAsync(String teamName, String reviewId, GetVideoFramesOptionalParameter getVideoFramesOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.
void publishVideoReview(String teamName, String reviewId)

Publish video review to make it available for review.
Observable<Void> publishVideoReviewAsync(String teamName, String reviewId)

Publish video review to make it available for review.

Method Details

addVideoFrame

public ReviewsAddVideoFrameDefinitionStages.WithTeamName addVideoFrame()

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Returns:

the first stage of the addVideoFrame call

addVideoFrame

public void addVideoFrame(String teamName, String reviewId, AddVideoFrameOptionalParameter addVideoFrameOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
addVideoFrameOptionalParameter - the object representing the optional parameters to be set before calling this API

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addVideoFrameAsync

public Observable addVideoFrameAsync(String teamName, String reviewId, AddVideoFrameOptionalParameter addVideoFrameOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
addVideoFrameOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addVideoFrameStream

public ReviewsAddVideoFrameStreamDefinitionStages.WithTeamName addVideoFrameStream()

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.

Returns:

the first stage of the addVideoFrameStream call

addVideoFrameStream

public void addVideoFrameStream(String teamName, String reviewId, String contentType, byte[] frameImageZip, String frameMetadata, AddVideoFrameStreamOptionalParameter addVideoFrameStreamOptionalParameter)

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
contentType - The content type.
frameImageZip - Zip file containing frame images.
frameMetadata - Metadata of the frame.
addVideoFrameStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addVideoFrameStreamAsync

public Observable addVideoFrameStreamAsync(String teamName, String reviewId, String contentType, byte[] frameImageZip, String frameMetadata, AddVideoFrameStreamOptionalParameter addVideoFrameStreamOptionalParameter)

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
contentType - The content type.
frameImageZip - Zip file containing frame images.
frameMetadata - Metadata of the frame.
addVideoFrameStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addVideoFrameUrl

public ReviewsAddVideoFrameUrlDefinitionStages.WithTeamName addVideoFrameUrl()

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.

Returns:

the first stage of the addVideoFrameUrl call

addVideoFrameUrl

public void addVideoFrameUrl(String teamName, String reviewId, String contentType, List videoFrameBody, AddVideoFrameUrlOptionalParameter addVideoFrameUrlOptionalParameter)

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
contentType - The content type.
videoFrameBody - Body for add video frames API.
addVideoFrameUrlOptionalParameter - the object representing the optional parameters to be set before calling this API

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addVideoFrameUrlAsync

public Observable addVideoFrameUrlAsync(String teamName, String reviewId, String contentType, List videoFrameBody, AddVideoFrameUrlOptionalParameter addVideoFrameUrlOptionalParameter)

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp 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.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
contentType - The content type.
videoFrameBody - Body for add video frames API.
addVideoFrameUrlOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addVideoTranscript

public void addVideoTranscript(String teamName, String reviewId, byte[] vTTfile)

This API adds a transcript file (text version of all the words spoken in a video) to a video review. The file should be a valid WebVTT format.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
vTTfile - Transcript file of the video.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addVideoTranscriptAsync

public Observable addVideoTranscriptAsync(String teamName, String reviewId, byte[] vTTfile)

This API adds a transcript file (text version of all the words spoken in a video) to a video review. The file should be a valid WebVTT format.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
vTTfile - Transcript file of the video.

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addVideoTranscriptModerationResult

public void addVideoTranscriptModerationResult(String teamName, String reviewId, String contentType, List transcriptModerationBody)

This API adds a transcript screen text result file for a video review. Transcript screen text result file is a result of Screen Text API . In order to generate transcript screen text result file , a transcript file has to be screened for profanity using Screen Text API.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
contentType - The content type.
transcriptModerationBody - Body for add video transcript moderation result API.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addVideoTranscriptModerationResultAsync

public Observable addVideoTranscriptModerationResultAsync(String teamName, String reviewId, String contentType, List transcriptModerationBody)

This API adds a transcript screen text result file for a video review. Transcript screen text result file is a result of Screen Text API . In order to generate transcript screen text result file , a transcript file has to be screened for profanity using Screen Text API.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
contentType - The content type.
transcriptModerationBody - Body for add video transcript moderation result API.

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createJob

public ReviewsCreateJobDefinitionStages.WithTeamName createJob()

A job Id will be returned for the content posted on this endpoint. Once the content is evaluated against the Workflow provided the review will be created or ignored based on the workflow expression. <h3>CallBack Schemas </h3> <p> <h4>Job Completion CallBack Sample</h4><br/> {<br/> "JobId": "&lt;Job Id&gt;,&lt;br/&gt;

"ReviewId": "<Review Id, if the Job resulted in a Review to be created>",&lt;br/&gt;

"WorkFlowId": "default",&lt;br/&gt;

"Status": "<This will be one of Complete, InProgress, Error>",&lt;br/&gt;

"ContentType": "Image",&lt;br/&gt;

"ContentId": "<This is the ContentId that was specified on input>",&lt;br/&gt;

"CallBackType": "Job",&lt;br/&gt;

"Metadata": {&lt;br/&gt;

"adultscore": "0.xxx",&lt;br/&gt;

"a": "False",&lt;br/&gt;

"racyscore": "0.xxx",&lt;br/&gt;

"r": "True"<br/> }<br/> }<br/> </p> <p> <h4>Review Completion CallBack Sample</h4><br/> { "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx", "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Returns:

the first stage of the createJob call

createJob

public JobId createJob(String teamName, String contentType, String contentId, String workflowName, String jobContentType, String contentValue, CreateJobOptionalParameter createJobOptionalParameter)

A job Id will be returned for the content posted on this endpoint. Once the content is evaluated against the Workflow provided the review will be created or ignored based on the workflow expression. <h3>CallBack Schemas </h3> <p> <h4>Job Completion CallBack Sample</h4><br/> {<br/> "JobId": "&lt;Job Id&gt;,&lt;br/&gt;

"ReviewId": "<Review Id, if the Job resulted in a Review to be created>",&lt;br/&gt;

"WorkFlowId": "default",&lt;br/&gt;

"Status": "<This will be one of Complete, InProgress, Error>",&lt;br/&gt;

"ContentType": "Image",&lt;br/&gt;

"ContentId": "<This is the ContentId that was specified on input>",&lt;br/&gt;

"CallBackType": "Job",&lt;br/&gt;

"Metadata": {&lt;br/&gt;

"adultscore": "0.xxx",&lt;br/&gt;

"a": "False",&lt;br/&gt;

"racyscore": "0.xxx",&lt;br/&gt;

"r": "True"<br/> }<br/> }<br/> </p> <p> <h4>Review Completion CallBack Sample</h4><br/> { "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx", "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Parameters:

teamName - Your team name.
contentType - Image, Text or Video. Possible values include: 'Image', 'Text', 'Video'.
contentId - Id/Name to identify the content submitted.
workflowName - Workflow Name that you want to invoke.
jobContentType - The content type. Possible values include: 'application/json', 'image/jpeg'.
contentValue - Content to evaluate for a job.
createJobOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the JobId object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createJobAsync

public Observable createJobAsync(String teamName, String contentType, String contentId, String workflowName, String jobContentType, String contentValue, CreateJobOptionalParameter createJobOptionalParameter)

A job Id will be returned for the content posted on this endpoint. Once the content is evaluated against the Workflow provided the review will be created or ignored based on the workflow expression. <h3>CallBack Schemas </h3> <p> <h4>Job Completion CallBack Sample</h4><br/> {<br/> "JobId": "&lt;Job Id&gt;,&lt;br/&gt;

"ReviewId": "<Review Id, if the Job resulted in a Review to be created>",&lt;br/&gt;

"WorkFlowId": "default",&lt;br/&gt;

"Status": "<This will be one of Complete, InProgress, Error>",&lt;br/&gt;

"ContentType": "Image",&lt;br/&gt;

"ContentId": "<This is the ContentId that was specified on input>",&lt;br/&gt;

"CallBackType": "Job",&lt;br/&gt;

"Metadata": {&lt;br/&gt;

"adultscore": "0.xxx",&lt;br/&gt;

"a": "False",&lt;br/&gt;

"racyscore": "0.xxx",&lt;br/&gt;

"r": "True"<br/> }<br/> }<br/> </p> <p> <h4>Review Completion CallBack Sample</h4><br/> { "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx", "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Parameters:

teamName - Your team name.
contentType - Image, Text or Video. Possible values include: 'Image', 'Text', 'Video'.
contentId - Id/Name to identify the content submitted.
workflowName - Workflow Name that you want to invoke.
jobContentType - The content type. Possible values include: 'application/json', 'image/jpeg'.
contentValue - Content to evaluate for a job.
createJobOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the JobId object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createReviews

public ReviewsCreateReviewsDefinitionStages.WithTeamName createReviews()

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Returns:

the first stage of the createReviews call

createReviews

public List createReviews(String teamName, String urlContentType, List createReviewBody, CreateReviewsOptionalParameter createReviewsOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Parameters:

teamName - Your team name.
urlContentType - The content type.
createReviewBody - Body for create reviews API.
createReviewsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<String> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createReviewsAsync

public Observable> createReviewsAsync(String teamName, String urlContentType, List createReviewBody, CreateReviewsOptionalParameter createReviewsOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Parameters:

teamName - Your team name.
urlContentType - The content type.
createReviewBody - Body for create reviews API.
createReviewsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<String> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createVideoReviews

public ReviewsCreateVideoReviewsDefinitionStages.WithTeamName createVideoReviews()

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Returns:

the first stage of the createVideoReviews call

createVideoReviews

public List createVideoReviews(String teamName, String contentType, List createVideoReviewsBody, CreateVideoReviewsOptionalParameter createVideoReviewsOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Parameters:

teamName - Your team name.
contentType - The content type.
createVideoReviewsBody - Body for create reviews API.
createVideoReviewsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<String> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createVideoReviewsAsync

public Observable> createVideoReviewsAsync(String teamName, String contentType, List createVideoReviewsBody, CreateVideoReviewsOptionalParameter createVideoReviewsOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Parameters:

teamName - Your team name.
contentType - The content type.
createVideoReviewsBody - Body for create reviews API.
createVideoReviewsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<String> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getJobDetails

public Job getJobDetails(String teamName, String jobId)

Get the Job Details for a Job Id.

Parameters:

teamName - Your Team Name.
jobId - Id of the job.

Returns:

the Job object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getJobDetailsAsync

public Observable getJobDetailsAsync(String teamName, String jobId)

Get the Job Details for a Job Id.

Parameters:

teamName - Your Team Name.
jobId - Id of the job.

Returns:

the observable to the Job object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getReview

public Review getReview(String teamName, String reviewId)

Returns review details for the review Id passed.

Parameters:

teamName - Your Team Name.
reviewId - Id of the review.

Returns:

the Review object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getReviewAsync

public Observable getReviewAsync(String teamName, String reviewId)

Returns review details for the review Id passed.

Parameters:

teamName - Your Team Name.
reviewId - Id of the review.

Returns:

the observable to the Review object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getVideoFrames

public ReviewsGetVideoFramesDefinitionStages.WithTeamName getVideoFrames()

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Returns:

the first stage of the getVideoFrames call

getVideoFrames

public Frames getVideoFrames(String teamName, String reviewId, GetVideoFramesOptionalParameter getVideoFramesOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
getVideoFramesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the Frames object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getVideoFramesAsync

public Observable getVideoFramesAsync(String teamName, String reviewId, GetVideoFramesOptionalParameter getVideoFramesOptionalParameter)

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "&lt;Review Id&gt;",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "&lt;Name of the Reviewer&gt;",<br/> "CallBackType": "Review",<br/> "ContentId": "&lt;The ContentId that was specified input&gt;",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>.

Parameters:

teamName - Your team name.
reviewId - Id of the review.
getVideoFramesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the Frames object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

publishVideoReview

public void publishVideoReview(String teamName, String reviewId)

Publish video review to make it available for review.

Parameters:

teamName - Your team name.
reviewId - Id of the review.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
APIErrorException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

publishVideoReviewAsync

public Observable publishVideoReviewAsync(String teamName, String reviewId)

Publish video review to make it available for review.

Parameters:

teamName - Your team name.
reviewId - Id of the review.

Returns:

a representation of the deferred computation of this call if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

Applies to