webstation-broker
DeveloperPython referenceapi

api.ActivateIn

The launch request RomM sends to start a session.

The launch request RomM sends to start a session.

Attributes

attributesession_idOptional[str]
= None

RomM's id for the session, if it assigns one.

attributeuserOptional[dict[str, Any]]
= None

The RomM user taking the controller seat, if known.

attributeemulatorstr

The emulator name to launch.

attributeromOptional[RomIn]
= None

The rom to boot; optional for launch types without a game.

attributesaveOptional[SaveIn]
= None

Save data to restore before launch, if any.

attributecallbackOptional[CallbackIn]
= None

Where the exit save archive goes, if not derived from the request.

attributemultiplayerbool
= False

Whether RomM advertises the session for joining.

api

REST endpoints for the session lifecycle and the room frontend's bootstrap.

api.CallbackIn

Where and how to push the exit save archive.

On this page

Attributes