Class AttenuationRight

Namespace

Harp.SoundCard

Assembly

Harp.SoundCard.dll

Represents a register that configure right channel's attenuation (1 LSB is 0.1dB).

public class AttenuationRight

Inheritance

object

AttenuationRight

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Fields

Address

Represents the address of the AttenuationRight register. This field is constant.

public const int Address = 35

Field Value

int

RegisterLength

Represents the length of the AttenuationRight register. This field is constant.

public const int RegisterLength = 1

Field Value

int

RegisterType

Represents the payload type of the AttenuationRight register. This field is constant.

public const PayloadType RegisterType = U16

Field Value

PayloadType

Methods

FromPayload(MessageType, ushort)

Returns a Harp message for the AttenuationRight register.

public static HarpMessage FromPayload(MessageType messageType, ushort value)

Parameters

messageType MessageType

The type of the Harp message.

value ushort

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the AttenuationRight register with the specified message type and payload.

FromPayload(double, MessageType, ushort)

Returns a timestamped Harp message for the AttenuationRight register.

public static HarpMessage FromPayload(double timestamp, MessageType messageType, ushort value)

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value ushort

The value to be stored in the message payload.

Returns

HarpMessage

A HarpMessage object for the AttenuationRight register with the specified message type, timestamp, and payload.

GetPayload(HarpMessage)

Returns the payload data for AttenuationRight register messages.

public static ushort GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

ushort

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for AttenuationRight register messages.

public static Timestamped<ushort> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<ushort>

A value representing the timestamped message payload.