The following options can be configured for Rocketium Button.
Key | Type | Value |
entry-point | String | This controls what opens when the editor is opened by users. Allowed values are |
button-mode | String | Allowed values |
editor-type | String | Defines how the editor will open. There are two possible values for this |
appendTo | String | ID of the |
clientId | String | Unique identifier for your account. (contact Rocketium support) |
workspaceId | String | ID of the workspace where you want videos to be saved. |
templateId | String | ID of the template that should be opened by the editor. Once you export your template video, you can go to the Code tab within the Share settings of that video to get the template ID. |
export-type | String | Allowed values are |
layout (optional) | Boolean | Controls whether users can browse and choose individual layouts for every scene they add. Default value is |
layout-panes (optional) | String | What layout panes to show, Applies if |
layout-visibility (optional) | String | Whether to show |
voice-over (optional) | Boolean | Controls whether users can add voice-overs from Rocketium's voice-over module. |
media-library (optional) | Boolean | Controls whether users can access past images, videos, and music uploaded to your account. Default value is |
show-Workspacelevel-Media (optional) | Boolean | If |
stock-library (optional) | Boolean | Controls whether users can search Rocketium's stock footage and image library. Default value is |
media-upload (optional) | Boolean | Controls whether users can upload images and videos from their local machine. Default value is |
preview (optional) | String | if Controls the features available to users in the preview. Can be either of ​ if |
button-text (optional) | String | Text shown on the button |
button-image (optional) | String | Image shown on button |
button-color (optional) | String | Color of the button. Please provide a color hex-code |
button-hidden (optional) | Boolean | Controls if the button should be hidden at launch. Default value is |
editor-button-text (optional) | String | text shown on the editor button. Default will be |
export-and-close (optional) | Boolean | If |
export-on-error (optional) | Boolean | If |
export-setting (optional) | Boolean | Controls whether export setting options to be shown or not. Default value is |
fullHd (optional) | Boolean | Controls whether users see 1080p as an export option in export settings. Default value is |
export-quality (optional) | String | Quality of the exported video. Can be |
hide-export-button (optional) | String | Controls whether export video button to be shown or not. You would need to define your own button to call the |
video-name (optional) | String | Name of the video. This will be name for the video in the Rocketium dashboard. |
metadata (optional) | Object | Custom information about the video that you can pass. |
template-config (optional) | Allows you to configure which templates will be shown in the template selection screen. This is only applicable if | |
custom-media-search (optional) | Enables Rocketium to fetch tagged media links from client servers and show them inside Rocketium's media library. A GET HTTP method API required to be shared by the client. | |
theme-css-url (optional) | String | Enables changing the style of the white-label editor. You need to maintain a css file at your end with values for various CSS classes and provide the link to the file in this config. ​Sample CSS file​ |
campaignId | String | campaignId of what campaign to open. |
features (optional) [DRAFT] | Specify the features that will be available in the editor |
Key | Type | Value |
url | String | API URL endpoint to get media assets. Rocketium Button will make an HTTP GET request to your API. We support only REST APIs. This URL should not end in "/". (Required) |
request-headers | String | Extra headers parameters that needs to be passed to API like Authorisation/authentication tokens. (optional) |
user-id | String | Any custom tag to be queried, that the media assets are tagged with. workspaceId is used if no value is specified |
filter-assets | String | Filter assets that you want in media library, It can be either |
pagination | Boolean | Set this flag to true if the API supports the pagination. Default value is |
limit | Number | Sets the limit on the number of media assets fetched from API. |
"custom-media-search":{"url": "<API to call>","request-headers":["<header1>", "<header2>"],"filter-assets":"custom","limit" : 20,"user-id":"<userId/workspaceId>","pagination": true}
[{"thumbnailUrl": "<image_url>","downloadUrl": "<image_or_video_url>","type": "image"/"video"},{"thumbnailUrl": "<image_url>","downloadUrl": "<image_or_video_url>","type": "image"/"video"}...]​
Key | Type | Value |
tags (optional) | Array of String | If this is not specified, all templates are shown. If any tags are specified, only templates with those tags are shown. |
orientations (optional) | Array of String | One or more orientations. Only templates in these orientations will be shown. Allowed values are |
visibility (optional) | String | Allowed values are |
templateIds (optional) | Array of String | Send specific template IDs here if you want users to see only those templates. |
Key | Type | Value |
line-spacing | Boolean |
|
letter-spacing | Boolean |
|
Following events can be listened for using the sample code provided on the right.
Event name | Details | Attributes |
| Rocketium's editor is loading | None |
| Rocketium's editor is ready to be used by the user |
|
| User clicks on the Export button in Rocketium's editor. If there is an event handler for this event, the video will not be exported until the | The attributes object will contain |
| Rocketium's servers have received the request to render the video. The editor will auto-close at this point. |
|
| Called upon video export if export-and-close is set to false in the init script. |
|
| Rocketium's template selection screen is loading. | None |
| Rocketium's template selection screen is ready to be used. | None |
| Will receive this callback after successful execution of the | None |
| This callback will be received after successful execution of the | ​ |
| Received after successful execution of | None |
| Called on starting save action in Rocketium's editor. Might be useful to show loader while saving video data. | None |
| Called on successfully saving video data. | None |
| Called on closing the Rocketium's editor. | None |
| Called when campaign editor is open | camapignId |
| Called when campaign is ready to be used. | None |
| Called when campaign gets exported | campaignId and metadata |
| Called when Advance edit is clicked. | None |
| Called when Advance edit is closed. | None |
| Whenever user updates voice-over of a scene this event will be triggered. | None |
| This event is triggered when user removes voice-over from scene | None |
| This event is triggered when the user clicked on export/save button and Button is configured with |
|
Following are the error codes you might encounter while trying to setup Rocketium Form SDK on your webpage.
Error code | Details | Troubleshooting |
RFSDK_MISSING_CONFIG | Required parameters are missing | Missing parameters will be emitted to the console. Update the script to add these entries. |
RFSDK_INVALID_CONFIG | One or more parameters are invalid | Invalid parameters will be emitted to the console. Update the script to fix these entries. |
RFSDK_OUT_OF_CREDITS | Your account does not have any more video credits. | Get in touch with your account manager or our support team. |
RFSDK_INVALID_CLIENT_ID_OR_DOMAIN_NOT_WHITELISTED | The client ID is invalid or the domain on which Rocketium Button is running has not been whitelisted. | Check the client ID shared by the Rocketium team and ensure the current domain has been whitelisted. |
RFSDK_INVALID_TEMPLATE_ID | The specified template ID is either invalid or unavailable for your account. | Correct the template ID sent while initialising. |
RFSDK_INVALID_WORKSPACE_ID | The specified workspace ID is either invalid or unavailable for your account. | Correct the workspace ID sent while initialising. |
Rocketium Button can be controlled with JavaScript. Various methods can be called to customize the behavior of the editor and define different entry-points and workflows associated to curate the user experience.
Method | Details |
| Initialise or change Rocketium Button configuration. This will not open Rocketium's editor. This is already a part of the sample script and does not need to be called again. |
| This will open Rocketium's editor with the configured parameters. The editor opens automatically when a user clicks on the button. You need to call this method only if you want to hide the default button and open the editor based on user interaction on your site. |
| When called this method will open Rocketium's editor with the given |
| This will show the Rocketium Button. You need to call this method only if you had previously hidden it. |
| This will hide the Rocketium Button. You need to call this method only if you want to hide the default button and open the editor based on user interaction on your site. |
| Once editor |
| Instead of calling |
| Accepts a Template Config object as a parameter. |
| This will save the current video. |
| This will generate the video. Required only if video export needs to be called externally. This would happen in two cases - |
| Use this method to get the current video data. After calling this method you will receive data in |
| Use this method to the get the current video data in JSON format compatible with the createVideo API. After calling this method, the data will be received in |
| Use this to programmatically manipulate video data. Video data should be compatible with Rocketium video format. On setting video data successfully |
| Open Campaign with the given campaign ID. |
​