---
url: https://docs.moqtail.dev/ts/api/model/classes/MoqtObject.md
---
# Class: MoqtObject

## Properties

### fullTrackName

> `readonly` **fullTrackName**: [`FullTrackName`](FullTrackName.md)

***

### location

> `readonly` **location**: [`Location`](Location.md)

***

### objectForwardingPreference

> `readonly` **objectForwardingPreference**: [`ObjectForwardingPreference`](../enumerations/ObjectForwardingPreference.md)

***

### objectStatus

> `readonly` **objectStatus**: [`ObjectStatus`](../enumerations/ObjectStatus.md)

***

### payload

> `readonly` **payload**: `Uint8Array`<`ArrayBufferLike`> | `null`

***

### properties

> `readonly` **properties**: [`KeyValuePair`](KeyValuePair.md)\[] | `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`](../enumerations/SubgroupHeaderType.md)

#### Parameters

##### containsEnd

`boolean`

##### useDefaultPriority?

`boolean` = `false`

##### firstObject?

`boolean` = `false`

#### Returns

[`SubgroupHeaderType`](../enumerations/SubgroupHeaderType.md)

***

### 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`](Datagram.md)

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`](Datagram.md)

***

### tryIntoFetchObject()

> **tryIntoFetchObject**(): [`FetchObject`](FetchObject.md)

#### Returns

[`FetchObject`](FetchObject.md)

***

### tryIntoSubgroupObject()

> **tryIntoSubgroupObject**(): [`SubgroupObject`](SubgroupObject.md)

#### Returns

[`SubgroupObject`](SubgroupObject.md)

***

### fromDatagram()

> `static` **fromDatagram**(`datagram`, `fullTrackName`, `defaultPriority?`): `MoqtObject`

Create a MoqtObject from a Datagram.

#### Parameters

##### datagram

[`Datagram`](Datagram.md)

The received Datagram.

##### fullTrackName

[`FullTrackName`](FullTrackName.md)

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`](FetchObject.md)

##### fullTrackName

[`FullTrackName`](FullTrackName.md)

#### Returns

`MoqtObject`

***

### fromSubgroupObject()

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

#### Parameters

##### subgroupObject

[`SubgroupObject`](SubgroupObject.md)

##### groupId

`number` | `bigint`

##### publisherPriority

`number` | `undefined`

##### subgroupId

`number` | `bigint` | `null`

##### fullTrackName

[`FullTrackName`](FullTrackName.md)

#### 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`](Datagram.md)

#### Returns

`boolean`

***

### newWithPayload()

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

#### Parameters

##### fullTrackName

[`FullTrackName`](FullTrackName.md)

##### location

[`Location`](Location.md)

##### publisherPriority

`number`

##### objectForwardingPreference

[`ObjectForwardingPreference`](../enumerations/ObjectForwardingPreference.md)

##### subgroupId

`number` | `bigint` | `null`

##### properties

[`KeyValuePair`](KeyValuePair.md)\[] | `null`

##### payload

`Uint8Array`

#### Returns

`MoqtObject`

***

### newWithStatus()

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

#### Parameters

##### fullTrackName

[`FullTrackName`](FullTrackName.md)

##### location

[`Location`](Location.md)

##### publisherPriority

`number`

##### objectForwardingPreference

[`ObjectForwardingPreference`](../enumerations/ObjectForwardingPreference.md)

##### subgroupId

`number` | `bigint` | `null`

##### properties

[`KeyValuePair`](KeyValuePair.md)\[] | `null`

##### objectStatus

[`ObjectStatus`](../enumerations/ObjectStatus.md)

#### Returns

`MoqtObject`
