Class Stop

Namespace

Harp.SoundCard

Assembly

Harp.SoundCard.dll

Represents a register that any value will stop the current sound.

public class Stop

Inheritance

object

Stop

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 Stop register. This field is constant.

public const int Address = 33

Field Value

int

RegisterLength

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

public const int RegisterLength = 1

Field Value

int

RegisterType

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

public const PayloadType RegisterType = U8

Field Value

PayloadType

Methods

FromPayload(MessageType, byte)

Returns a Harp message for the Stop register.

public static HarpMessage FromPayload(MessageType messageType, byte value)

Parameters

messageType MessageType

The type of the Harp message.

value byte

The value to be stored in the message payload.

Returns

HarpMessage

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

FromPayload(double, MessageType, byte)

Returns a timestamped Harp message for the Stop register.

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

Parameters

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

value byte

The value to be stored in the message payload.

Returns

HarpMessage

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

GetPayload(HarpMessage)

Returns the payload data for Stop register messages.

public static byte GetPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

byte

A value representing the message payload.

GetTimestampedPayload(HarpMessage)

Returns the timestamped payload data for Stop register messages.

public static Timestamped<byte> GetTimestampedPayload(HarpMessage message)

Parameters

message HarpMessage

A HarpMessage object representing the register message.

Returns

Timestamped<byte>

A value representing the timestamped message payload.