ffmpeglab-sdk 0.3.6 → 0.3.8

package/docs/EncoderProject.md

@@ -0,0 +1,80 @@
+
+# EncoderProject
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`uri` | string
+`url` | string
+`date` | number
+`folderId` | string
+`title` | string
+`description` | string
+`filename` | string
+`fileType` | string
+`userId` | string
+`size` | number
+`type` | string
+`hasCloud` | boolean
+`hasAudio` | boolean
+`width` | number
+`height` | number
+`orderId` | number
+`duration` | number
+`isCopy` | string
+`isVideo` | boolean
+`isAudio` | boolean
+`isTextFile` | string
+`isReplace` | boolean
+`encoding` | [EncoderProjectEncoding](EncoderProjectEncoding.md)
+
+## Example
+
+```typescript
+import type { EncoderProject } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "uri": null,
+  "url": null,
+  "date": null,
+  "folderId": null,
+  "title": null,
+  "description": null,
+  "filename": null,
+  "fileType": null,
+  "userId": null,
+  "size": null,
+  "type": null,
+  "hasCloud": null,
+  "hasAudio": null,
+  "width": null,
+  "height": null,
+  "orderId": null,
+  "duration": null,
+  "isCopy": null,
+  "isVideo": null,
+  "isAudio": null,
+  "isTextFile": null,
+  "isReplace": null,
+  "encoding": null,
+} satisfies EncoderProject
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as EncoderProject
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/EncoderProjectEncoding.md

@@ -0,0 +1,80 @@
+
+# EncoderProjectEncoding
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`outputFilePath` | string
+`compressionLevel` | number
+`width` | number
+`height` | number
+`crf` | number
+`preset` | string
+`output` | string
+`code` | Array<string>
+`lastUpdated` | number
+`start` | number
+`end` | number
+`soundVolume` | number
+`opacity` | number
+`reverse` | boolean
+`speed` | number
+`transitionIn` | string
+`transitionOut` | string
+`transitionInDuration` | number
+`transitionOutDuration` | number
+`pan` | [PositionParams](PositionParams.md)
+`crop` | [PositionParams](PositionParams.md)
+`resize` | [Resize](Resize.md)
+`color` | [RGB](RGB.md)
+`scale` | number
+
+## Example
+
+```typescript
+import type { EncoderProjectEncoding } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "outputFilePath": null,
+  "compressionLevel": null,
+  "width": null,
+  "height": null,
+  "crf": null,
+  "preset": null,
+  "output": null,
+  "code": null,
+  "lastUpdated": null,
+  "start": null,
+  "end": null,
+  "soundVolume": null,
+  "opacity": null,
+  "reverse": null,
+  "speed": null,
+  "transitionIn": null,
+  "transitionOut": null,
+  "transitionInDuration": null,
+  "transitionOutDuration": null,
+  "pan": null,
+  "crop": null,
+  "resize": null,
+  "color": null,
+  "scale": null,
+} satisfies EncoderProjectEncoding
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as EncoderProjectEncoding
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Media.md

@@ -0,0 +1,78 @@
+
+# Media
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`uri` | string
+`url` | string
+`date` | number
+`folderId` | string
+`title` | string
+`description` | string
+`filename` | string
+`fileType` | string
+`userId` | string
+`size` | number
+`type` | string
+`hasCloud` | boolean
+`hasAudio` | boolean
+`width` | number
+`height` | number
+`orderId` | number
+`duration` | number
+`isCopy` | string
+`isVideo` | boolean
+`isAudio` | boolean
+`isTextFile` | string
+`isReplace` | boolean
+
+## Example
+
+```typescript
+import type { Media } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "uri": null,
+  "url": null,
+  "date": null,
+  "folderId": null,
+  "title": null,
+  "description": null,
+  "filename": null,
+  "fileType": null,
+  "userId": null,
+  "size": null,
+  "type": null,
+  "hasCloud": null,
+  "hasAudio": null,
+  "width": null,
+  "height": null,
+  "orderId": null,
+  "duration": null,
+  "isCopy": null,
+  "isVideo": null,
+  "isAudio": null,
+  "isTextFile": null,
+  "isReplace": null,
+} satisfies Media
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Media
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PositionParams.md

@@ -0,0 +1,40 @@
+
+# PositionParams
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`top` | number
+`bottom` | number
+`left` | number
+`right` | number
+
+## Example
+
+```typescript
+import type { PositionParams } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "top": null,
+  "bottom": null,
+  "left": null,
+  "right": null,
+} satisfies PositionParams
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PositionParams
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RGB.md

@@ -0,0 +1,38 @@
+
+# RGB
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`r` | number
+`g` | number
+`b` | number
+
+## Example
+
+```typescript
+import type { RGB } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "r": null,
+  "g": null,
+  "b": null,
+} satisfies RGB
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RGB
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RenderData.md

@@ -0,0 +1,36 @@
+
+# RenderData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`project` | [EditorProject](EditorProject.md)
+`layers` | [Array<EditorLayer>](EditorLayer.md)
+
+## Example
+
+```typescript
+import type { RenderData } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "project": null,
+  "layers": null,
+} satisfies RenderData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RenderData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RenderDto.md

@@ -0,0 +1,36 @@
+
+# RenderDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`project` | [EditorProject](EditorProject.md)
+`layers` | [Array<EditorLayer>](EditorLayer.md)
+
+## Example
+
+```typescript
+import type { RenderDto } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "project": null,
+  "layers": null,
+} satisfies RenderDto
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RenderDto
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RenderResponse.md

@@ -0,0 +1,52 @@
+
+# RenderResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`title` | string
+`project` | string
+`status` | string
+`_public` | boolean
+`userId` | string
+`progress` | number
+`logs` | string
+`data` | [RenderData](RenderData.md)
+`result` | [Media](Media.md)
+
+## Example
+
+```typescript
+import type { RenderResponse } from 'ffmpeglab-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "title": null,
+  "project": null,
+  "status": null,
+  "_public": null,
+  "userId": null,
+  "progress": null,
+  "logs": null,
+  "data": null,
+  "result": null,
+} satisfies RenderResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RenderResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+