@twick/timeline 0.14.2 → 0.14.3

package/dist/core/visitor/element-adder.d.ts

@@ -10,20 +10,140 @@ import { RectElement } from '../elements/rect.element';
 import { Track } from '../track/track';
 
 /**
- * ElementAdder visitor for adding elements to tracks
+ * ElementAdder visitor for adding elements to tracks.
  * Uses the visitor pattern to handle different element types
- * Implements the Friend Class Pattern for explicit access control
+ * and implements the Friend Class Pattern for explicit access control.
+ * Automatically calculates start and end times for elements based on
+ * existing track content.
  */
 export declare class ElementAdder implements ElementVisitor<Promise<boolean>> {
     private track;
     private trackFriend;
+    /**
+     * Creates a new ElementAdder instance for the specified track.
+     *
+     * @param track - The track to add elements to
+     *
+     * @example
+     * ```js
+     * const adder = new ElementAdder(track);
+     * const success = await adder.visitVideoElement(videoElement);
+     * ```
+     */
     constructor(track: Track);
+    /**
+     * Adds a video element to the track.
+     * Updates video metadata and calculates appropriate start/end times
+     * based on existing track elements.
+     *
+     * @param element - The video element to add
+     * @returns Promise resolving to true if element was added successfully
+     *
+     * @example
+     * ```js
+     * const success = await adder.visitVideoElement(videoElement);
+     * // success = true if element was added successfully
+     * ```
+     */
     visitVideoElement(element: VideoElement): Promise<boolean>;
+    /**
+     * Adds an audio element to the track.
+     * Updates audio metadata and calculates appropriate start/end times
+     * based on existing track elements.
+     *
+     * @param element - The audio element to add
+     * @returns Promise resolving to true if element was added successfully
+     *
+     * @example
+     * ```js
+     * const success = await adder.visitAudioElement(audioElement);
+     * // success = true if element was added successfully
+     * ```
+     */
     visitAudioElement(element: AudioElement): Promise<boolean>;
+    /**
+     * Adds an image element to the track.
+     * Updates image metadata and calculates appropriate start/end times
+     * based on existing track elements.
+     *
+     * @param element - The image element to add
+     * @returns Promise resolving to true if element was added successfully
+     *
+     * @example
+     * ```js
+     * const success = await adder.visitImageElement(imageElement);
+     * // success = true if element was added successfully
+     * ```
+     */
     visitImageElement(element: ImageElement): Promise<boolean>;
+    /**
+     * Adds a text element to the track.
+     * Calculates appropriate start/end times based on existing track elements.
+     *
+     * @param element - The text element to add
+     * @returns Promise resolving to true if element was added successfully
+     *
+     * @example
+     * ```js
+     * const success = await adder.visitTextElement(textElement);
+     * // success = true if element was added successfully
+     * ```
+     */
     visitTextElement(element: TextElement): Promise<boolean>;
+    /**
+     * Adds a caption element to the track.
+     * Calculates appropriate start/end times based on existing track elements.
+     *
+     * @param element - The caption element to add
+     * @returns Promise resolving to true if element was added successfully
+     *
+     * @example
+     * ```js
+     * const success = await adder.visitCaptionElement(captionElement);
+     * // success = true if element was added successfully
+     * ```
+     */
     visitCaptionElement(element: CaptionElement): Promise<boolean>;
+    /**
+     * Adds an icon element to the track.
+     * Calculates appropriate start/end times based on existing track elements.
+     *
+     * @param element - The icon element to add
+     * @returns Promise resolving to true if element was added successfully
+     *
+     * @example
+     * ```js
+     * const success = await adder.visitIconElement(iconElement);
+     * // success = true if element was added successfully
+     * ```
+     */
     visitIconElement(element: IconElement): Promise<boolean>;
+    /**
+     * Adds a circle element to the track.
+     * Calculates appropriate start/end times based on existing track elements.
+     *
+     * @param element - The circle element to add
+     * @returns Promise resolving to true if element was added successfully
+     *
+     * @example
+     * ```js
+     * const success = await adder.visitCircleElement(circleElement);
+     * // success = true if element was added successfully
+     * ```
+     */
     visitCircleElement(element: CircleElement): Promise<boolean>;
+    /**
+     * Adds a rectangle element to the track.
+     * Calculates appropriate start/end times based on existing track elements.
+     *
+     * @param element - The rectangle element to add
+     * @returns Promise resolving to true if element was added successfully
+     *
+     * @example
+     * ```js
+     * const success = await adder.visitRectElement(rectElement);
+     * // success = true if element was added successfully
+     * ```
+     */
     visitRectElement(element: RectElement): Promise<boolean>;
 }