Deep Linking - Workflows
OPTIONAL
This information will demonstrate how to configure a button in your application or website to launch a specific tool using workflows.
If no workflow is specified, the app will launch directly into the screen recorder.
OPTIONAL A Workflow, also known as deep-linking, is a ScreenPal feature that allows a URL to specify how ScreenPal should open.
For example, adding &workflow=openVideoManager to a ScreenPal launching URL instructs ScreenPal to start up and then run the openVideoManagerWorkflow, which tells ScreenPal to show the Library Manager with the Videos Tab selected.
Workflows in the NO FILE REQUIRED section can simply be added as a {value} for workflow in the properties section of your JS file.
Workflows in the FILE/URL REQUIRED section will present a Drag and Drop window to the user by default.
- Append a workflow in the FILE/URL REQUIRED section with a file URL to specify a video file to be opened instead.
- e.g. "editVideo-https://something.com/example.mp4"
NO FILE REQUIRED:
{value} | Description |
---|---|
openVideoManager | Open to Video Manager Tab |
recorderWebcam | Launch in webcam only mode |
recorderWebcamBackgroundRemover | Record Webcam with Background Subtraction or Replacement |
recorderFreehand | Open Recorder + click "Free Hand Drawing Tool" to enter drawing mode |
FILE/URL REQUIRED
{value} | Description |
---|---|
editVideo | Open a video file in editor |
showCaptionsDialog | Open Editor + click to show captions dialog |
showMusicMenu | Open Editor + click the global add music menu |
mainVideoDialog | Open Editor + click "Main Video" to show the options dialog |
mainVideoCrop | Open Editor + click "Main Video" to show the options dialog + click toggled to "Crop" |
speedUp | Open Editor + click "Tools" menu + click "Speed" menu + show tooltip on "Speed Up" |
addTextToVideoTooltip | Open Editor + click "Tools" menu + click "Overlay" menu + show tooltip on "Text" |
soundEffectsToolMenu | Open Editor + click "Tools" menu + click sound effects menu + show tooltip on sound effects |
narrateToolMenu | Open Editor + click "Tools" menu + show tooltip on "Narrate" |
removeAudio | Open Editor + click "Tools" menu + edit volume |
The following workflows will only work if your license is configured to allow these features.
No File Required:
{value} | Description |
---|---|
openImageManager | Open to Image Manager Tab |
FILE/URL REQUIRED
{value} | Description |
---|---|
editImage | Open Image + Drag and drop image file |
imageEditorArrowTooltip | Open Image Editor + show tooltip on Arrow tool |
imageEditorFreehandTooltip | Open Image Editor + show tooltip on Freehand tool |
imageEditorShapeTooltip | Open Image Editor + show tooltip on Shape tool |
imageEditorBlurTooltip | Open Image Editor + show tooltip on Blur tool |
imageEditorStepsTooltip | Open Image Editor + show tooltip on Steps tool |
imageEditorTextTooltip | Open Image Editor + show tooltip on Text tool |
imageEditorHighlightTooltip | Open Image Editor + show tooltip on Highlight tool |
No File Required:
{value} | Description |
---|---|
createStory | Create new story with choice of story vs storyboard |
createStoryBoard | Create new story starting from story board |
FILE/URL REQUIRED
{value} | Description |
---|---|
editStory | Open Story + Drag and drop video file |