LiSA Social Commerce
Developers
Developers
  • Developers
  • Guides
    • Integration Guide
      • Web Integration
      • App Integration
        • Android
          • Communication
          • Storage
          • File Downloads
          • Theming
        • iOS
          • Communication
          • Storage
          • File Downloads
          • Theming
        • React Native
          • Communication
          • Storage
          • File Downloads
          • Theming
        • Picture in Picture
      • Entrypoints
        • Query Parameter (v1)
    • Player Communication
      • Message API Reference
        • App
          • App — Heartbeat
          • App — Message Acknowledge
          • App — Message Error
          • App — Listen
        • CTA
          • CTA — Link in Comments
          • CTA — Sponsor Badge
        • Cart — View Cart
        • Comments — Join
        • Media
          • Media — Complete
          • Media — Pause
          • Media — Progress
          • Media — Resume
        • Media Item
          • Media Item — Emoji
          • Media Item — Impression
        • Player
          • Player — Dismiss
          • Player — Native Picture-in-Picture (PiP)
          • Player — Pass Visual Viewport
          • Player — Request Visual Viewport
          • Player — UI Transition
        • Products
          • Products — Add to Cart
          • Products — Add to Wishlist
          • Products — Click
          • Products — Close Product List
          • Products — Emoji
          • Products — Emoji State Update
          • Products — Impression
          • Products — Open Product List
        • Stickers
          • Stickers — Activate
          • Stickers — Click
          • Stickers — Expire
          • Stickers — Impression
          • Stickers — Publish
          • Stickers — Unlock
          • Stickers — Unpublish
          • Stickers — Update
          • Stickers — Voucher Claim
        • Visitor — Pass User Context
        • Shared Legacy Message Properties
    • Products
      • Product Update Notification API
  • Widgets
    • Content Hub
    • Quick Start Guide
    • Appearance
      • Markup
      • Responsive design
    • Configuration options
      • Autoplay
      • Channel
      • Client
      • Data
      • Debug
      • Host node
      • Layout
      • Language
      • On
      • Player
      • Query string
      • Quick view
      • Sections
      • Store
      • Template
    • API reference
      • Library API reference
      • Player API reference
      • Quick View API reference
    • Customisations
      • Template
      • Bring your own template
      • Type definitions
    • Examples
    • Type definitions
      • Asset
      • Product
      • Other
    • Promo Widget
      • Quick Start Guide
      • Configuration options
        • Autoplay
        • Channel
        • Countdown (deprecated)
        • Enabled
        • Image modifier
        • Lead time
        • Live (deprecated)
        • Position
        • Replay (deprecated)
        • Show ID
        • URL
  • Media Player Introduction
    • Picture-in-Picture Mode
  • Analytics
  • REST API
    • Authentication
    • Rate limits
    • Response status and error codes
    • API Documentation
Powered by GitBook
On this page
  • Floating Player States
  • Properties
  • Type Definition
  • Examples
  1. Guides
  2. Player Communication
  3. Message API Reference
  4. Player

Player — UI Transition

PreviousPlayer — Request Visual ViewportNextProducts

Last updated 1 month ago

The LiSA Player supports a Picture-in-Picture (PiP)-like floating mode, allowing users to continue watching while interacting with other content. Depending on the host app / environment, the player remains in place but adjusts its controls to better suit a floating experience.

Read the on how to utilize the Floating Mode messages in different host apps and environments.

Floating Player States

The following states describe the transition between fullscreen and floating mode:

requestFloatingMode

The player is starting the transition into floating mode.

  • Triggered when the user or system requests the player to enter floating mode.

  • The player replaces its onscreen controls with a more suitable UI for floating mode.

  • Once the transition completes, the floating state is entered.

floating

The player has fully entered floating mode.

  • The floating mode UI is now active, providing minimal or more compact controls.

  • The user can interact with other content while the video remains visible.

  • If the user or system requests fullscreen again, the requestFullscreenMode state is triggered.

requestFullscreenMode

The player is starting the transition back to fullscreen mode.

  • Triggered when the user or system requests the player to return to fullscreen.

  • The floating mode UI begins transitioning back to the standard fullscreen controls.

  • Once the transition completes, the fullscreen state is entered.

fullscreen

The player has fully returned to fullscreen mode.

  • The default fullscreen controls are now active.

  • Any floating mode interactions are reset until requestFloatingMode is triggered again.


Properties

Name
Type
Description

mediaItemId

Required.

The mediaItemId property uniquely identifies the Media Item from which this message originates.

mediaItemType

Required.

messageType

Required.

lsc:player:ui-transition

playerUiState

Required.

The playerUiState property represents the current UI mode of the video player, determining how its controls and interface are adapted.

Possible values / transitions

  • fullscreen — The player is in fullscreen mode with standard controls.

  • floating — The player is in floating mode with an adapted UI.

  • requestFloatingMode → switches the player to floating.

  • requestFullscreenMode → transitions the player back to fullscreen.

Legacy Properties

If your integration uses LiSA Player Version 1, none of the properties described above will be available.

For LiSA Player Version 2, legacy properties can be ignored.

Name
Type
Description

action

Required.

target

Required.


Type Definition

interface PlayerUiTransitionMessage extends Omit<Message, 'messageType'> {
  mediaItemId: string;
  mediaItemType: MediaItemType;
  messageType: 'lsc:player:ui-transition';
  playerUiState: 
    | 'floating'
    | 'fullscreen'
    | 'requestFloatingMode'
    | 'requestFullScreenMode';
}

Examples

Host App Requests Floating Mode

{
  "messageType": "lsc:player:ui-transition",
  "playerUiState": "requestFloatingMode",
  "recipient": "LiSA",
  "sender": "HostApp",

  "action": "minimize",
  "target": "app"
}

Host App Confirms Floating Mode Entered

LiSA Player Version 1 does not support externally confirming when the player host component has completed its transition.

{
  "messageType": "lsc:player:ui-transition",
  "playerUiState": "floating",
  "recipient": "LiSA",
  "sender": "HostApp",
}

LISA Player Requests Fullscreen Mode

Triggered when the user taps the "Back to Fullscreen" CTA in the floating player’s onscreen controls.

LiSA Player Version 1 does not support requesting the host app to exit the floating state.

{
  "clockDriftInMs": 0,
  "mediaItemId": "9f333331-45cb-4289-8bcd-9023c1871111",
  "mediaItemType": "live",
  "messageType": "lsc:player:ui-transition",
  "playerUiState": "requestFullscreenMode",
  "recipient": "HostApp",
  "sender": "LiSA",
}

Host App Confirms Fullscreen Mode Entered

{
  "messageType": "lsc:player:ui-transition",
  "playerUiState": "fullscreen",
  "recipient": "LiSA",
  "sender": "HostApp",

  "action": "maximize",
  "target": "app"
}

Along with all standard , a UI Transition message includes the following additional properties:

The mediaItemType property specifies the type of Media Item from which this message originates. Refer to for detailed information.

maximize or minimize Please use messageType instead.

app Please use messageType instead.

string
MediaItemType
Literal
PlayerUiState
Literal
Literal
Picture-in-Picture guide
⚠️
⚠️
Message properties
MediaItemType