Class: CaptionScreen

Defined in: CaptionScreen.ts:51

Keep a CTA-608 screen of 32x15 styled characters

Constructors

Constructor

new CaptionScreen(logger?): CaptionScreen;

Defined in: CaptionScreen.ts:58

Parameters

logger?

CaptionsLogger = ...

Returns

CaptionScreen

Properties

rows

rows: Row[] = [];

Defined in: CaptionScreen.ts:52

Methods

backSpace()

backSpace(): void;

Defined in: CaptionScreen.ts:100

Returns

void

---

clearToEndOfRow()

clearToEndOfRow(): void;

Defined in: CaptionScreen.ts:105

Returns

void

---

copy()

copy(other): void;

Defined in: CaptionScreen.ts:83

Parameters

other

CaptionScreen

Returns

void

---

equals()

equals(other): boolean;

Defined in: CaptionScreen.ts:72

Parameters

other

CaptionScreen

Returns

boolean

---

getDisplayText()

getDisplayText(asOneRow?): string;

Defined in: CaptionScreen.ts:215

Get all non-empty rows with as unicode text.

Parameters

asOneRow?

boolean

Returns

string

---

getTextAndFormat()

getTextAndFormat(): Row[];

Defined in: CaptionScreen.ts:241

Returns

Row[]

---

insertChar()

insertChar(char): void;

Defined in: CaptionScreen.ts:113

Insert a character (without styling) in the current row.

Parameters

char

number

Returns

void

---

isEmpty()

isEmpty(): boolean;

Defined in: CaptionScreen.ts:89

Returns

boolean

---

moveCursor()

moveCursor(relPos): void;

Defined in: CaptionScreen.ts:123

Parameters

relPos

number

Returns

void

---

reset()

reset(): void;

Defined in: CaptionScreen.ts:65

Returns

void

---

rollUp()

rollUp(): void;

Defined in: CaptionScreen.ts:199

Returns

void

---

setBkgData()

setBkgData(bkgData): void;

Defined in: CaptionScreen.ts:188

Set background/extra foreground, but first do back_space, and then insert space (backwards compatibility).

Parameters

bkgData

Partial<PenStyles>

Returns

void

---

setCursor()

setCursor(absPos): void;

Defined in: CaptionScreen.ts:128

Parameters

absPos

number

Returns

void

---

setPAC()

setPAC(pacData): void;

Defined in: CaptionScreen.ts:134

Parameters

pacData

PACData

Returns

void

---

setPen()

setPen(styles): void;

Defined in: CaptionScreen.ts:118

Parameters

styles

Partial<PenStyles>

Returns

void

---

setRollUpRows()

setRollUpRows(nrRows): void;

Defined in: CaptionScreen.ts:195

Parameters

nrRows

number | null

Returns

void