Class SubscribePublication

constructor

• new SubscribePublication(
      client: MOQtailClient,
      track: Track,
      subscribeMsg: Subscribe,
      largestLocation?: Location,
  ): SubscribePublication

  Creates a new SubscribePublication instance.

  Parameters

  • client: MOQtailClient

    The MOQT client managing the subscription.
  • track: Track

    The track being published.
  • subscribeMsg: Subscribe

    The subscribe message containing subscription details.
  • OptionallargestLocation: Location

    The largest location seen so far, used for determining start location.

  Returns SubscribePublication

latestLocation

Readonlytrack

cancel

• cancel(): void

  Cancels the publication and cleans up resources. Removes the publication from the client's publication map.

  Returns void

done

• done(statusCode: SubscribeDoneStatusCode): Promise<void>

  Marks the publication as done and sends a SubscribeDone message to the client.

  Parameters

  • statusCode: SubscribeDoneStatusCode

    The status code indicating why the subscription ended.

  Returns Promise<void>

  Throws

  :InternalError If sending the message fails.

publish

• publish(): Promise<void>

  Publishes MOQT objects to the subscriber as they become available. Handles stream creation, object writing, and stream closure based on subscription parameters.

  Returns Promise<void>

  Throws

  :InternalError If the track does not support live content.

update

• update(msg: SubscribeUpdate): void

  Updates the subscription parameters and locations based on a SubscribeUpdate message.

  Parameters

  • msg: SubscribeUpdate

    The update message containing new subscription details.

  Returns void