IStoredImageHandle.RateImage Method

Definition

Namespace: P1.CameraSdk

Change the star-rating of an image.

public void RateImage(StarRating rating);

All images can have an optional star-rating, to mark them as more or less significant. Use this method to change an image rating, or remove it.

Confirmation of a changed rating is provided by a notification. If you wish to receive this notification, you must listen for the EventType.CameraImageEdited notification, before calling this method. If the request fails, there is no notification.

To retrieve the existing star-rating of an image you should use the methods RequestBasicImageInfoAsync or its synchronous counter part BasicImageInfo(uint).

Parameters:

rating

The new rating to set on the image