Interface Emulator

Hierarchy

Emulator

Properties

`Readonly` powerOffChangeEvent

powerOffChangeEvent: Event<boolean>

Fires when the device turns on or off.

`Readonly` isUiInitializedChangeEvent

isUiInitializedChangeEvent: Event<boolean>

Fires when PalmOS resets or passed UI initialization during boot.

`Readonly` audioInitializedEvent

audioInitializedEvent: Event<void>

Fires when audio is initializd successfully.

`Readonly` timesliceEvent

timesliceEvent: Event<void>

Fires after each emulated timeslice (typicall 60 times per second)

`Readonly` hotsyncNameChangeEvent

hotsyncNameChangeEvent: Event<string>

Fires when the hotsync name changes. This does not happen immediatelly when setHotsyncName is called, but only when the OS is notified of the new name.

`Readonly` gameModeChangeEvent

gameModeChangeEvent: Event<boolean>

Fires if game mode is enabled or disabled.

Methods

loadRom

loadRom(rom: Uint8Array, deviceId?: DeviceId): Emulator
Load a ROM and put the emulator in paused state.
Parameters
- rom: Uint8Array
  
  Device ROM
- Optional deviceId: DeviceId
  
  Optional: device ID, autodetected if not specified
Returns Emulator
- Defined in embedded/src/Emulator.ts:34

loadSession

loadSession(session: Uint8Array): Emulator
Load a Cloudpilot session and put the emulator in paused state.
Parameters
- session: Uint8Array
  
  Session image
Returns Emulator
- Defined in embedded/src/Emulator.ts:41

setCanvas

setCanvas(canvas: HTMLCanvasElement): Emulator
Configure the canvas element used for displaying the emulator.
Parameters
- canvas: HTMLCanvasElement
  
  Canvas for displaying the emulator
Returns Emulator
- Defined in embedded/src/Emulator.ts:48

bindInput

bindInput(keyboardTarget?: EventTarget): Emulator
Receive input events from the specified sources. If this method is called multiple times the previous sources will be unbound.
Parameters
- Optional keyboardTarget: EventTarget
  
  Optional: target for keyboard events, default: window
Returns Emulator
- Defined in embedded/src/Emulator.ts:56

releaseInput

releaseInput(): Emulator
Unbind the handlers previous bound with bindInput.

Returns Emulator
- Defined in embedded/src/Emulator.ts:61

installDatabase

installDatabase(file: Uint8Array): Emulator
Install a prc or pdb database to the device.
Parameters
- file: Uint8Array
  
  The database data.
Returns Emulator
- Defined in embedded/src/Emulator.ts:68

installAndLaunchDatabase

installAndLaunchDatabase(file: Uint8Array): Emulator
Install a prc database to the device and attempt to launch it.
Parameters
- file: Uint8Array
  
  The database data.
Returns Emulator
- Defined in embedded/src/Emulator.ts:75

installFromZipfile

installFromZipfile(file: Uint8Array): Emulator
Extract all databases from a zip archive and install them.
Parameters
- file: Uint8Array
  
  The zip archive data.
Returns Emulator
- Defined in embedded/src/Emulator.ts:82

installFromZipfileAndLaunch

installFromZipfileAndLaunch(file: Uint8Array, launchFile: string): Emulator
Extract all databases from a zip archive and install them, then attampt to launch the specified file.
Parameters
- file: Uint8Array
  
  The zip archive data.
- launchFile: string
  
  The file name of the database that Cloudpilot will try to launch.
Returns Emulator
- Defined in embedded/src/Emulator.ts:91

launchByName

launchByName(name: string): Emulator
Attemot to launch the database with the specified name.
Parameters
- name: string
  
  Database name
Returns Emulator
- Defined in embedded/src/Emulator.ts:98

launchDatabase

launchDatabase(database: Uint8Array): Emulator
Attempt to extract the name from a database and launch it.
Parameters
- database: Uint8Array
  
  Database data (only the first 32 bytes are required)
Returns Emulator
- Defined in embedded/src/Emulator.ts:105

reset

reset(): Emulator
Perform a soft reset (equivalent of pushing the reset button).

Returns Emulator
- Defined in embedded/src/Emulator.ts:110

resetNoExtensions

resetNoExtensions(): Emulator
Reset w/o system extensions (equivalent to holding "down" while pushing the reset button).

Returns Emulator
- Defined in embedded/src/Emulator.ts:116

resetHard

resetHard(): Emulator
Hard reset (equivalent to holding "power" while pushing the reset button).

Returns Emulator
- Defined in embedded/src/Emulator.ts:122

isRunning

isRunning(): boolean
Is the emulator running?

Returns boolean
- Defined in embedded/src/Emulator.ts:127

isPowerOff

isPowerOff(): boolean
Is the device powered off?

Returns boolean
- Defined in embedded/src/Emulator.ts:132

isUiInitialized

isUiInitialized(): boolean
Has the emulated device passed UI initialization (during boot)? This is required before software can be installed.

Returns boolean
- Defined in embedded/src/Emulator.ts:138

resume

resume(): Emulator
Resume a paused device.

Returns Emulator
- Defined in embedded/src/Emulator.ts:143

pause

pause(): Emulator
Pause a running device.

Returns Emulator
- Defined in embedded/src/Emulator.ts:148

buttonDown

buttonDown(button: Button): Emulator
Push a hardware button.
Parameters
- button: Button
  
  The desired button
Returns Emulator
- Defined in embedded/src/Emulator.ts:155

buttonUp

buttonUp(button: Button): Emulator
Release a hardware button.
Parameters
- button: Button
  
  The desired button
Returns Emulator
- Defined in embedded/src/Emulator.ts:163

setSpeed

setSpeed(speed: number): Emulator
Adjust speed of the emulated device.
Parameters
- speed: number
  
  Speed factor
Returns Emulator
- Defined in embedded/src/Emulator.ts:170

getSpeed

getSpeed(): number
Query configured speed factor.

Returns number
- Defined in embedded/src/Emulator.ts:175

setVolume

setVolume(volume: number): Emulator
Set audio volume.
Parameters
- volume: number
  
  Volume (1 = 100%, 0 = silent)
Returns Emulator
- Defined in embedded/src/Emulator.ts:182

getVolume

getVolume(): number
Query audio volume

Returns number
- Defined in embedded/src/Emulator.ts:187

initializeAudio

initializeAudio(): Promise<boolean>
Initialize audio. This must be called from an event handler that was triggered by a user interaction, i.e. a click or a key press.

Returns Promise<boolean>
- Defined in embedded/src/Emulator.ts:193

isAudioInitialized

isAudioInitialized(): boolean
Was audio initialized succesfully?

Returns boolean
- Defined in embedded/src/Emulator.ts:198

setGameMode

setGameMode(gameModeActive: boolean): Emulator
Enable or disable game mode (direct key mapping to hardware buttons).
Parameters
- gameModeActive: boolean
  
  Desired state
Returns Emulator
- Defined in embedded/src/Emulator.ts:205

isGameMode

isGameMode(): boolean
Is game mode enabled?

Returns boolean
- Defined in embedded/src/Emulator.ts:210

setGameModeHotkeyEnabled

setGameModeHotkeyEnabled(enableGamemodeHotkey: boolean): Emulator
Enable or disable shift-ctrl for toggling game mode (enabled by default).
Parameters
- enableGamemodeHotkey: boolean
  
  Desired state
Returns Emulator
- Defined in embedded/src/Emulator.ts:217

isGameModeHotkeyEnabled

isGameModeHotkeyEnabled(): boolean
Can game mode be toggled via shift-ctrl?

Returns boolean
- Defined in embedded/src/Emulator.ts:222

setGameModeIndicatorEnabled

setGameModeIndicatorEnabled(gameModeIndicatorEnabled: boolean): Emulator
Enable or disable game mode indicator (overlays hard buttons if game mode is active)? Enabled by default.
Parameters
- gameModeIndicatorEnabled: boolean
  
  Desired state
Returns Emulator
- Defined in embedded/src/Emulator.ts:230

isGameModeIndicatorEnabled

isGameModeIndicatorEnabled(): boolean
Is game mode overlay enabled?

Returns boolean
- Defined in embedded/src/Emulator.ts:235

setOrientation

setOrientation(orientation: DeviceOrientation): Emulator
Change device orientation.
Parameters
- orientation: DeviceOrientation
  
  Desired orientation
Returns Emulator
- Defined in embedded/src/Emulator.ts:242

getOrientation

getOrientation(): DeviceOrientation
Query device orientation

Returns DeviceOrientation
- Defined in embedded/src/Emulator.ts:247

setHotsyncName

setHotsyncName(hotsyncName: undefined | string): Emulator
Set hotsync name.
Parameters
- hotsyncName: undefined | string
  
  Desired hotsync name
Returns Emulator
- Defined in embedded/src/Emulator.ts:254

getHotsyncName

getHotsyncName(): undefined | string
Get hotsync name.

Returns undefined | string
- Defined in embedded/src/Emulator.ts:259

setRunHidden

setRunHidden(toggle: boolean): Emulator
Keep running if the emulator tab is not visible?
Parameters
- toggle: boolean
  
  Desired state
Returns Emulator
- Defined in embedded/src/Emulator.ts:266

getRunHidden

getRunHidden(): boolean
Keep running if the emulator tab is not visible?

Returns boolean
- Defined in embedded/src/Emulator.ts:271

getStatistics

getStatistics(): EmulationStatistics
Get performance statistics

Returns EmulationStatistics
- Defined in embedded/src/Emulator.ts:276

Interface Emulator

Hierarchy

Index

Properties

Methods

Properties

Readonly powerOffChangeEvent

Readonly isUiInitializedChangeEvent

Readonly audioInitializedEvent

Readonly timesliceEvent

Readonly hotsyncNameChangeEvent

Readonly gameModeChangeEvent

Methods

loadRom

Parameters

rom: Uint8Array

Optional deviceId: DeviceId

Returns Emulator

loadSession

Parameters

session: Uint8Array

Returns Emulator

setCanvas

Parameters

canvas: HTMLCanvasElement

Returns Emulator

bindInput

Parameters

Optional keyboardTarget: EventTarget

Returns Emulator

releaseInput

Returns Emulator

installDatabase

Parameters

file: Uint8Array

Returns Emulator

installAndLaunchDatabase

Parameters

file: Uint8Array

Returns Emulator

installFromZipfile

Parameters

file: Uint8Array

Returns Emulator

installFromZipfileAndLaunch

Parameters

file: Uint8Array

launchFile: string

Returns Emulator

launchByName

Parameters

name: string

Returns Emulator

launchDatabase

Parameters

database: Uint8Array

Returns Emulator

reset

Returns Emulator

resetNoExtensions

Returns Emulator

resetHard

Returns Emulator

isRunning

Returns boolean

isPowerOff

Returns boolean

isUiInitialized

Returns boolean

resume

Returns Emulator

pause

Returns Emulator

buttonDown

Parameters

button: Button

Returns Emulator

buttonUp

Parameters

button: Button

`Readonly` powerOffChangeEvent

`Readonly` isUiInitializedChangeEvent

`Readonly` audioInitializedEvent

`Readonly` timesliceEvent

`Readonly` hotsyncNameChangeEvent

`Readonly` gameModeChangeEvent

`Optional` deviceId: DeviceId

`Optional` keyboardTarget: EventTarget