Class AirPlayHapPairSetupProcedure

Namespace

AppleTvControlLibrary.Mrp.AirPlay.Auth

Assembly

AppleTvControlLibrary.Mrp.dll

Authenticate (pair-setup) a device for AirPlay playback. This is the procedure that must be run once, before any AirPlay pair-verify or MRP-over-AirPlay tunnel can be used, to obtain AirPlay-specific HapCredentials (distinct from, and not interchangeable with, MRP's own pairing/credentials, since they are separate services on separate ports).

public sealed class AirPlayHapPairSetupProcedure

Inheritance

object

AirPlayHapPairSetupProcedure

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 AirPlayHapPairSetupProcedure class.

Constructors

AirPlayHapPairSetupProcedure(HttpConnection, SrpAuthHandler)

Authenticate (pair-setup) a device for AirPlay playback. This is the procedure that must be run once, before any AirPlay pair-verify or MRP-over-AirPlay tunnel can be used, to obtain AirPlay-specific HapCredentials (distinct from, and not interchangeable with, MRP's own pairing/credentials, since they are separate services on separate ports).

public AirPlayHapPairSetupProcedure(HttpConnection http, SrpAuthHandler srp)

Parameters

http HttpConnection

The AirPlay control connection.

srp SrpAuthHandler

The SRP handler used for key agreement.

Remarks

Initializes a new instance of the AirPlayHapPairSetupProcedure class.

Methods

FinishPairingAsync(int, string?)

Finish the pairing process using the PIN shown on the device.

public Task<HapCredentials> FinishPairingAsync(int pinCode, string? displayName = null)

Parameters

pinCode int

The PIN code entered by the user.

displayName string

The client display name reported to the device, or null.

Returns

Task<HapCredentials>

The resulting credentials for the paired device.

StartPairingAsync()

Start the pairing process. Causes the device to display an on-screen PIN.

public Task StartPairingAsync()

Returns

Task