Class CodeEmbed

Hierarchy (View Summary)

ApplicationExtension
- CodeEmbed

Index

Constructors

Properties

applicationIdentifier ID utf8

Methods

emit getAuthenticationCode getData isInvalidIn

Constructors

constructor

new CodeEmbed(utf8: Uint8Array): CodeEmbed
Parameters
- utf8: Uint8Array
Returns CodeEmbed
Overrides ApplicationExtension.constructor
- Defined in src/gif/blocks/extensions/CodeEmbed.ts:12

Properties

`Readonly`applicationIdentifier

applicationIdentifier: string

The first 8 characters of this will be written to the output as ASCII. If the string is not long enough, it will be padded with "zero" bytes.

`Static` `Readonly`ID

ID: "Algonim." = 'Algonim.'

utf8

utf8: Uint8Array

Methods

emit

emit(vec: ByteVector): void
Parameters
- vec: ByteVector
Returns void
Inherited from ApplicationExtension.emit
- Defined in src/gif/blocks/ApplicationExtension.ts:23

`Protected`getAuthenticationCode

getAuthenticationCode(): [number, number, number]
Gets three bytes that "authenticates" the application identifier. This is supposed to be used to distinguish between identical application identifiers.

Returns [number, number, number]
Overrides ApplicationExtension.getAuthenticationCode
- Defined in src/gif/blocks/extensions/CodeEmbed.ts:17

`Protected`getData

getData(): Iterable<number>
The bytes that should be written into the extension's data sub-blocks.

Returns Iterable<number>
Overrides ApplicationExtension.getData
- Defined in src/gif/blocks/extensions/CodeEmbed.ts:21

isInvalidIn

isInvalidIn(gif: Gif): Error | null
Notice that this method returns any potential errors, rather than throwing them.
Parameters
- gif: Gif
Returns Error | null
Overrides ApplicationExtension.isInvalidIn
- Defined in src/gif/blocks/extensions/CodeEmbed.ts:25