renamed caption create method

Author: k9p5

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@diffusionstudio/core",
   "private": false,
-  "version": "1.0.0-beta.15",
+  "version": "1.0.0-rc.1",
   "type": "module",
   "description": "Build bleeding edge video processing applications",
   "files": [

src/clips/media/media.spec.ts

@@ -296,12 +296,11 @@ describe('The Media Clip', () => {
 		const composition = new Composition();
 		await composition.add(clip);
 
-		await clip.generateCaptions();
+		const track = await clip.generateCaptions();
 
 		expect(composition.tracks.length).toBe(2);
 
-		const track = composition.tracks[0];
-
+		expect(composition.tracks[0]).toBeInstanceOf(CaptionTrack);
 		expect(track).toBeInstanceOf(CaptionTrack);
 		expect(track.clips.length).toBe(36);
 		expect(track.clips[0]).toBeInstanceOf(TextClip);

src/clips/media/media.ts

@@ -14,7 +14,7 @@ import { replaceKeyframes } from '../clip/clip.utils';
 import { ValidationError } from '../../errors';
 import { Clip } from '../clip';
 
-import type { CaptionPresetStrategy, Track } from '../../tracks';
+import type { CaptionPresetStrategy, CaptionTrack, Track } from '../../tracks';
 import type { float, frame } from '../../types';
 import type { MediaClipProps } from './media.interfaces';
 
@@ -145,7 +145,7 @@ export class MediaClip<Props extends MediaClipProps = MediaClipProps> extends As
 	}
 
 	public async connect(track: Track<MediaClip>): Promise<void> {
-		if (['LOADING', 'IDLE'].includes(this.state)) {
+		if (['LOADING', 'IDLE'].includes(this.state) && this.element) {
 			await new Promise(this.resolve('load'));
 		};
 
@@ -277,23 +277,23 @@ export class MediaClip<Props extends MediaClipProps = MediaClipProps> extends As
 
 	/**
 	 * Generates a new caption track for the current clip using the specified captioning strategy.
-	 * @param preset An optional CaptionPresetStrategy to define how captions should be generated.
+	 * @param strategy An optional CaptionPresetStrategy to define how captions should be generated.
 	 * @returns {Promise<void>} A promise that resolves when the caption track has been successfully created.
 	 */
-	public async generateCaptions(preset?: CaptionPresetStrategy): Promise<this> {
+	public async generateCaptions(strategy?: CaptionPresetStrategy | (new () => CaptionPresetStrategy)): Promise<CaptionTrack> {
 		if (!this.track?.composition) {
 			throw new ValidationError({
 				i18n: 'compositionNotDefined',
 				message: 'Captions can only be generated after the clip has been added to the composition',
 			});
 		}
 
-		await this.track.composition
+		const track = await this.track.composition
 			.createTrack('caption')
 			.from(this)
-			.create(preset);
+			.generate(strategy);
 
-		return this;
+		return track;
 	}
 
 	public set(props?: Props): this {

src/tracks/caption/caption.spec.ts

@@ -59,12 +59,12 @@ describe('The Caption Track Object', () => {
 
 	it('should generate captions', async () => {
 		expect(track.clips.length).toBe(0);
-		await track.create();
+		await track.generate();
 		expect(track.clips.length).not.toBe(0);
 	});
 
 	it('should update the offset when the media keyframes change', async () => {
-		await track.create();
+		await track.generate();
 		expect(track.clips.at(0)?.start.seconds).toBe(0);
 
 		media.offsetBy(<frame>10);

src/tracks/caption/caption.ts

@@ -40,11 +40,11 @@ export class CaptionTrack extends Track<TextClip> {
 
 	/**
 	 * If a transcript has been added to the resource
-	 * you can create captions with this function
+	 * you can generate captions with this function
 	 * @param strategy The caption strategy to use
-	 * @default new ClassicCaptionPreset()
+	 * @default ClassicCaptionPreset
 	 */
-	public async create(strategy?: CaptionPresetStrategy | (new () => CaptionPresetStrategy)): Promise<this> {
+	public async generate(strategy?: CaptionPresetStrategy | (new () => CaptionPresetStrategy)): Promise<this> {
 		let preset = this.preset;
 
 		if (typeof strategy == 'object') {

src/tracks/caption/preset.1.spec.ts

@@ -62,7 +62,7 @@ describe('(1) The Caption Presets', () => {
 			})
 		);
 
-		await track1.create();
+		await track1.generate();
 
 		expect(track1.clips.at(0)?.start.seconds).toBe(0);
 		expect(track1.clips.at(0)?.stop.seconds).toBe(1);
@@ -90,7 +90,7 @@ describe('(1) The Caption Presets', () => {
 		]);
 		const track2 = composition.createTrack('caption').from(media2);
 
-		await track2.create();
+		await track2.generate();
 
 		expect(track2.clips.at(0)?.start.millis).toBe(21_001);
 		expect(track2.clips.at(0)?.stop.millis).toBe(22_001);