One Logo Pool Ball
HomeKit · IOS API REFERENCE

HMMediaSourceDisplayOrderProfile

class · iOS 18.0+ · SDK 27.1

@objc class HMMediaSourceDisplayOrderProfile

@abstract Represents media source display ordering functionality for an HMServiceTypeTelevision service that is contained in the services array for this profile. @discussion Provides an interface to read and, if allowed by the accessory, update the ordering of input sources.

Members (5)

method · iOS 18.0+

writeOrder

TypeScript
writeOrder(order: Array<number>): Promise<void>
Swift declaration
func writeOrder(_ order: [Int]) async throws

@abstract Writes the display order of the media sources to the accessory. @param order The new display order for the media sources. The media source entries are the HMCharacteristicTypeIdentifier values for HMServiceTypeInputSource services in the set of services associated with this profile. @returns An error will be thrown if the source ordering fails to be written to the accessory.

get · iOS 18.0+

canModifyOrder

TypeScript
get canModifyOrder(): boolean
Swift declaration
final let canModifyOrder: Bool

@brief Indicates if the display order of input media sources can be modified.

get · iOS 18.0+

order

TypeScript
get order(): Array<number>
Swift declaration
var order: [Int] { get }

@brief Display order of input media sources. @discussion The entries are the HMCharacteristicTypeIdentifier values for HMServiceTypeInputSource services in the set of services associated with this profile.

get · iOS 18.0+

delegate

TypeScript
get delegate(): (SDKHandle) | null
Swift declaration
weak var delegate: (any HMMediaSourceDisplayOrderProfile.Delegate)?
set · iOS 18.0+

delegate

TypeScript
set delegate(value: (Implements<HMMediaSourceDisplayOrderProfile_Delegate> | SDKHandle) | null)
Swift declaration
weak var delegate: (any HMMediaSourceDisplayOrderProfile.Delegate)?

Skipped declarations

No declarations were skipped in this snapshot.

All HomeKit types →