Website logo
āŒ˜
K
šŸŒ
Home
šŸ› ļø
SDK & API
šŸ‘©ā€šŸ’»
SDK & API - Legacy
ā™æ
VPATs
Overview of the Screen Recorder Launcher API
Getting Started with the Screen Recorder Launcher API
Screen Recorder Launcher API Functions (cloned)
Configure the Basic Uploader
Basic Uploader Properties
Configure the Custom Uploader
Questions and Answers about the Screen Recorder Launcher API
Get Support
Docs powered byĀ Archbee

Basic Uploader Properties

25min

Use the following properties to specify the upload of the recorded screen capture. Note that some properties are required and others are optional. Specify any of these by adding them to the launch properties.

Common Basic Properties

  • basicupload.failed.message
  • basicupload.panel.button.title
  • basicupload.panel.input.description.label
  • basicupload.panel.input.description.required
  • basicupload.panel.input.description.show
  • basicupload.panel.input.title.label
  • basicupload.panel.input.title.required.message
  • basicupload.panel.input.title.required
  • basicupload.panel.input.title.show
  • basicupload.panel.message
  • basicupload.panel.title
  • basicupload.post.maxwidth
  • basicupload.request.url (REQUIRED)
  • basicupload.preview.title
  • basicupload.site.name (REQUIRED)
  • basicupload.success.message
  • basicupload.success.showlink
  • basicupload.success.url
  • Basic Property Overrides

Other Useful Basic Properties

basicupload.failed.message

This optional parameter provides the message displayed if the upload fails.

JS
1basicupload.failed.message="Upload failed. Please check your anti-virus and network connection."
ļ»æ

ļ»æ

basicupload.panel.button.title

This optional parameter provides the text for the button that starts the upload.

JS
1basicupload.panel.button.title="Upload"
ļ»æ

ļ»æ

basicupload.panel.input.description.label

This optional parameter provides the text for the input description field.

JS
1basicupload.panel.input.description.label="<b>Description</b>"
ļ»æ

This parameter is related toĀ basicupload.panel.input.description.requiredļ»æĀ andĀ basicupload.panel.input.description.showļ»æ.

basicupload.panel.input.description.required

This optional parameter specifies if the text for the input description field is required or optional. For example, the following line specifies that the text is optional:

JS
1basicupload.panel.input.description.required="false"
ļ»æ

This parameter is related toĀ basicupload.panel.input.description.requiredļ»æĀ andĀ basicupload.panel.input.description.showļ»æ.

basicupload.panel.input.description.show

This optional parameter specifies if the input description field is displayed or not. For example, the following line specifies that the field is displayed:

JS
1basicupload.panel.input.description.show="true"
ļ»æ

ļ»æ

basicupload.panel.input.title.label

This optional parameter provides the label text for the input title field.

JS
1basicupload.panel.input.title.label="<b>Title</b>"
ļ»æ

ļ»æ

basicupload.panel.input.title.required.message

This optional parameter provides the text for the input title required message.

JS
1"basicupload.panel.input.title.required.message"="Please enter a title."
ļ»æ

ļ»æ

basicupload.panel.input.title.required

This optional parameter specifies if the text for the input title field is required or optional. For example, the following line specifies that the text is required:

JS
1"basicupload.panel.input.title.required"="true"
ļ»æ

ļ»æ

basicupload.panel.input.title.show

This optional parameter specifies if the input title is displayed or not. For example, the following line specifies that the title is displayed:

JS
1"basicupload.panel.input.title.show"="true"
ļ»æ

ļ»æ

basicupload.panel.message

This optional parameter specifies a short message to show at the top of the panel.

JS
1"basicupload.panel.message"="Enter values below then click Upload to start uploading."
ļ»æ

ļ»æ

basicupload.panel.title

This optional parameter specifies the title to show above the panel.

JS
1"basicupload.panel.message"="Upload"
ļ»æ

ļ»æ

basicupload.post.maxwidth

This optional parameter restricts the size (to a maximum width) of the encoded video to upload during encoding. The following line reduces the encoded video to 1280Ā px. Recordings with a width smaller than 1280Ā px are not altered.

JS
1"basicupload.post.maxwidth":"1280"
ļ»æ

ļ»æ

basicupload.request.url

This required property specifies a URL to use when uploading the video.

Note:Ā If you are also usingĀ basicupload.success.urlĀ (success callback property), use a URL parameter likeĀ id=myidĀ to link this call toĀ basicupload.success.url.

This property expects a response containing a string with the URL that the recording uses to POST the mp4 video file. The example version offers a way to collect inputā€”specifically a title and a descriptionā€”before uploading. If you use these options, the values are POSTed to theĀ basicupload.request.url. If you do not use the title and description options, this parameter provides a GET request to the URL.

JS
1"basicupload.request.url":"https://.../basicuploadS3Upload.php?id=myid"
ļ»æ

ļ»æ

basicupload.preview.title

This optional parameter specifies the title to show during the preview.

JS
1"basicupload.preview.title"="Preview"
ļ»æ

ļ»æ

basicupload.site.name

This required property displays to the user while uploading for example the below setting will display "Uploading to Example Site" while a video is uploading.

JS
1"basicupload.site.name":"Example Site"
ļ»æ

ļ»æ

basicupload.success.message

This optional parameter provides the message that displays when an upload succeeds.

JS
1"basicupload.success.message"="Upload Successful!"
ļ»æ

ļ»æ

basicupload.success.showlink

When set toĀ trueĀ and aĀ basicupload.success.urlĀ is set, this optional parameter provides a link that the user can copy. The link displays under theĀ basicupload.success.message. The link is the result text returned by theĀ basicupload.success.urlĀ callback, which you can set up in JavaScript.

JS
1"basicupload.success.showlink"="false"
ļ»æ

ļ»æ

basicupload.success.url

This optional parameter provides a URL that is called back if the upload is successful.

JS
1"basicupload.success.url":"https://.../basicuploadSuccess.php?id=myid"
ļ»æ

ļ»æ

Basic Property Overrides

The following examples show how to override some display properties. You can also set these by using your ownĀ BasicUploadSkinĀ jar with custom settings in theĀ appDisplay.properties.

JS
1"basicupload.panel.message":"Show optional input fields to POST back when requesting upload url", 2"basicupload.panel.input.title.show":"true", 3"basicupload.panel.input.description.show":"true"
ļ»æ

Other Useful Basic Properties

The following properties are useful for direct Amazon S3 upload.

JS
1"basicupload.post.method":"PUT", 2"basicupload.post.extraheaders.1":"x-amz-acl:public-read"
ļ»æ

For an example Amazon S3 upload, seeĀ Setting the Basic Upload URL (S3 Amazon Example).ļ»æļ»æ

Updated 01 Sep 2023
PREVIOUS
Configure the Basic Uploader
NEXT
Configure the Custom Uploader
Docs powered byĀ Archbee
TABLE OF CONTENTS
Common Basic Properties
Other Useful Basic Properties
basicupload.failed.message
basicupload.panel.button.title
basicupload.panel.input.description.label
basicupload.panel.input.description.required
basicupload.panel.input.description.show
basicupload.panel.input.title.label
basicupload.panel.input.title.required.message
basicupload.panel.input.title.required
basicupload.panel.input.title.show
basicupload.panel.message
basicupload.panel.title
basicupload.post.maxwidth
basicupload.request.url
basicupload.preview.title
basicupload.site.name
basicupload.success.message
basicupload.success.showlink
basicupload.success.url
Basic Property Overrides
Other Useful Basic Properties
Docs powered byĀ Archbee