Class: VideoElement

Hierarchy

• TrackElement

  ↳ VideoElement

Table of contents

Constructors

• constructor

Methods

• getId
• getType
• getStart
• getEnd
• getDuration
• getTrackId
• getProps
• getMetadata
• getName
• getAnimation
• getOpacity
• setId
• setType
• setStart
• setEnd
• setTrackId
• setName
• setAnimation
• setOpacity
• setMetadata
• getTransition
• setTransition
• getParentSize
• getFrame
• getFrameEffects
• getBackgroundColor
• getObjectFit
• getMediaDuration
• getStartAt
• getEndAt
• getSrc
• getPlaybackRate
• getVolume
• getRotation
• setRotation
• getPosition
• updateVideoMeta
• setPosition
• setSrc
• setMediaDuration
• setParentSize
• setObjectFit
• setFrame
• setPlaybackRate
• setStartAt
• setMediaFilter
• setVolume
• setBackgroundColor
• setProps
• setFrameEffects
• addFrameEffect
• accept

Constructors

constructor

• new VideoElement(src, parentSize): VideoElement

Parameters

Name	Type
src	string
parentSize	Size

Returns

VideoElement

Overrides

TrackElement.constructor

Defined in

core/elements/video.element.ts:18

Methods

getId

▸ getId(): string

Returns

string

Inherited from

TrackElement.getId

Defined in

core/elements/base.element.ts:31

---

getType

▸ getType(): string

Returns

string

Inherited from

TrackElement.getType

Defined in

core/elements/base.element.ts:35

---

getStart

▸ getStart(): number

Returns

number

Inherited from

TrackElement.getStart

Defined in

core/elements/base.element.ts:39

---

getEnd

▸ getEnd(): number

Returns

number

Inherited from

TrackElement.getEnd

Defined in

core/elements/base.element.ts:43

---

getDuration

▸ getDuration(): number

Returns

number

Inherited from

TrackElement.getDuration

Defined in

core/elements/base.element.ts:47

---

getTrackId

▸ getTrackId(): string

Returns

string

Inherited from

TrackElement.getTrackId

Defined in

core/elements/base.element.ts:51

---

getProps

▸ getProps(): Record<string, any>

Returns

Record<string, any>

Inherited from

TrackElement.getProps

Defined in

core/elements/base.element.ts:55

---

getMetadata

▸ getMetadata(): undefined | ElementMetadata

Returns

undefined | ElementMetadata

Inherited from

TrackElement.getMetadata

Defined in

core/elements/base.element.ts:59

---

getName

▸ getName(): string

Returns

string

Inherited from

TrackElement.getName

Defined in

core/elements/base.element.ts:63

---

getAnimation

▸ getAnimation(): undefined | ElementAnimation

Returns

undefined | ElementAnimation

Inherited from

TrackElement.getAnimation

Defined in

core/elements/base.element.ts:67

---

getOpacity

▸ getOpacity(): number

Returns

number

Inherited from

TrackElement.getOpacity

Defined in

core/elements/base.element.ts:82

---

setId

▸ setId(id): VideoElement

Parameters

Name	Type
id	string

Returns

VideoElement

Inherited from

TrackElement.setId

Defined in

core/elements/base.element.ts:86

---

setType

▸ setType(type): VideoElement

Parameters

Name	Type
type	string

Returns

VideoElement

Inherited from

TrackElement.setType

Defined in

core/elements/base.element.ts:91

---

setStart

▸ setStart(s): VideoElement

Parameters

Name	Type
s	number

Returns

VideoElement

Inherited from

TrackElement.setStart

Defined in

core/elements/base.element.ts:96

---

setEnd

▸ setEnd(e): VideoElement

Parameters

Name	Type
e	number

Returns

VideoElement

Inherited from

TrackElement.setEnd

Defined in

core/elements/base.element.ts:101

---

setTrackId

▸ setTrackId(trackId): VideoElement

Parameters

Name	Type
trackId	string

Returns

VideoElement

Inherited from

TrackElement.setTrackId

Defined in

core/elements/base.element.ts:106

---

setName

▸ setName(name): VideoElement

Parameters

Name	Type
name	string

Returns

VideoElement

Inherited from

TrackElement.setName

Defined in

core/elements/base.element.ts:111

---

setAnimation

▸ setAnimation(animation?): VideoElement

Parameters

Name	Type
animation?	ElementAnimation

Returns

VideoElement

Inherited from

TrackElement.setAnimation

Defined in

core/elements/base.element.ts:116

---

setOpacity

▸ setOpacity(opacity): VideoElement

Parameters

Name	Type
opacity	number

Returns

VideoElement

Inherited from

TrackElement.setOpacity

Defined in

core/elements/base.element.ts:132

---

setMetadata

▸ setMetadata(metadata?): VideoElement

Parameters

Name	Type
metadata?	ElementMetadata

Returns

VideoElement

Inherited from

TrackElement.setMetadata

Defined in

core/elements/base.element.ts:142

---

getTransition

▸ getTransition(): undefined | ElementTransitionJSON

Returns

undefined | ElementTransitionJSON

Inherited from

TrackElement.getTransition

Defined in

core/elements/base.element.ts:147

---

setTransition

▸ setTransition(transition): this

Parameters

Name	Type
transition	undefined | ElementTransitionJSON

Returns

this

Inherited from

TrackElement.setTransition

Defined in

core/elements/base.element.ts:151

---

getParentSize

▸ getParentSize(): Size

Returns

Size

Defined in

core/elements/video.element.ts:32

---

getFrame

▸ getFrame(): Frame

Returns

Frame

Defined in

core/elements/video.element.ts:36

---

getFrameEffects

▸ getFrameEffects(): undefined | ElementFrameEffect[]

Returns

undefined | ElementFrameEffect[]

Defined in

core/elements/video.element.ts:40

---

getBackgroundColor

▸ getBackgroundColor(): string

Returns

string

Defined in

core/elements/video.element.ts:44

---

getObjectFit

▸ getObjectFit(): ObjectFit

Returns

ObjectFit

Defined in

core/elements/video.element.ts:48

---

getMediaDuration

▸ getMediaDuration(): number

Returns

number

Defined in

core/elements/video.element.ts:52

---

getStartAt

▸ getStartAt(): number

Returns

number

Defined in

core/elements/video.element.ts:56

---

getEndAt

▸ getEndAt(): number

Returns

number

Defined in

core/elements/video.element.ts:60

---

getSrc

▸ getSrc(): string

Returns

string

Defined in

core/elements/video.element.ts:64

---

getPlaybackRate

▸ getPlaybackRate(): number

Returns

number

Defined in

core/elements/video.element.ts:68

---

getVolume

▸ getVolume(): number

Returns

number

Defined in

core/elements/video.element.ts:72

---

getRotation

▸ getRotation(): number

Returns

number

Overrides

TrackElement.getRotation

Defined in

core/elements/video.element.ts:76

---

setRotation

▸ setRotation(rotation): VideoElement

Parameters

Name	Type
rotation	number

Returns

VideoElement

Overrides

TrackElement.setRotation

Defined in

core/elements/video.element.ts:80

---

getPosition

▸ getPosition(): Position

Returns

Position

Overrides

TrackElement.getPosition

Defined in

core/elements/video.element.ts:85

---

updateVideoMeta

▸ updateVideoMeta(updateFrame?): Promise<void>

Parameters

Name	Type	Default value
updateFrame	boolean	true

Returns

Promise<void>

Defined in

core/elements/video.element.ts:93

---

setPosition

▸ setPosition(position): VideoElement

Parameters

Name	Type
position	Position

Returns

VideoElement

Overrides

TrackElement.setPosition

Defined in

core/elements/video.element.ts:110

---

setSrc

▸ setSrc(src): Promise<VideoElement>

Parameters

Name	Type
src	string

Returns

Promise<VideoElement>

Defined in

core/elements/video.element.ts:116

---

setMediaDuration

▸ setMediaDuration(mediaDuration): VideoElement

Parameters

Name	Type
mediaDuration	number

Returns

VideoElement

Defined in

core/elements/video.element.ts:122

---

setParentSize

▸ setParentSize(parentSize): VideoElement

Parameters

Name	Type
parentSize	Size

Returns

VideoElement

Defined in

core/elements/video.element.ts:127

---

setObjectFit

▸ setObjectFit(objectFit): VideoElement

Parameters

Name	Type
objectFit	ObjectFit

Returns

VideoElement

Defined in

core/elements/video.element.ts:132

---

setFrame

▸ setFrame(frame): VideoElement

Parameters

Name	Type
frame	Frame

Returns

VideoElement

Defined in

core/elements/video.element.ts:137

---

setPlaybackRate

▸ setPlaybackRate(playbackRate): VideoElement

Parameters

Name	Type
playbackRate	number

Returns

VideoElement

Defined in

core/elements/video.element.ts:142

---

setStartAt

▸ setStartAt(time): VideoElement

Parameters

Name	Type
time	number

Returns

VideoElement

Defined in

core/elements/video.element.ts:147

---

setMediaFilter

▸ setMediaFilter(mediaFilter): VideoElement

Parameters

Name	Type
mediaFilter	string

Returns

VideoElement

Defined in

core/elements/video.element.ts:152

---

setVolume

▸ setVolume(volume): VideoElement

Parameters

Name	Type
volume	number

Returns

VideoElement

Defined in

core/elements/video.element.ts:157

---

setBackgroundColor

▸ setBackgroundColor(backgroundColor): VideoElement

Parameters

Name	Type
backgroundColor	string

Returns

VideoElement

Defined in

core/elements/video.element.ts:162

---

setProps

▸ setProps(props): VideoElement

Parameters

Name	Type
props	Omit<any, "src">

Returns

VideoElement

Overrides

TrackElement.setProps

Defined in

core/elements/video.element.ts:167

---

setFrameEffects

▸ setFrameEffects(frameEffects?): VideoElement

Parameters

Name	Type
frameEffects?	ElementFrameEffect[]

Returns

VideoElement

Defined in

core/elements/video.element.ts:175

---

addFrameEffect

▸ addFrameEffect(frameEffect): VideoElement

Parameters

Name	Type
frameEffect	ElementFrameEffect

Returns

VideoElement

Defined in

core/elements/video.element.ts:180

---

accept

▸ accept<T>(visitor): T

Type parameters

Name
T

Parameters

Name	Type
visitor	ElementVisitor<T>

Returns

T

Overrides

TrackElement.accept

Defined in

core/elements/video.element.ts:185