Skip to content

Video reference

reference
5 min readUpdated

Video actions at a glance

The Videos surface brings together narrated walkthrough videos for your manual pages. Use it to play a video, share it, download it, edit its spoken script, or request a re-render after changing the script.

The page introduces the video workflow in three stages:

If you need to…Go to
Start generating narrated walkthroughsTurn on video
Let Atloria record each pageAtloria records
Adjust the spoken script and update the resultEdit & re-render
Find the available actions for an existing videoUnderstand the video surface
Open and play a videoFind a video, then Review a video
Share or download a videoChoose and use a video action

Before you start

The project selected in the header determines which enterprise surfaces you work with. The Videos page can be loading, empty, or populated. A selected video can have a player, sharing and download actions, and an editable script; each area appears only when its required video data is present.

What is trueWhat you see
No project is selectedVideos, No project selected, and a hint telling you that the project dropdown sets the project for every enterprise surface
Videos are loadingNarrated videos and Loading videos…
The list is emptyThe generation explanation and either Generate narrated videos or Open project to generate
A selected video has a video URLA video player and distribution actions
The project has no published share slugThe share link uses the standalone player, and the page displays Publish the project for a live-page share link.
A selected video existsThe selected video's editor area

Use the condition that matches your screen, then continue by finding a video or following the empty-state path.

Find a video

Open Videos in the Enterprise area. The page landed at https://atloria.dev/app/enterprise/videos.

The empty Videos surface with the generation path and project context

Prerequisites

  • You have a project selected in the header.
  • You know whether you are looking for an existing video or the empty-state generation path.

Steps

  1. Select Videos in the Enterprise area.
  2. Choose the path that matches what is on screen.
What you seeAction
A video rowRead its slug and status, then select the row.
An empty listSelect Open project to generate.

Result: The Videos surface is open with the selected video, or the empty-state generation path is open.

Understand the video surface

A video surface is the place where you play a selected walkthrough and work with its spoken narration. The player and distribution area appear when the selected video has a video URL. The script area contains one multiline field for Intro, one for each script step in the corresponding script field, and Outro when the selected video has an editable script.

The script fields have no required marker or field-level pattern rule. A video without an editable script displays This video has no editable script. in place of those fields. The video list uses selectable rows identified by slug and status.

Surface areaWhat it containsWhen it appears
PlayerNative video controlsThe selected video has a video URL
DistributionCopy share link, Copy embed code, and DownloadThe selected video has a video URL
ScriptIntro, step fields, and OutroThe selected video has an editable script
Editor actionsSave script and Re-render videoA selected video exists

Choose and use a video action

Use the action that matches the result you need. Sharing and downloading use a selected video with a player. Editing changes the spoken script, and re-rendering updates the video from that script. Script editing and re-render are Pro features.

Share or download a video

Prerequisites

  • A video is selected.
  • The selected video has a player and distribution area.

Steps

  1. Select one action from the table.
GoalAction
Share a linkCopy share link
Embed the videoCopy embed code
Download the fileDownload

Result: The selected sharing or download action is complete.

Edit and save the spoken script

Prerequisites

  • A video is selected.
  • The selected video has an editable script.

Steps

  1. Enter the opening narration in Intro.
  2. Enter each step's narration in the corresponding script field.
  3. Enter the closing narration in Outro.
  4. Select Save script.

Result: The page displays Script saved. Re-render to update the video.

Re-render the video

Prerequisites

  • A video is selected.
  • The script changes have been saved.

Steps

  1. Select Re-render video.

Result: The page displays Re-render queued — the video will refresh shortly.

Handle unavailable video actions

The available actions depend on the project and selected video. Use the branch that matches what is on screen rather than looking for controls that belong to another state.

Prerequisites

  • The Videos surface is open.

Steps

  1. Choose the available path in the table that matches the displayed state.
What you seeAvailable path
No project selectedSelect a project from the header dropdown.
Turn your manual into narrated videosSelect Open project to generate.
This video has no editable script.Use the player or distribution actions that are present.
Publish the project for a live-page share link.Use the standalone player link until the project is published.
Could not copy to the clipboard.Use the share or embed action again.
Script editing is unavailableUse the available viewing, sharing, or download action.

Result: The available path for the displayed state is clear, from selecting a project or opening the generation path to using the actions that are present.

If an action displays an error or plan message, continue with the matching message in the troubleshooting table.

When a video action goes wrong

Match the message on screen to the action you used.

MessageWhat it meansNext action
Could not copy to the clipboard.The requested text was not copied.Select Copy share link or Copy embed code again.
Could not save the script.The script save did not complete.Review the script fields and select Save script again.
Could not queue a re-render.The re-render request did not enter the queue.Select Re-render video again.
Editing the narration script is a Pro feature. Upgrade to edit.Script editing requires Pro.Use the available video actions or upgrade before editing.
Re-rendering video is a Pro feature. Upgrade to re-render.Re-rendering requires Pro.Use the existing video or upgrade before re-rendering.

Continue from the Videos surface

For broader destination context and related surfaces, open Videos overview. For the procedure for opening and playing a video, open Review a video.

Was this page helpful?

Download as PDF
Video reference — Atloria (self dogfood)