<!--
{
  "availability" : [
    "iOS: 15.0.0 -",
    "iPadOS: 15.0.0 -",
    "macCatalyst: 15.0.0 -",
    "macOS: 12.0.0 -",
    "tvOS: 15.0.0 -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "GroupActivities",
  "identifier" : "/documentation/GroupActivities/GroupActivityMetadata",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Group Activities"
    ],
    "preciseIdentifier" : "s:15GroupActivities0A16ActivityMetadataV"
  },
  "title" : "GroupActivityMetadata"
}
-->

# GroupActivityMetadata

Text and image content that describes an activity to potential participants.

```
struct GroupActivityMetadata
```

## Overview

Use a `GroupActivityMetadata` structure to store user-facing information about a
specific activity your app suggests. Metadata information includes the title of the
activity, an image that corresponds to the activity, and a fallback URL
for users who don’t have your app. For example, a movie-watching activity might
include the poster of the specific movie a participant suggests. The
system uses the provided metadata to generate invitations for other participants.

Create a `GroupActivityMetadata` structure in the [`metadata`](/documentation/GroupActivities/GroupActivity/metadata) property of your custom
[`GroupActivity`](/documentation/GroupActivities/GroupActivity) subclass. Populate the new structure with the relevant data for your
activity.

## Topics

### Creating group activity metadata

[`init()`](/documentation/GroupActivities/GroupActivityMetadata/init())

Creates a new instance for storing descriptive information about an activity.

### Presenting the activity

[`title`](/documentation/GroupActivities/GroupActivityMetadata/title)

The localized string to display as the title of your activity.

[`subtitle`](/documentation/GroupActivities/GroupActivityMetadata/subtitle)

The localized string that provides additional information about the activity.

[`previewImage`](/documentation/GroupActivities/GroupActivityMetadata/previewImage)

The image to display for the current activity.

[`fallbackURL`](/documentation/GroupActivities/GroupActivityMetadata/fallbackURL)

A URL that offers participants a way to identify or join the activity
from a web browser.

### Indicating the activity’s type

[`type`](/documentation/GroupActivities/GroupActivityMetadata/type)

The type of shared experience.

[`GroupActivityMetadata.ActivityType`](/documentation/GroupActivities/GroupActivityMetadata/ActivityType)

Constants that indicate the group activity’s type to the system.

### Assigning an app-specific scene

[`sceneAssociationBehavior`](/documentation/GroupActivities/GroupActivityMetadata/sceneAssociationBehavior)

Criteria the system uses to direct an activity to a specific scene
of your app.

[`SceneAssociationBehavior`](/documentation/GroupActivities/SceneAssociationBehavior)

A type that tells the system which scene to associate with an incoming
group activity.

### Specifying media-related behavior

[`supportsContinuationOnTV`](/documentation/GroupActivities/GroupActivityMetadata/supportsContinuationOnTV)

A Boolean value that indicates whether your app supports activity continuation on an Apple TV.

[`preferredBroadcastOptions`](/documentation/GroupActivities/GroupActivityMetadata/preferredBroadcastOptions)

Preferences for how to present audio and video on the main communication channel.

[`BroadcastOptions`](/documentation/GroupActivities/BroadcastOptions)

Options for how to broadcast media on the shared communications channel.

### Comparing metadata objects

### Encoding the metadata


---

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)