You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a094121
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: src/model/asset.ts
+1-223Lines changed: 1 addition & 223 deletions
Original file line number
Diff line number
Diff line change
@@ -10,236 +10,14 @@
10
10
* Do not edit the class manually.
11
11
*/
12
12
13
-
import{RequestFile}from'./models';
14
13
import{AudioAsset}from'./audioAsset';
15
-
import{Crop}from'./crop';
16
14
import{HtmlAsset}from'./htmlAsset';
17
15
import{ImageAsset}from'./imageAsset';
18
16
import{LumaAsset}from'./lumaAsset';
19
-
import{Offset}from'./offset';
20
17
import{TitleAsset}from'./titleAsset';
21
18
import{VideoAsset}from'./videoAsset';
22
19
23
20
/**
24
21
* The type of asset to display for the duration of the Clip. Value must be one of: <ul> <li><a href=\"#tocs_videoasset\">VideoAsset</a></li> <li><a href=\"#tocs_imageasset\">ImageAsset</a></li> <li><a href=\"#tocs_titleasset\">TitleAsset</a></li> <li><a href=\"#tocs_htmlasset\">HtmlAsset</a></li> <li><a href=\"#tocs_audioasset\">AudioAsset</a></li> <li><a href=\"#tocs_lumaasset\">LumaAsset</a></li> </ul>
25
22
*/
26
-
exportclassAsset{
27
-
/**
28
-
* The type of asset - set to `luma` for luma mattes.
29
-
*/
30
-
'type': string='luma';
31
-
/**
32
-
* The luma matte source URL. The URL must be publicly accessible or include credentials.
33
-
*/
34
-
'src': string;
35
-
/**
36
-
* The start trim point of the luma matte clip, in seconds (defaults to 0). Videos will start from the in trim point. A luma matte video will play until the file ends or the Clip length is reached.
37
-
*/
38
-
'trim'?: number;
39
-
/**
40
-
* Set the volume for the audio clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
41
-
*/
42
-
'volume'?: number;
43
-
/**
44
-
* The volume effect to apply to the video asset <ul> <li>`fadeIn` - fade volume in only</li> <li>`fadeOut` - fade volume out only</li> <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
45
-
*/
46
-
'volumeEffect'?: Asset.VolumeEffectEnum;
47
-
/**
48
-
* Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire audio (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire audio (i.e. original length / 2).
49
-
*/
50
-
'speed'?: number;
51
-
'crop'?: Crop;
52
-
/**
53
-
* The title text string - i.e. \"My Title\".
54
-
*/
55
-
'text': string;
56
-
/**
57
-
* Uses a preset to apply font properties and styling to the title. <ul> <li>`minimal`</li> <li>`blockbuster`</li> <li>`vogue`</li> <li>`sketchy`</li> <li>`skinny`</li> <li>`chunk`</li> <li>`chunkLight`</li> <li>`marker`</li> <li>`future`</li> <li>`subtitle`</li> </ul>
58
-
*/
59
-
'style'?: Asset.StyleEnum;
60
-
/**
61
-
* Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.
62
-
*/
63
-
'color'?: string;
64
-
/**
65
-
* Set the relative size of the text using predefined sizes from xx-small to xx-large. <ul> <li>`xx-small`</li> <li>`x-small`</li> <li>`small`</li> <li>`medium`</li> <li>`large`</li> <li>`x-large`</li> <li>`xx-large`</li> </ul>
66
-
*/
67
-
'size'?: Asset.SizeEnum;
68
-
/**
69
-
* Apply a background color behind the HTML bounding box using. Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.
70
-
*/
71
-
'background'?: string;
72
-
/**
73
-
* Place the HTML in one of nine predefined positions within the HTML area. <ul> <li>`top` - top (center)</li> <li>`topRight` - top right</li> <li>`right` - right (center)</li> <li>`bottomRight` - bottom right</li> <li>`bottom` - bottom (center)</li> <li>`bottomLeft` - bottom left</li> <li>`left` - left (center)</li> <li>`topLeft` - top left</li> <li>`center` - center</li> </ul>
74
-
*/
75
-
'position'?: Asset.PositionEnum;
76
-
'offset'?: Offset;
77
-
/**
78
-
* The HTML text string. See list of [supported HTML tags](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-html-tags).
79
-
*/
80
-
'html': string;
81
-
/**
82
-
* The CSS text string to apply styling to the HTML. See list of [support CSS properties](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-css-properties).
83
-
*/
84
-
'css'?: string;
85
-
/**
86
-
* Set the width of the HTML asset bounding box in pixels. Text will wrap to fill the bounding box.
87
-
*/
88
-
'width'?: number;
89
-
/**
90
-
* Set the width of the HTML asset bounding box in pixels. Text and elements will be masked if they exceed the height of the bounding box.
91
-
*/
92
-
'height'?: number;
93
-
/**
94
-
* The effect to apply to the audio asset <ul> <li>`fadeIn` - fade volume in only</li> <li>`fadeOut` - fade volume out only</li> <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
* A destination is a location where assets can be sent to for serving or hosting. Videos, images and audio files that are rendered by the [Edit API](#shotstack-edit) and [source](#tocs_source) and [rendition](#tocs_rendition) files generated by the [Ingest API](#shotstack-ingest) can be sent to destinations. You can also fetch a file from any public URL and [transfer](#transfer-asset) it to a destination. A file can be sent to one or more destinations including 3rd party destinations. By default all ingested and generated assets are automatically sent to the [Shotstack hosting destination](https://shotstack.io/docs/guide/serving-assets/hosting/). You can [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from by setting the Shotstack destination **exclude** property to **true**. The following destinations are available: <ul> <li><a href=\"#tocs_shotstackdestination\">ShotstackDestination</a></li> <li><a href=\"#tocs_muxdestination\">MuxDestination</a></li> <li><a href=\"#tocs_s3destination\">S3Destination</a></li> <li><a href=\"#tocs_googlecloudstoragedestination\">GoogleCloudStorageDestination</a></li> </ul>
22
20
*/
23
-
exportclassDestinations{
24
-
/**
25
-
* The destination to send assets to - set to `google-cloud-storage` for Google Cloud Storage.
26
-
*/
27
-
'provider': string='google-cloud-storage';
28
-
/**
29
-
* Set to `true` to [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from the Shotstack hosting and CDN service. All files must be downloaded within 24 hours of rendering.
* A generated asset is a media asset created by the Create API. You can use native or third party providers to generate video, audio and image files using Generative AI services like text-to-speech and text-to-avatar. The following providers are currently available: <ul> <li><a href=\"#tocs_shotstackgeneratedasset\">ShotstackGeneratedAsset</a></li> <li><a href=\"#tocs_didgeneratedasset\">DIDGeneratedAsset</a></li> <li><a href=\"#tocs_elevenlabsgeneratedasset\">ElevenLabsGeneratedAsset</a></li> <li><a href=\"#tocs_heygengeneratedasset\">HeyGenGeneratedAsset</a></li> <li><a href=\"#tocs_openaigeneratedasset\">OpenAiGeneratedAsset</a></li> <li><a href=\"#tocs_stabilityaigeneratedasset\">StabilityAiGeneratedAsset</a></li> </ul>
24
22
*/
25
-
exportclassGeneratedAsset{
26
-
/**
27
-
* The name of the provider - set to `stability-ai` for Stability AI.
0 commit comments