Configuring the Custom Uploader

Configuring the Custom Uploader



Configuring the Custom Uploader

Use the following information as a guide to configure the features of custom publishing.

Table of Contents

Description of Custom Uploading

Use Custom Uploading, rather than basic uploading, where a custom uploading API is required and when you need to create your own user interface (UI).

You can design the UI with additional controls not contained in the basic uploader. This allows the user to enter metadata through any configured web-interface control (for example, to input additional information that is uploaded with the recording).

App Display properties allow you to customize branding and message strings in the screen recorder and video editor.

custombranding.png

The added optional input fields POST back when requesting the upload URL. For a custom upload, create a Java jar file with code that implements the Custom Publish interface.

In the jar file you create, account for:

  • Upload properties
  • Skin images
  • Other properties

The following steps outline the custom publishing process:

  1. Implement the CustomPublish Java interface class.
  2. Create a signed jar with a class that implements the CustomPublish Java interface and any additional classes created to support the upload process.
  3. Host the jar in the jarHostPath.
  4. Add the jar to the jars list.
  5. Remove the BasicUploadSkin.jar (if present).

Sample Custom Publishing Implementation

The following is an example structure of a custom publishing implementation:



CustomPublishExampleSrc | appDisplay.properties
| frame_icon.png | publish_customupload_16.png | publish_customupload_24.png | publish_customupload_48.png | \---com \---screencastomatic \---custompublish
CustomPublishImpl.java
  

File Specifications

The sizes for the 96-dpi png icons are as follows:

  • frame_icon.png: 48x48
  • publish_customupload_16.png: 16x16
  • publish_customupload_24.png: 24x24
  • publish_customupload_48.png: 48x48

CustomPublishImpl.java

Screencast-O-Matic will provide example files to you.

Custom Publishing Sample (HTML)

Screencast-O-Matic will provide example files to you.

appDisplay.properties

The following properties can be set in the appDisplay.properties file:

som.*.app.frame.title

This property contains the title displayed on the window for the application.


som.*.app.frame.title=Mybrand


som.*.app.preview.title

This property contains the title displayed at the top of the window when viewing the preview after recording.


som.*.app.preview.title=Upload to Mybrand

som.*.app.drawandzoom.enabled

This property enables and disables the Show Draw and Zoom tool on the recorder.\


som.*.app.drawandzoom.enabled=true

som.*.app.editing.enabled

This property enables and disables the Show Edit button to offer editing after recording.


som.*.app.editing.enabled=true

som.*.app.upload.message

This property contains the message displayed after upload is complete. (Note the TITLE_REPLACE which we will replace using the setDoneMessage in the CustomPublishImpl as an example that you can update this message dynamically or replace the complete message. ) 


som.*.app.upload.message=\
<div style="font-size:17pt; text-align:left;">\
Uploaded Video:<br>\
<b>TITLE_REPLACE</b>\
<br><br>\
You can set up a custom message here and also:\
<ul>\
<li>Choose if you want to show the link below.<br><br></li>\
<li>Choose if you want to launch a url when the <b>Continue</b> button below is pressed so you can direct the user to a 
playback page or any other url.</li>\
</ul>\
<br>For example, this app is set to go to Screencast-O-Matic.com when you click <b>Continue</b>\
</div>

som.*.app.upload.deleteafter

When this property is set to true, the app deletes the local recording after a successful upload. When this property is set to false, the app does not remove the local recording.


som.*.app.upload.deleteafter=true

This property enables and disables the Show a link and copy button for the URL returned after upload is complete.


som.*.app.upload.showlink=true

som.*.app.upload.onexit.action

This property provides an optional link to launch after the user clicks the button when upload is complete. Omit this setting if no page needs to launch. Otherwise, set this property to a URL or to the string "gotoplayback," which launches the URL you returned after the upload is complete.


som.*.app.upload.onexit.action=http://screencast-o-matic.com/

som.*.app.content.subdirectory

This property sets the subdirectory to store your users’ recordings. The default location where this subdirectory is created is Documents. The following example creates Documents\Screen Recorder, and adds a Recordings directory with a subdirectory for each recording stored on the computer (Documents\Screen Recorder\Recordings\individual recording folders).


som.*.app.content.subdirectory=Screen Recorder

som.*.app.custompublish.name

This property sets the name shown in the app. For example, "Upload to Mybrand."


som.*.app.custompublish.name="Upload to Mybrand"

som.*.app.custompublish.class

This property specifies the class that you provide to implement the com.screencastomatic.CustomPublish interface.


som.*.app.custompublish.class=com.screencastomatic.custompublish.CustomPublishImpl


    • Related Articles

    • Configuring 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. ...
    • 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 ...
    • Configuring Zoom to Create Recordings Optimized for Editing

      If you want to import Zoom recordings to edit in the Screencast-O-Matic Video Editor you should configure Zoom to create recordings that are optimized for editing.  Zoom calls this option " Optimize the recording for 3rd party video editor"  or " ...
    • 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 ...