Class: MoqtObject
Properties
fullTrackName
readonlyfullTrackName:FullTrackName
location
readonlylocation:Location
objectForwardingPreference
readonlyobjectForwardingPreference:ObjectForwardingPreference
objectStatus
readonlyobjectStatus:ObjectStatus
payload
readonlypayload:Uint8Array<ArrayBufferLike> |null
properties
readonlyproperties:KeyValuePair[] |null
publisherPriority
readonlypublisherPriority:number
subgroupId
readonlysubgroupId: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
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
tryIntoFetchObject()
tryIntoFetchObject():
FetchObject
Returns
tryIntoSubgroupObject()
tryIntoSubgroupObject():
SubgroupObject
Returns
fromDatagram()
staticfromDatagram(datagram,fullTrackName,defaultPriority?):MoqtObject
Create a MoqtObject from a Datagram.
Parameters
datagram
The received Datagram.
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()
staticfromFetchObject(fetchObject,fullTrackName):MoqtObject
Parameters
fetchObject
fullTrackName
Returns
MoqtObject
fromSubgroupObject()
staticfromSubgroupObject(subgroupObject,groupId,publisherPriority,subgroupId,fullTrackName):MoqtObject
Parameters
subgroupObject
groupId
number | bigint
publisherPriority
number | undefined
subgroupId
number | bigint | null
fullTrackName
Returns
MoqtObject
isDatagramEndOfGroup()
staticisDatagramEndOfGroup(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
Returns
boolean
newWithPayload()
staticnewWithPayload(fullTrackName,location,publisherPriority,objectForwardingPreference,subgroupId,properties,payload):MoqtObject
Parameters
fullTrackName
location
publisherPriority
number
objectForwardingPreference
subgroupId
number | bigint | null
properties
KeyValuePair[] | null
payload
Uint8Array
Returns
MoqtObject
newWithStatus()
staticnewWithStatus(fullTrackName,location,publisherPriority,objectForwardingPreference,subgroupId,properties,objectStatus):MoqtObject
Parameters
fullTrackName
location
publisherPriority
number
objectForwardingPreference
subgroupId
number | bigint | null
properties
KeyValuePair[] | null
objectStatus
Returns
MoqtObject