Guides
...
Platform communication
Window postMessage API

AppMessage

3min

App messages describe specific actions in the App domain.

Message definition

The message target of an app message is app.

TypeScript


Message actions

LiSA accepts/exposes the following app message actions:

Action

Description

Direction of communication

close

Close action, triggered by user interaction.

LiSA to X

maximize

Ask LiSA to display all on-screen controls.

X to LiSA

minimize

Ask LiSA to hide all on-screen controls.

X to LiSA

pause

Ask LiSA to pause the stream (both video and audio).

X to LiSA

ready

LiSA app is ready for communication with the embedding context.

LiSA to X

resume

Ask LiSA to resume the stream (both video and audio).

X to LiSA

The pause and resume action are relevant when LiSA is integrated into a native app such as Android and iOS. Typically, they are sent when either the app component, or the entire app gets sent background or awakes from sleep with the LiSA WebView open.

Examples

Listed below are examples for app message payloads.

JS