Exports previewing a mash.
Classes
AudioPreviewClass
Implements AudioPreview.
new AudioPreviewClass(
args?):AudioPreviewClass
| Parameter | Type | Description |
|---|---|---|
args? | AudioPreviewArgs |
Returns AudioPreviewClass.
| Property | Modifier | Type |
|---|---|---|
_audibleContext | public | undefined | AudibleContext |
audibleContext | public readonly | AudibleContext |
buffer | public | number |
seconds | public readonly | number |
Methods
adjustGain(
audibleInstance):void
| Parameter | Type | Description |
|---|---|---|
audibleInstance | ClientAudibleInstance |
Returns void. Implementation of AudioPreview.adjustGain.
bufferClips(
clips):boolean
| Parameter | Type | Description |
|---|---|---|
clips | Clip[] |
Returns boolean. Implementation of AudioPreview.bufferClips.
clear():
void
Returns void.
startContext():
boolean
Returns boolean. Implementation of AudioPreview.startContext.
Called when playhead starts moving.startPlaying(
time,clips):boolean
| Parameter | Type | Description |
|---|---|---|
time | Time | |
clips | Clip[] |
Returns boolean. Implementation of AudioPreview.startPlaying.
stopContext():
void
Returns void. Implementation of AudioPreview.stopContext.
stopPlaying():
void
Returns void. Implementation of AudioPreview.stopPlaying.
MashPreviewClass
Preview of a single track at a single frame, thus representing a single clip. Implements [`MashPreview`](/docs/masher/preview.html#mashpreview).new MashPreviewClass(
args):MashPreviewClass
| Parameter | Type | Description |
|---|---|---|
args | MashPreviewArgs |
Returns MashPreviewClass.
| Property | Modifier | Type |
|---|---|---|
args | public | MashPreviewArgs |
clip | public readonly | ClientClip |
doing | static readonly | undefined | ChangingRect |
framework | public readonly | Framework |
masher | public readonly | Masher |
Methods
Constructs an SVG item for the preview of a single clip, including border.svgItem(
animate):SvgItem
| Parameter | Type | Description |
|---|---|---|
animate | boolean |
Returns SvgItem. Implementation of MashPreview.svgItem.
svgItems(
lineClasses,handleClasses,inactive?):SvgItem[]
| Parameter | Type | Description |
|---|---|---|
lineClasses | string[] | |
handleClasses | string[] | |
inactive? | boolean |
Returns SvgItem[]. Implementation of MashPreview.svgItems.
MashPreviewsClass
Preview of a mash at a single frame, including all tracks.Extends MashDescriptionClass. Implements MashPreviews.
new MashPreviewsClass(
args):MashPreviewsClass
| Parameter | Type | Description |
|---|---|---|
args | MashPreviewsArgs |
Returns MashPreviewsClass. Overrides MashDescriptionClass.constructor.
| Property | Modifier | Type |
|---|---|---|
_elementsData | public | undefined | object |
border | public readonly | number |
borderColor | public readonly | string |
borderedRect | public readonly | Rect<number> |
elementsPromise | public readonly | Promise<SvgItem[]> |
framework | public readonly | Framework |
mash | public readonly | ClientMash |
quantize | public readonly | number |
rect | public readonly | Rect<number> |
selectedClip | public readonly | undefined | Clip |
time | public readonly | Time |
Interfaces
AudioPreview
| Property | Type |
|---|---|
buffer | number |
seconds | number |
Methods
adjustGain(
audible):void
| Parameter | Type |
|---|---|
audible | ClientAudibleInstance |
Returns void.
bufferClips(
clips):boolean
| Parameter | Type |
|---|---|
clips | Clip[] |
Returns boolean.
startContext():
boolean
Returns boolean.
startPlaying(
time,clips):boolean
| Parameter | Type |
|---|---|
time | Time |
clips | Clip[] |
Returns boolean.
stopContext():
void
Returns void.
stopPlaying():
void
Returns void.
AudioPreviewArgs
| Property | Type |
|---|---|
buffer? | number |
MashPreview
| Property | Type |
|---|---|
clip | ClientClip |
Methods
Item for display of clip itselfsvgItem(
animate):SvgItem
| Parameter | Type |
|---|---|
animate | boolean |
Returns SvgItem.
Items for display of clip's bounds and outline.svgItems(
lineClasses,handleClasses,inactive?):SvgItem[]
| Parameter | Type |
|---|---|
lineClasses | string[] |
handleClasses | string[] |
inactive? | boolean |
Returns SvgItem[].
MashPreviewArgs
| Property | Type |
|---|---|
clip | ClientClip |
mashDescription | MashPreviews |
MashPreviews
| Property | Type |
|---|---|
border | number |
borderColor | string |
elementsPromise | Promise<SvgItem[]> |
framework | Framework |
mash | ClientMash |
rect | Rect<number> |
selectedClip? | Clip |
time | Time |
MashPreviewsArgs
Extends MashPreviewsOptions.
| Property | Type |
|---|---|
assetType? | MediaType |
border? | number |
borderColor? | string |
clip? | ClientClip |
frame? | number |
frames? | number |
framework | Framework |
mash | ClientMash |
rect | Rect<number> |
selectedClip? | ClientClip |
time | Time |
MashPreviewsOptions
Extends MashDescriptionOptions. Extended by MashPreviewsArgs.
| Property | Type |
|---|---|
assetType? | MediaType |
border? | number |
borderColor? | string |
clip? | ClientClip |
frame? | number |
frames? | number |
framework | Framework |
rect | Rect<number> |
selectedClip? | ClientClip |
time? | Time |
Previewable
| Property | Type |
|---|---|
contentForHead | OptionalContent |
head | OptionalContent |
iconIds | string[] |
preview? | Element |
previewSize | Size<number> |
previewTarget | string |
Methods
handleTargetIdSignal(
signal):void
| Parameter | Type |
|---|---|
signal | Signal |
Returns void.
refreshPreview():
void
Returns void.
Type Aliases
AudioPreviewFunction
AudioPreviewFunction:
SyncFunction<AudioPreview,AudioPreviewArgs>