Class Announce

constructor

• new Announce(
      requestId: bigint,
      trackNamespace: Tuple,
      parameters: KeyValuePair[],
  ): Announce

  Constructs an Announce message.

  Parameters

  • requestId: bigint

    The request ID for this announce message.
  • trackNamespace: Tuple

    The track namespace as a Tuple.
  • parameters: KeyValuePair[]

    The list of key-value parameters for the track.

  Returns Announce

Readonlyparameters

ReadonlyrequestId

ReadonlytrackNamespace

getType

• getType(): ControlMessageType

  Gets the message type for this Announce message.

  Returns ControlMessageType

  The ControlMessageType.Announce value.

serialize

• serialize(): FrozenByteBuffer

  Serializes the Announce message into a FrozenByteBuffer.

  Returns FrozenByteBuffer

  The serialized buffer.

  Throws

  :LengthExceedsMaxError If the payload exceeds 65535 bytes.

StaticparsePayload

• parsePayload(buf: BaseByteBuffer): Announce

  Parses an Announce message from the given buffer.

  Parameters

  • buf: BaseByteBuffer

    The buffer to parse from.

  Returns Announce

  The parsed Announce message.

  Throws

  :NotEnoughBytesError If the buffer does not contain enough bytes.