Skip to content

Class: PublishNamespace ​

Represents a protocol PublishNamespace message, used to announce a track and its parameters.

Constructors ​

Constructor ​

new PublishNamespace(requestId, trackNamespace, parameters): PublishNamespace

Constructs a PublishNamespace message.

Parameters ​

requestId ​

bigint

The request ID for this publish namespace message.

trackNamespace ​

Tuple

The track namespace as a Tuple.

parameters ​

MessageParameter[]

The list of strongly-typed message parameters for the track.

Returns ​

PublishNamespace

Properties ​

parameters ​

readonly parameters: MessageParameter[]

The list of strongly-typed message parameters for the track.


requestId ​

readonly requestId: bigint

The request ID for this publish namespace message.


trackNamespace ​

readonly trackNamespace: Tuple

The track namespace as a Tuple.

Methods ​

getType() ​

getType(): ControlMessageType

Gets the message type for this PublishNamespace message.

Returns ​

ControlMessageType

The ControlMessageType.PublishNamespace value.


serialize() ​

serialize(): FrozenByteBuffer

Serializes the PublishNamespace message into a FrozenByteBuffer.

Returns ​

FrozenByteBuffer

The serialized buffer.

Throws ​

:LengthExceedsMaxError If the payload exceeds 65535 bytes.


parsePayload() ​

static parsePayload(buf): PublishNamespace

Parses a PublishNamespace message from the given buffer.

Parameters ​

buf ​

BaseByteBuffer

The buffer to parse from.

Returns ​

PublishNamespace

The parsed PublishNamespace message.

Throws ​

:NotEnoughBytesError If the buffer does not contain enough bytes.