Skip to content

Class: SendDatagramStream ​

Sends MoqtObjects as WebTransport datagrams. Parallel to SendStream but for datagram-based delivery.

Example ​

ts
const sender = await SendDatagramStream.new(client.webTransport.datagrams.writable, trackAlias);
await sender.write(moqtObject);

Constructors ​

Constructor ​

new SendDatagramStream(writer, trackAlias, events?): SendDatagramStream

Parameters ​

writer ​

WritableStreamDefaultWriter<Uint8Array<ArrayBufferLike>>

trackAlias ​

bigint

events? ​

Emitter<ClientEvents>

Returns ​

SendDatagramStream

Methods ​

close() ​

close(): Promise<void>

Close the datagram writer.

Returns ​

Promise<void>


releaseLock() ​

releaseLock(): void

Release the writer lock without closing.

Returns ​

void


write() ​

write(object): Promise<void>

Write a MoqtObject as a datagram. Converts to Datagram automatically based on object state.

Parameters ​

object ​

MoqtObject

MoqtObject to send (must have Datagram forwarding preference)

Returns ​

Promise<void>


fromWriter() ​

static fromWriter(writer, trackAlias, events?): SendDatagramStream

Create a datagram sender using an existing shared writer. Use this when multiple senders need to share a single writer.

Parameters ​

writer ​

WritableStreamDefaultWriter<Uint8Array<ArrayBufferLike>>

Existing WritableStreamDefaultWriter

trackAlias ​

bigint

Track alias for this datagram stream

events? ​

Emitter<ClientEvents>

Receives datagramsent for each datagram written

Returns ​

SendDatagramStream

SendDatagramStream instance


new() ​

static new(writeStream, trackAlias, events?): Promise<SendDatagramStream>

Create a new datagram sender for a specific track.

Parameters ​

writeStream ​

WritableStream<Uint8Array<ArrayBufferLike>>

WebTransport datagram writable stream

trackAlias ​

bigint

Track alias for this datagram stream

events? ​

Emitter<ClientEvents>

Receives datagramsent for each datagram written

Returns ​

Promise<SendDatagramStream>

SendDatagramStream instance