One Logo Pool Ball
NowPlaying · IOS API REFERENCE

HomeMediaContent

struct · iOS 27.0+ · SDK 27.1

struct HomeMediaContent

Content representing home media or ambient content. Use this type for home-related media such as security camera feeds, baby monitors, or ambient soundscapes.

Members (15)

get · iOS 27.0+

isExplicit

TypeScript
get isExplicit(): (boolean) | null
Swift declaration
var isExplicit: Bool?

A Boolean value that indicates whether this content is explicit.

set · iOS 27.0+

isExplicit

TypeScript
set isExplicit(value: (boolean) | null)
Swift declaration
var isExplicit: Bool?

A Boolean value that indicates whether this content is explicit.

get · iOS 27.0+

sourceName

TypeScript
get sourceName(): string
Swift declaration
let sourceName: String

The name of the home media source or device.

get · iOS 27.0+

animatedArtwork

TypeScript
get animatedArtwork(): (AnimatedArtwork) | null
Swift declaration
let animatedArtwork: AnimatedArtwork?

Animated artwork for this content.

get · iOS 27.0+

contentDescription

TypeScript
get contentDescription(): (string) | null
Swift declaration
let contentDescription: String?

A description of the content, if available.

get · iOS 27.0+

isExcludedFromSuggestions

TypeScript
get isExcludedFromSuggestions(): (boolean) | null
Swift declaration
var isExcludedFromSuggestions: Bool?

A Boolean value that indicates whether to exclude this content from media suggestions. Defaults to `false`.

set · iOS 27.0+

isExcludedFromSuggestions

TypeScript
set isExcludedFromSuggestions(value: (boolean) | null)
Swift declaration
var isExcludedFromSuggestions: Bool?

A Boolean value that indicates whether to exclude this content from media suggestions. Defaults to `false`.

init · iOS 27.0+

init

TypeScript
static initIdSourceNameContentDescriptionTypeDurationArtworkAnimatedArtwork(id: string, sourceName: string, contentDescription: (string) | null, type: MediaType, duration: (MediaDuration) | null, artwork: Artwork, animatedArtwork?: (AnimatedArtwork) | null): HomeMediaContent
Swift declaration
init(id: String, sourceName: String, contentDescription: String?, type: MediaType, duration: MediaDuration?, artwork: Artwork, animatedArtwork: AnimatedArtwork?)

Creates home media content with static and animated artwork. - Parameters: - id: A unique identifier for this content. - sourceName: The display name of the device or source providing the media. - contentDescription: A short description of the content, or `nil` when unavailable. - type: The media type. - duration: The total duration, or `nil` when live or unknown. - artwork: Static artwork for the content. - animatedArtwork: Animated artwork for the content, or `nil` when unavailable.

init · iOS 27.0+

init

TypeScript
static initIdSourceNameContentDescriptionTypeDurationArtwork(id: string, sourceName: string, contentDescription: (string) | null, type: MediaType, duration?: (MediaDuration) | null, artwork?: (Artwork) | null): HomeMediaContent
Swift declaration
init(id: String, sourceName: String, contentDescription: String?, type: MediaType, duration: MediaDuration?, artwork: Artwork?)

Creates home media content. - Parameters: - id: A unique identifier for this content. - sourceName: The display name of the device or source providing the media. - contentDescription: A short description of the content, or `nil` when unavailable. - type: The media type. - duration: The total duration, or `nil` when live or unknown. - artwork: Artwork for the content, or `nil` when unavailable.

get · iOS 27.0+

id

TypeScript
get id(): string
Swift declaration
let id: String

The unique identifier for this content.

get · iOS 27.0+

type

TypeScript
get type(): MediaType
Swift declaration
let type: MediaType

The media type (audio or video).

get · iOS 27.0+

genre

TypeScript
get genre(): (string) | null
Swift declaration
var genre: String?

The genre of this content.

set · iOS 27.0+

genre

TypeScript
set genre(value: (string) | null)
Swift declaration
var genre: String?

The genre of this content.

get · iOS 27.0+

artwork

TypeScript
get artwork(): (Artwork) | null
Swift declaration
let artwork: Artwork?

Artwork for this content.

get · iOS 27.0+

duration

TypeScript
get duration(): (MediaDuration) | null
Swift declaration
let duration: MediaDuration?

The duration of this content.

Skipped declarations

No declarations were skipped in this snapshot.

All NowPlaying types →