Class: CaptionElement

Hierarchy

• TrackElement

  ↳ CaptionElement

Table of contents

Constructors

• constructor

Methods

• getId
• getType
• getStart
• getEnd
• getDuration
• getTrackId
• getProps
• getMetadata
• getName
• getAnimation
• getPosition
• getRotation
• getOpacity
• setId
• setType
• setStart
• setEnd
• setTrackId
• setName
• setAnimation
• setPosition
• setRotation
• setOpacity
• setProps
• setMetadata
• getTransition
• setTransition
• getText
• setText
• accept

Constructors

constructor

• new CaptionElement(t, start, end): CaptionElement

Parameters

Name	Type
t	string
start	number
end	number

Returns

CaptionElement

Overrides

TrackElement.constructor

Defined in

core/elements/caption.element.ts:8

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

---

getPosition

▸ getPosition(): Position

Returns

Position

Inherited from

TrackElement.getPosition

Defined in

core/elements/base.element.ts:71

---

getRotation

▸ getRotation(): number

Returns

number

Inherited from

TrackElement.getRotation

Defined in

core/elements/base.element.ts:78

---

getOpacity

▸ getOpacity(): number

Returns

number

Inherited from

TrackElement.getOpacity

Defined in

core/elements/base.element.ts:82

---

setId

▸ setId(id): CaptionElement

Parameters

Name	Type
id	string

Returns

CaptionElement

Inherited from

TrackElement.setId

Defined in

core/elements/base.element.ts:86

---

setType

▸ setType(type): CaptionElement

Parameters

Name	Type
type	string

Returns

CaptionElement

Inherited from

TrackElement.setType

Defined in

core/elements/base.element.ts:91

---

setStart

▸ setStart(s): CaptionElement

Parameters

Name	Type
s	number

Returns

CaptionElement

Inherited from

TrackElement.setStart

Defined in

core/elements/base.element.ts:96

---

setEnd

▸ setEnd(e): CaptionElement

Parameters

Name	Type
e	number

Returns

CaptionElement

Inherited from

TrackElement.setEnd

Defined in

core/elements/base.element.ts:101

---

setTrackId

▸ setTrackId(trackId): CaptionElement

Parameters

Name	Type
trackId	string

Returns

CaptionElement

Inherited from

TrackElement.setTrackId

Defined in

core/elements/base.element.ts:106

---

setName

▸ setName(name): CaptionElement

Parameters

Name	Type
name	string

Returns

CaptionElement

Inherited from

TrackElement.setName

Defined in

core/elements/base.element.ts:111

---

setAnimation

▸ setAnimation(animation?): CaptionElement

Parameters

Name	Type
animation?	ElementAnimation

Returns

CaptionElement

Inherited from

TrackElement.setAnimation

Defined in

core/elements/base.element.ts:116

---

setPosition

▸ setPosition(position): CaptionElement

Parameters

Name	Type
position	Position

Returns

CaptionElement

Inherited from

TrackElement.setPosition

Defined in

core/elements/base.element.ts:121

---

setRotation

▸ setRotation(rotation): CaptionElement

Parameters

Name	Type
rotation	number

Returns

CaptionElement

Inherited from

TrackElement.setRotation

Defined in

core/elements/base.element.ts:127

---

setOpacity

▸ setOpacity(opacity): CaptionElement

Parameters

Name	Type
opacity	number

Returns

CaptionElement

Inherited from

TrackElement.setOpacity

Defined in

core/elements/base.element.ts:132

---

setProps

▸ setProps(props): CaptionElement

Parameters

Name	Type
props	Record<string, any>

Returns

CaptionElement

Inherited from

TrackElement.setProps

Defined in

core/elements/base.element.ts:137

---

setMetadata

▸ setMetadata(metadata?): CaptionElement

Parameters

Name	Type
metadata?	ElementMetadata

Returns

CaptionElement

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

---

getText

▸ getText(): string

Returns

string

Defined in

core/elements/caption.element.ts:16

---

setText

▸ setText(t): CaptionElement

Parameters

Name	Type
t	string

Returns

CaptionElement

Defined in

core/elements/caption.element.ts:20

---

accept

▸ accept<T>(visitor): T

Type parameters

Name
T

Parameters

Name	Type
visitor	ElementVisitor<T>

Returns

T

Overrides

TrackElement.accept

Defined in

core/elements/caption.element.ts:25