open_mini_player

The open_mini_player message is sent to show a mini video player within myzPAX.

Message Type

type messageType = 'open_mini_player';

Payload

type OpenMiniPlayerMessageData = {
  /** Video URL for the mini player. */
  src: string;
  /** Path of the video page for full-screen navigation. */
  videoPagePath: string;
  /** Volume of the mini player (0.0–1.0). */
  volume: number;
  /** Start time in seconds. */
  currentTime: number;
  /** Optional title of the mini player. */
  title?: string;
  /** Optional subtitle of the mini player. */
  subtitle?: string;
};

Example

sendZpaxMessage('open_mini_player', {
  src: 'https://cdn.com/video.mp4',
  videoPagePath: '/videos/123',
  volume: 0.7,
  currentTime: 5,
  title: 'Episode 1',
  subtitle: 'Pilot',
});

Use Cases

  • Show compact playback while user browses.
  • Resume video across app views.

Related