Query Parameter (v1)
Last updated
Last updated
replay_time
The replay_time parameter specifies the starting point for a show recording. By providing a numeric value, you can determine the exact time, in seconds, at which the playback should begin.
Accepted Value:
Any non-negative numeric value representing the desired start time in seconds.
(e.g., 0 for the beginning of the recording, 60 for one minute into the recording, etc.)
ui_close_icon
The ui_close_icon parameter specifies space reservation in the player's header for an external UI control, such as a close button. This ensures that external UI elements do not overlap with the player's built-in controls.
Value Pattern: (left|right)(:width)?(:height)?
left or right: Specifies the side of the viewport where the space is reserved.
:width (optional): The width of the reserved space, specified as a valid CSS length (e.g., 32px, 2em). If omitted, the default width is 32px.
:height (optional): The height of the reserved space, specified as a valid CSS length. If omitted, the default height matches the width.
Default Behavior:
If only the side (left or right) is provided, a default space of 32x32px is reserved.
If one additional value is provided, it applies to both width and height.
If both width and height are provided, they are applied independently.
Example Usage:
Default size on the right — Reserves 32x32px in the top-right corner
Custom size on the right — Reserves 42x42px in the top-right corner
Custom width and height on the left — Reserves 50px width and 40px height in the top-left corner.
url_params
The url_params parameter allows you to append custom query parameters to URLs exposed by the LiSA Player, such as those used for social sharing or add-to-calendar options. This enables you to include additional data or tracking parameters in a structured and URL-safe manner.
Usage Guidelines:
Provide the query parameters in URL-encoded form.
Use standard query string syntax: key1=value1&key2=value2.
Example Usage:
To append utm_source and utm_campaign parameters:
To append a custom parameter:
This parameter allows you to extend the functionality of URLs for tracking or customization, ensuring seamless integration with your workflows and analytics tools.