Class CompanionDiscoveryResult

Namespace

AppleTvControlLibrary.Discovery.Companion

Assembly

AppleTvControlLibrary.Discovery.dll

Represents a discovered Companion Link service.

public sealed class CompanionDiscoveryResult

Inheritance

object

CompanionDiscoveryResult

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Remarks

Initializes a new instance of the CompanionDiscoveryResult class.

Constructors

CompanionDiscoveryResult(string, IPAddress?, int, string?, CompanionPairingRequirement, IReadOnlyDictionary<string, string>)

Represents a discovered Companion Link service.

public CompanionDiscoveryResult(string name, IPAddress? address, int port, string? uniqueId, CompanionPairingRequirement pairingRequirement, IReadOnlyDictionary<string, string> properties)

Parameters

name string

address IPAddress

port int

uniqueId string

pairingRequirement CompanionPairingRequirement

properties IReadOnlyDictionary<string, string>

Remarks

Initializes a new instance of the CompanionDiscoveryResult class.

Properties

Address

Gets the resolved address of the device, if known.

public IPAddress? Address { get; }

Property Value

IPAddress

Name

Gets the mDNS service instance name (e.g. "Living Room").

public string Name { get; }

Property Value

string

PairingRequirement

Gets whether/how pairing is required for this device.

public CompanionPairingRequirement PairingRequirement { get; }

Property Value

CompanionPairingRequirement

Port

Gets the Companion Link port.

public int Port { get; }

Property Value

int

Properties

Gets the raw decoded TXT record properties.

public IReadOnlyDictionary<string, string> Properties { get; }

Property Value

IReadOnlyDictionary<string, string>

UniqueId

Gets a stable unique identifier for the device (the "rpmrtid" TXT record), or null if not present.

public string? UniqueId { get; }

Property Value

string

Remarks

Only "rpmrtid" is safe to persist as an identifier. Do not key persisted credentials off other TXT records such as "rpHA", "rpHN", "rpAD", "rpHI", or "rpBA" - pyatv observes that those rotate as a privacy measure.