Skip to content

Class: MoqtObject ​

Properties ​

fullTrackName ​

readonly fullTrackName: FullTrackName


location ​

readonly location: Location


objectForwardingPreference ​

readonly objectForwardingPreference: ObjectForwardingPreference


objectStatus ​

readonly objectStatus: ObjectStatus


payload ​

readonly payload: Uint8Array<ArrayBufferLike> | null


properties ​

readonly properties: KeyValuePair[] | null


publisherPriority ​

readonly publisherPriority: number


subgroupId ​

readonly subgroupId: bigint | null

Accessors ​

groupId ​

Get Signature ​

get groupId(): bigint

Returns ​

bigint


objectId ​

Get Signature ​

get objectId(): bigint

Returns ​

bigint

Methods ​

getSubgroupHeaderType() ​

getSubgroupHeaderType(containsEnd, useDefaultPriority?, firstObject?): SubgroupHeaderType

Parameters ​

containsEnd ​

boolean

useDefaultPriority? ​

boolean = false

firstObject? ​

boolean = false

Returns ​

SubgroupHeaderType


hasPayload() ​

hasPayload(): boolean

Returns ​

boolean


hasStatus() ​

hasStatus(): boolean

Returns ​

boolean


isDatagram() ​

isDatagram(): boolean

Returns ​

boolean


isEndOfGroup() ​

isEndOfGroup(): boolean

Returns ​

boolean


isEndOfTrack() ​

isEndOfTrack(): boolean

Returns ​

boolean


isSubgroup() ​

isSubgroup(): boolean

Returns ​

boolean


tryIntoDatagram() ​

tryIntoDatagram(trackAlias, endOfGroup?, defaultPriority?): Datagram

Convert to Datagram for wire transmission. Automatically creates a payload or status Datagram based on the object's state.

Parameters ​

trackAlias ​

number | bigint

The track alias to use.

endOfGroup? ​

boolean = false

Whether this is the last object in the group (only for payload datagrams).

defaultPriority? ​

number

If provided and matches this object's priority, the DEFAULT_PRIORITY bit is set.

Returns ​

Datagram


tryIntoFetchObject() ​

tryIntoFetchObject(): FetchObject

Returns ​

FetchObject


tryIntoSubgroupObject() ​

tryIntoSubgroupObject(): SubgroupObject

Returns ​

SubgroupObject


fromDatagram() ​

static fromDatagram(datagram, fullTrackName, defaultPriority?): MoqtObject

Create a MoqtObject from a Datagram.

Parameters ​

datagram ​

Datagram

The received Datagram.

fullTrackName ​

FullTrackName

The resolved full track name.

defaultPriority? ​

number = 0

The default publisher priority from the control message (used when DEFAULT_PRIORITY bit is set).

Returns ​

MoqtObject


fromFetchObject() ​

static fromFetchObject(fetchObject, fullTrackName): MoqtObject

Parameters ​

fetchObject ​

FetchObject

fullTrackName ​

FullTrackName

Returns ​

MoqtObject


fromSubgroupObject() ​

static fromSubgroupObject(subgroupObject, groupId, publisherPriority, subgroupId, fullTrackName): MoqtObject

Parameters ​

subgroupObject ​

SubgroupObject

groupId ​

number | bigint

publisherPriority ​

number | undefined

subgroupId ​

number | bigint | null

fullTrackName ​

FullTrackName

Returns ​

MoqtObject


isDatagramEndOfGroup() ​

static isDatagramEndOfGroup(datagram): boolean

Returns the endOfGroup flag from the source Datagram. This is separate from ObjectStatus.EndOfGroup - the flag indicates this is the last object in the group even with Normal status.

Parameters ​

datagram ​

Datagram

Returns ​

boolean


newWithPayload() ​

static newWithPayload(fullTrackName, location, publisherPriority, objectForwardingPreference, subgroupId, properties, payload): MoqtObject

Parameters ​

fullTrackName ​

FullTrackName

location ​

Location

publisherPriority ​

number

objectForwardingPreference ​

ObjectForwardingPreference

subgroupId ​

number | bigint | null

properties ​

KeyValuePair[] | null

payload ​

Uint8Array

Returns ​

MoqtObject


newWithStatus() ​

static newWithStatus(fullTrackName, location, publisherPriority, objectForwardingPreference, subgroupId, properties, objectStatus): MoqtObject

Parameters ​

fullTrackName ​

FullTrackName

location ​

Location

publisherPriority ​

number

objectForwardingPreference ​

ObjectForwardingPreference

subgroupId ​

number | bigint | null

properties ​

KeyValuePair[] | null

objectStatus ​

ObjectStatus

Returns ​

MoqtObject