Basic Uploader Properties

Basic Uploader Properties

Basic Uploader Properties

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.

Table of Contents 

basicupload.failed.message

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


basicupload.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.


basicupload.panel.button.title="Upload"

basicupload.panel.input.description.label

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


basicupload.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:


basicupload.panel.input.description.required="false"

This parameter is related to basicupload.panel.input.description.label 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:


basicupload.panel.input.description.show="true"

basicupload.panel.input.title.label

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


basicupload.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.


"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:


"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:


"basicupload.panel.input.title.show"="true"

basicupload.panel.message

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


"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.


"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.


"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.



basicupload.preview.title

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


"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.


"basicupload.site.name":"Example Site"

basicupload.success.message

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


"basicupload.success.message"="Upload Successful!"

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.


"basicupload.success.showlink"="false"

basicupload.success.url

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


"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.


"basicupload.panel.message":"Show optional input fields to POST back when requesting upload url",
"basicupload.panel.input.title.show":"true",
"basicupload.panel.input.description.show":"true"

Other Useful Basic Properties

The following properties are useful for direct Amazon S3 upload.


"basicupload.post.method":"PUT",
"basicupload.post.extraheaders.1":"x-amz-acl:public-read"

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


    • Related Articles

    • Configure the Basic Uploader

      Configuring the Basic Uploader Use the following information as a guide to configure how the basic uploader uploads a finished video file. Also see Setting Basic Uploader Properties for other properties you can set to customize the user interface. ...

    • Configure the Custom Uploader

      Use the following information as a guide to configure the features of custom publishing. Table of Contents Description Sample Custom Implementation File Specifications CustomPublishImpl.java Custom Publishing Sample (HTML) appDisplay.properties ...

    • Overview of the Screen Recorder Launcher API

       Overview of the Screen Recorder Launcher API This guide is for customers who have the Enterprise or Solution Builder Plan and want to incorporate the screen recorder software into their network and application(s). The guide can also be used to ...

    • Screen Recorder Launcher API Functions

       Screen Recorder Launcher API Functions Use the Screen Recorder Launcher API to create a global SOMLauncher javascript object. This object exposes the functions contained in this article. First you'll need to download and host the API javascript ...

    • Questions and Answers about the Screen Recorder Launcher API

      Questions and Answers about the Screen Recorder Launcher API This article contains users' questions and answers regarding the Recorder Launcher API. Table of Contents Can we specify "screen and webcam," or the desired resolution, automatically from ...