Table of Contents

Class AttenuationAndSoundIndexDI0

Namespace
Harp.SoundCard
Assembly
Harp.SoundCard.dll

Represents a register that sound index and attenuation to be played when triggering DI0 [Att R] [Att L] [Index].

public class AttenuationAndSoundIndexDI0
Inheritance
AttenuationAndSoundIndexDI0
Inherited Members

Fields

Address

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

public const int Address = 56

Field Value

int

RegisterLength

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

public const int RegisterLength = 3

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U16

Field Value

PayloadType

Methods

FromPayload(MessageType, ushort[])

Returns a Harp message for the AttenuationAndSoundIndexDI0 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 AttenuationAndSoundIndexDI0 register with the specified message type and payload.

FromPayload(double, MessageType, ushort[])

Returns a timestamped Harp message for the AttenuationAndSoundIndexDI0 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 AttenuationAndSoundIndexDI0 register with the specified message type, timestamp, and payload.

GetPayload(HarpMessage)

Returns the payload data for AttenuationAndSoundIndexDI0 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 AttenuationAndSoundIndexDI0 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.