Basic Uploader Properties

55 min

overview for background information, see basic uploader javascript settings docid 9gsxhqrh7xjsv73e51wat below is a list of properties that you may configure from your basic uploader docid 42txky0k3olytswsglysh javascript file basic uploader properties basicupload failed message docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload offer savevideo docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload launch event url docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel button title docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel input description label docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel input description required docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel input description required message docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel input description show docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel input title label docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel input title required docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel input title required message docid\ s0ksaqafgnpfvbpnwmsla \optional\ \ \ basicupload panel input title show docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel message docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel title docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload panel input choose replace show docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload post extraheaders 1 docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload post maxwidth docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload post method docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload preview\ title docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload request url docid\ s0ksaqafgnpfvbpnwmsla \required\ basicupload session data docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload site name docid\ s0ksaqafgnpfvbpnwmsla \required\ basicupload success message docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload success showlink docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload success url docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload virtualbackground enabled docid\ s0ksaqafgnpfvbpnwmsla \optional\ locale docid\ s0ksaqafgnpfvbpnwmsla \optional\ som app content subdirectory docid\ s0ksaqafgnpfvbpnwmsla \required\ som app drawandzoom enabled docid\ s0ksaqafgnpfvbpnwmsla \optional\ som app editing enabled docid\ s0ksaqafgnpfvbpnwmsla \optional\ som app frame title docid\ s0ksaqafgnpfvbpnwmsla \required\ workflow docid\ s0ksaqafgnpfvbpnwmsla \optional\ basicupload failed message \optional\ \ \ the message displayed if the upload fails "basicupload failed message"="upload failed please check your anti virus and network connection " basicupload offer savevideo \optional \ displays the save as video file ui to allow the user to save their recording locally to a file "basicupload offer savevideo"="true" basicupload launch event url \optional \ this specifies a url that is opened by screenpal each time it is launched see solution builder launch event docid 7ipg3enck51rtgd0xfmic for more information if this property is not overridden, then its default value is used, which is shown in the example code below you may override it with your own url "basicupload launch event url"="https //screenpal com/api/v2/solution builder/event" basicupload panel button title \optional\ \ \ the text for the button that starts the upload "basicupload panel button title"="upload" basicupload panel input description label \optional\ \ \ the text for the input description field also see basicupload panel input description required docid\ s0ksaqafgnpfvbpnwmsla and basicupload panel input description show docid\ s0ksaqafgnpfvbpnwmsla "basicupload panel input description label"="\description\" basicupload panel input description required \optional \ specifies if the description is optional or required to be input by the user before the "upload" button will be enabled also see basicupload panel input description label docid\ s0ksaqafgnpfvbpnwmsla and basicupload panel input description show docid\ s0ksaqafgnpfvbpnwmsla "basicupload panel input description required"="false" basicupload panel input description required message \optional \ the message displayed to the user to inform them that the description field is required to be entered before the "upload" button will be enabled also see basicupload panel input description label docid\ s0ksaqafgnpfvbpnwmsla , basicupload panel input description required docid\ s0ksaqafgnpfvbpnwmsla , and basicupload panel input description show docid\ s0ksaqafgnpfvbpnwmsla "basicupload panel input description required message"="please enter a description " basicupload panel input description show \optional \ specifies if the description field is displayed or not also see basicupload panel input description label docid\ s0ksaqafgnpfvbpnwmsla and basicupload panel input description required docid\ s0ksaqafgnpfvbpnwmsla "basicupload panel input description show"="true" basicupload panel input title label \optional\ \ \ the text above the title field also see basicupload panel input title required docid\ s0ksaqafgnpfvbpnwmsla , basicupload panel input title required message docid\ s0ksaqafgnpfvbpnwmsla , and basicupload panel input title show docid\ s0ksaqafgnpfvbpnwmsla "basicupload panel input title label"="\title\" basicupload panel input title required \optional \ specifies if the title is optional or required to be input by the user before the "upload" button will be enabled also see basicupload panel input title label docid\ s0ksaqafgnpfvbpnwmsla , basicupload panel input title required message docid\ s0ksaqafgnpfvbpnwmsla , and basicupload panel input title show docid\ s0ksaqafgnpfvbpnwmsla "basicupload panel input title required"="true" basicupload panel input title required message \optional\ \ \ the message displayed to the user to inform them that the title field is required to be entered before the "upload" button will be enabled also see basicupload panel input title label docid\ s0ksaqafgnpfvbpnwmsla , basicupload panel input title required docid\ s0ksaqafgnpfvbpnwmsla , and basicupload panel input title show docid\ s0ksaqafgnpfvbpnwmsla "basicupload panel input title required message"="please enter a title " basicupload panel input title show \optional \ specifies if the title field is displayed or not also see basicupload panel input title label docid\ s0ksaqafgnpfvbpnwmsla , basicupload panel input title required docid\ s0ksaqafgnpfvbpnwmsla , and basicupload panel input title required message docid\ s0ksaqafgnpfvbpnwmsla "basicupload panel input title show"="true" basicupload panel message \optional\ \ \ the text to show at the top of the upload ui panel "basicupload panel message"="enter values below then click upload to start uploading " basicupload panel title \optional\ \ \ the text to show as the title for the upload ui panel "basicupload panel message"="upload" basicupload panel input choose replace show \optional\ displays a checkbox in the upload ui that lets the user choose whether to replace an existing video or upload a new one this checkbox is only meaningful when combined with the basicupload session data property behavior if basicupload panel input choose replace show is set to "true" the upload ui will show a checkbox labeled something like "replace current upload" the checkbox has additional show/hide considerations as well if the video has previously been published, then the checkbox will show on subsequent attempts to publish that project if an editvideo url workflow is used on initial launch of a project, then the replace checkbox will also show on first attempt to publish the checkbox state is remembered across launches within the same project "basicupload panel input choose replace show" "true" example workflow you launch screenpal with "workflow" "editvideo https //files screencast o matic com/original mp4", "basicupload session data" "{\\"originalurl\\" \\"https //files screencast o matic com/original mp4\\"}", "basicupload panel input choose replace show" "true" on upload, the user is prompted to enter a title and description and is given the option to replace current upload via a checkbox if checked, the upload request might look like post /basicuploads3upload php?id=myid content type multipart/form data title=updated video description=shortened version with intro session data={"originalurl" "https //files screencast o matic com/original mp4"} choose replace=true basicupload post extraheaders 1 \optional \ this is useful for when you want to upload to aws s3 and need to set the access control list to allow the uploaded video to be read by anyone note that you may add more than one extra header by adding another entry with the number incremented, such as basicupload post extraheaders 2 "basicupload post extraheaders 1" "x amz acl\ public read" basicupload post maxwidth \optional \ to reduce the size of videos that are posted to your servers, you may specify a video pixel width limit videos that are smaller than that will not be altered "basicupload post maxwidth" "1280" basicupload post method \optional \ this is useful for when you want to upload to aws s3 and need to set the post method to put "basicupload post method" "put" basicupload preview\ title \optional\ \ \ the text to show for the title during video preview "basicupload preview\ title"="preview" basicupload request url \required \ specifies the url to use when uploading the video if you are also using basicupload success url (success callback property) , then use a url parameter like id=myid to link this call to basicupload success url docid\ s0ksaqafgnpfvbpnwmsla the url used to post the mp4 video file if you do not use the title and description options, then a get request is used instead "basicupload request url" "https // /basicuploads3upload php?id=myid" basicupload session data \optional\ this property allows you to pass in custom metadata (such as the url or identifier of the original video) that gets stored in the associated video project and later returned as part of the video upload request it enables functionality such as "replace existing upload" docid\ s0ksaqafgnpfvbpnwmsla when editing previously hosted videos purpose this property supports workflows like editvideo url , where a user downloads and edits a previously uploaded video including this property ensures the backend can track and optionally replace the original video when the user re uploads it the value of basicupload session data is included in the post request to basicupload request url under the key session data , along with other form fields such as title and description "basicupload session data" "{\\"originalurl\\" \\"https //files screencast o matic com/video123 mp4\\"}" persistence across sessions if the user records a video but does not immediately upload it, the session data will be saved to the video project when the video is uploaded later—either from the project manager or editor—the session data is preserved and included in the upload request basicupload site name \required\ \ \ the text to display while a video is uploading "basicupload site name" "example site" basicupload success message \optional\ \ \ the text to display when an upload is successful "basicupload success message"="upload successful!" basicupload success showlink \optional \ optionally display a url to the user that accesses the successfully uploaded video the url is from the basicupload success url docid\ s0ksaqafgnpfvbpnwmsla property "basicupload success showlink"="false" basicupload success url \optional \ the url optionally shown for accessing a successfully uploaded video also see basicupload success showlink docid\ s0ksaqafgnpfvbpnwmsla "basicupload success url" "https // /basicuploadsuccess php?id=myid" basicupload virtualbackground enabled \optional \ you may choose to enable the virtual background feature to support blur and background replacement if this property is omitted, the default state will be enabled if screenpal is hosting your files (jars, installers, etc ) then simply use true,false, or omit the property accordingly (if you want it enabled) if you are hosting the files, and you have this set to true, or have the property omitted, then you will need to ensure you are also hosting the following files https //s3 amazonaws com/files screencast o matic com/jars/som native cv win64 0 1 3 zip https //s3 amazonaws com/files screencast o matic com/jars/som native cv osx64 0 1 3 zip https //s3 amazonaws com/files screencast o matic com/jars/som native cv aarch64 0 1 3 zip "basicupload virtualbackground enabled" "true" locale \optional \ the locale (language) to use in the screenpal application value language de german en english es spanish fr french it italian ja japanese pt br portuguese (brasil) zh chinese "locale" "en" som app content subdirectory \required\ \ \ this is the subdirectory where your user's recordings will be stored for example,"c \users\\\[username]\screen recorder\recordings" and "c \users\\\[username]\screen recorder\screenshots", if you set the value to "screen recorder" "som app content subdirectory" "screen recorder" som app drawandzoom enabled \optional \ optionally show the show draw & zoom controls button on the screenpal recorder "som app drawandzoom enabled" "true" som app editing enabled \optional \ optionally show the edit video button on the upload ui panel "som app editing enabled" "true" som app frame title \required\ \ \ this is the title shown on the window for the application "som app frame title" "screen recorder" workflow \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 openvideomanager workflow, which tells screenpal to show the library manager with the videos tab selected for more information see deep linking workflows docid\ fcjbaomsucbu8clrs0tm5