chattyshop
CHATTYSHOP DOCUMENTATION

How can we help?

Learn every part of ChattyShop—from your first menu board to advanced masks, live playlists, protected displays and account security.

DOCUMENTATION

All topics

26 complete guides
Getting started

Publish your first screen

Go from a new workspace to a protected TV link in four steps.

The fastest route

  • Start a 15-day trial of Basic, Pro or Premium.
  • Create a project from a blank canvas, a template, or Menu AI.
  • Edit the sequence and select Save, then Publish.
  • Open Displays, create a password-protected link, and load it on the TV or tablet.

Before you put it on a screen

Use Preview to check the complete loop, including entrances, exits, masks, media audio and daypart content. Keep text inside the visible canvas unless an off-screen entrance is intentional.

Back to top
Getting started

Create a project

Choose a canvas, template and project name with the project wizard.

Use the project wizard

Select New project from the dashboard. Name the project, choose a blank canvas or a template, and confirm the intended screen orientation. You can change the canvas width and height later in the Studio.

Choose the right canvas

  • 1920 × 1080 for standard landscape TVs.
  • 1080 × 1920 for portrait menu boards and kiosks.
  • 3840 × 2160 for 4K artwork when the playback device can handle it.
  • Use a custom size for LED walls or unusual panels.
Back to top
Getting started

Use and customize templates

Start from a professionally composed sequence without losing editability.

Templates are editable projects

A template supplies tracks, timing, effects, transitions, typography and assets. After creating a project from one, every layer can be renamed, restyled, retimed, replaced or removed.

Keep the composition readable

  • Replace text with similar-length copy before changing the layout.
  • Check contrast at the brightest and darkest point of animated media.
  • Preview the full loop after changing durations or keyframes.
Back to top
Studio editor

Canvas, layers and tracks

Understand position, stacking, selection and visible-canvas boundaries.

How stacking works

Track order defines z-index. A track higher in the timeline appears above tracks below it. Drag track handles to reorder the stack. Elements may move and scale beyond the canvas border; only the canvas area is shown on the display.

Layer controls

  • Hide an element without deleting it.
  • Lock it to prevent canvas and options-panel edits.
  • Disable selection when it should remain visible but not clickable.
  • Search by element name or show only layers visible at the playhead.
Back to top
Studio editor

Build reusable apps and nested sequences

Create a reusable mini-presentation and edit its sub-elements in a dedicated timeline.

Create and place an app

  • Open Apps in the Studio library and select Create app.
  • Build the app with its own canvas, tracks, elements, timing, effects and transitions.
  • Return to the parent sequence, then drag the app onto any track or use its Add button.

Edit a placed app

Double-click an app on the canvas, in the Layers panel or on its timeline clip to open its dedicated sequence editor. Save and use the back control to return. An app is referenced rather than copied, so a saved change appears in every parent sequence and display that uses it.

Back to top
Studio editor

Timeline, tracks and keyframes

Arrange elements over time and animate their properties precisely.

Edit timing

Drag an element to change its start time, drag either striped edge to change its duration, or move it to another track. Zoom around the playhead for second- and millisecond-level editing.

Animate with keys

  • Move the playhead and add a key for the selected property.
  • Dragging, scaling or rotating at a keyed time updates the nearby key or creates one.
  • Drag diamonds to retime keys; use Delete all keys to reset the element.
  • Use standard copy and paste shortcuts for selected timeline elements and Backspace to remove them.
Back to top
Studio editor

Transitions and effects

Combine entrance, exit and stackable visual effects without harming readability.

Transitions control arrival and departure

Choose entrance and exit styles independently and keep their duration shorter than the element duration. The floating effects browser previews available effects before you add them.

Build an effect stack

  • Add multiple effects and reorder them when their order changes the result.
  • Animate supported effect values with timeline keys.
  • Use blur, glow, noise, particles and distortion sparingly around menu copy.
  • Preview on the target playback device; intensive canvas effects need stronger hardware.
Back to top
Studio editor

Masks and blend modes

Reveal the track below through shapes, text or media and combine colors.

Mask the track below

Enable Mask track below on the upper element. Shape masks use their silhouette, text masks use the glyphs rather than the text box, and image or video masks use their alpha or luminance information.

Common causes of a blank mask

  • The mask and target do not overlap in space or time.
  • The target is not on the immediately lower track.
  • The mask element is hidden or has no visible alpha.
  • A browser-restricted cross-origin video cannot be sampled by canvas.
Back to top
Studio editor

Text, menu and ticker elements

Create readable copy, structured price lists and smooth moving announcements.

Choose the right element

  • Text is best for headings, captions and metadata.
  • Menu stores structured names, descriptions and prices in one editable element.
  • Ticker creates a continuous horizontal announcement. It stays still while editing and animates in Preview and on displays.

Typography guidance

Use large type, short lines and strong contrast for viewing at a distance. Custom fonts must finish loading before browser video export; ChattyShop preloads them before recording.

Back to top
Media & streams

Upload images, video and audio

Add files to the reusable Media library within plan storage limits.

Upload and reuse

Open Assets or the Studio Media tab and upload a supported file. Uploaded media is available across projects in the same workspace. Select multiple assets in Assets to remove them in one confirmed action.

Plan limits

  • Basic: 500 MB storage and 100 MB per upload.
  • Pro: 2 GB storage and 250 MB per upload.
  • Premium: 5 GB storage and 1 GB per upload.
Back to top
Media & streams

HLS, M3U and IPTV playlists

Play a live HLS manifest or select a starting channel from a playlist.

Add a playlist

Create a media stream element, paste the M3U or M3U8 URL and load the channel list. Choose the starting channel in the options panel. HLS playback uses native support where available and hls.js elsewhere.

Source requirements

  • The playlist and its media URLs must be reachable by the display device.
  • HTTPS pages cannot load insecure HTTP streams.
  • The source must permit browser cross-origin access.
  • Channel availability and licensing remain the responsibility of the playlist provider and workspace owner.
Back to top
Media & streams

Use an RTSP camera

Convert RTSP to browser-compatible HLS before adding the camera feed.

Browsers cannot play RTSP directly

Use a gateway such as MediaMTX or FFmpeg to ingest RTSP and expose HLS over HTTPS, then add the resulting M3U8 URL as an HLS element. hls.js plays HLS; it does not convert RTSP.

Reliability

Keep the gateway close to the camera, use a stable keyframe interval and monitor CPU, bandwidth and stream latency. ChattyShop retries interrupted playback until the source returns.

Back to top
Media & streams

Audio and live metadata

Enable sound and show track title, artist or channel metadata in text.

Audio on displays

Enable audio on the media element and set its volume. Some browsers require one user interaction before unmuted autoplay; confirm the TV browser policy during installation.

Render metadata

Add a text element, select Media metadata as its source, choose the video or radio element, then choose a field such as title, artist, station or channel. Metadata appears only when the source provides it and browser access permits reading it.

Back to top
Displays

Connect and protect a display

Create a password-protected player link for a TV, tablet or webview.

Create the link

  • Open Displays and enter a recognizable screen name.
  • Choose the assigned project and frame mode.
  • Use a unique password of at least six characters.
  • Open the generated link on the device and enter the display password once.

Status

The dashboard marks a display online after a successful player heartbeat. If a device is powered off or loses the network, its last-seen time remains available for diagnosis.

Back to top
Displays

Choose a display frame mode

Control how an authored canvas maps to a physical screen.

Available modes

  • Scale to Frame preserves the sequence ratio and fills the display; edges may crop.
  • Fit Frame stretches the sequence to the full display width and height.
  • Resize to Frame treats sequence coordinates as relative to the display and does not apply one uniform scale.

Recommendation

Use Scale to Frame when the screen and canvas share an aspect ratio. Use Fit Frame only when a small amount of distortion is acceptable. Test portrait and unusual LED installations directly on the target device.

Back to top
Displays

Scheduling and remote channel control

Assign daypart projects and control live playlist channels from a phone.

Daypart scheduling

Configure time windows in the display timezone to switch projects for breakfast, lunch, dinner or promotions. The default assigned project plays outside scheduled windows.

Secure remote

Open Remote on the display card to generate a password-protected deep link and QR code. Scan it with a phone to change supported playlist channels without touching the TV. Share the remote password only with trusted staff.

Back to top
Displays

Offline playback and prebuffering

Understand what remains available during temporary network loss.

Resilient playback

The player saves the latest project snapshot and prebuffers upcoming compatible media. A temporary API interruption can continue from the cached project, while external live streams still require their source network.

Install for reliability

  • Use wired Ethernet where possible.
  • Disable aggressive browser tab sleeping and device power saving.
  • Keep the player tab open in full-screen or kiosk mode.
  • Reopen the display after publishing major media changes to verify caching.
Back to top
Import & export

Share a complete project package

Export a compressed ZIP containing project JSON and referenced media.

Export

Download Project ZIP creates a compressed package with a manifest, the project and sequence JSON, and local media referenced by the project. Images and text compress strongly; already-compressed video and audio are stored efficiently without wasteful recompression.

Import

Use Import Project ZIP on the dashboard. ChattyShop validates paths, references and package size before uploading assets and creating the restored project. Do not rename or remove files inside the package unless you also update its manifest.

Back to top
Import & export

Sequence JSON and browser video export

Move sequence data or render a downloadable video entirely in the browser.

JSON

Sequence JSON is useful for transferring structure, timing and settings. It does not bundle uploaded media; use a Project ZIP when the recipient also needs the assets.

Video export

Download as video renders and encodes on the current device. ChattyShop preloads assets and fonts first. Keep the tab visible until export finishes. Cross-origin iframes such as YouTube may not be capturable because of browser security rules.

Back to top
Account & security

Plans, trials and cancellation

Compare entitlements and understand the one-time 15-day trial.

One trial per workspace

Basic, Pro and Premium each begin with a complete 15-day trial when the workspace has not used one before. Stripe collects a payment method and shows the date billing begins. Cancelling before that date prevents the first charge.

When access ends

Projects and uploaded files remain associated with the workspace, but creation, editing, uploading and display playback are locked until a subscription becomes active again. Cancelling or changing plans does not create another trial.

Back to top
Account & security

Enable two-step verification

Protect sign-in with an authenticator app and recovery codes.

Set up

  • Open Settings and select Two-step verification.
  • Scan the QR code with a compatible authenticator app.
  • Enter the current six-digit code to confirm setup.
  • Download or securely record the recovery codes; each can be used once.

If setup is unavailable

Accounts created through an externally managed identity may need to configure multi-factor authentication with that identity provider. Native ChattyShop password accounts can manage authenticator verification in Settings.

Back to top
Troubleshooting

A display is offline or blank

Check credentials, assignment, subscription, network and browser state.

Checklist

  • Confirm the workspace has an active trial or subscription.
  • Confirm the display has an assigned published project.
  • Reload the player link and enter the correct display password.
  • Check the device date, time, internet connection and HTTPS access.
  • Open the browser console only after the visible message and network checks do not identify the cause.
Back to top
Troubleshooting

Video, stream or audio does not play

Diagnose autoplay, CORS, source availability and codec problems.

Video and streams

  • Open the direct source URL on the display device.
  • Confirm HTTPS, CORS headers and a browser-supported codec.
  • For playlists, test the selected channel rather than only the playlist file.
  • ChattyShop retries interrupted streams continuously with a delay; a source that never returns still needs provider attention.

Audio

Enable element audio and raise its volume. If the browser blocks unmuted autoplay, interact with the page once or configure the TV browser for kiosk autoplay.

Back to top
Troubleshooting

The editor or animation feels slow

Reduce preview work while preserving full-quality published output.

Improve responsiveness

  • Close unused browser tabs and avoid multiple simultaneous 4K streams.
  • Use shorter preview ranges while editing complex scenes.
  • Reduce stacked canvas effects, particle counts and very large blur radii.
  • Use optimized media dimensions near the authored canvas size.
  • Test the final result in Preview or the display player, which uses the playback-optimized path.
Back to top