<!--
{
  "availability" : [
    "iOS: 9.1.0 -",
    "iPadOS: 9.1.0 -",
    "macCatalyst: 13.1.0 -",
    "tvOS: 10.0.0 -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "PhotoKit",
  "identifier" : "/documentation/PhotosUI/PHLivePhotoView/livePhotoBadgeImage(options:)",
  "metadataVersion" : "0.1.0",
  "role" : "Type Method",
  "symbol" : {
    "kind" : "Type Method",
    "modules" : [
      "PhotosUI"
    ],
    "preciseIdentifier" : "c:objc(cs)PHLivePhotoView(cm)livePhotoBadgeImageWithOptions:"
  },
  "title" : "livePhotoBadgeImage(options:)"
}
-->

# livePhotoBadgeImage(options:)

Returns an icon image for the specified Live Photo semantic options.

```
class func livePhotoBadgeImage(options badgeOptions: PHLivePhotoBadgeOptions = []) -> UIImage
```

## Parameters

`badgeOptions`

A set of options identifying the semantic context for a Live Photo indicator to be used in your app’s user interface. See [`PHLivePhotoBadgeOptions`](/documentation/PhotosUI/PHLivePhotoBadgeOptions).

## Return Value

The icon image for the specified options.

## Discussion

Use this method to obtain icon images for use in interface elements that complement Live Photos. For example, you can use icons obtained from this method in a custom asset browser UI to indicate which assets are Live Photos as opposed to normal still photos, or to indicate when the user has chosen to share a Live Photo with or without its motion and sound content.

By default, this method returns a solid-color image suitable for use as a template image that you can tint for display against a specific background. (Use the <doc://com.apple.documentation/documentation/UIKit/UIImage> class to create template images.) When you plan to overlay the icon over animating Live Photo content, add the [`overContent`](/documentation/PhotosUI/PHLivePhotoBadgeOptions/overContent) option to obtain an image (not suitable for template use) that provides extra background contrast.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)