Class StoryboardEncoder

A storyboard encoder.

Index

Constructors

Methods

encodeToPath encodeToString

Constructors

constructor

new StoryboardEncoder(): StoryboardEncoder
Returns StoryboardEncoder

Methods

encodeToPath

encodeToPath(path, storyboard?): Promise<void>
Performs storyboard encoding to the specified path.
Parameters
- path: string
  The path for writing the .osb file.
- Optional storyboard: Storyboard
  The storyboard for encoding.
Returns Promise<void>
Throws
If storyboard can't be encoded or file can't be written.
- Defined in Encoders/StoryboardEncoder.ts:16

encodeToString

encodeToString(storyboard?): string
Performs storyboard encoding to a string.
Parameters
- Optional storyboard: Storyboard
  The storyboard for encoding.
Returns string
The string with encoded storyboard data.
- Defined in Encoders/StoryboardEncoder.ts:37