@shakrmedia/editor-sdk ShakrEditorOptions
ShakrEditorOptions interface
ShakrEditor constructor options interface
Signature:export interface ShakrEditorOptions
Properties
| Property | Type | Description |
|---|---|---|
| access_token | string | edit_token from Render Session API. |
| api_url? | string | (Optional) Target API URL used in Amplify Editor. Default value is 'https://backend.amplify.shuttlerock.com/v2'. |
| boxoffice_url? | string | (Optional) Target URL for Box Office (Amplify internal service) Used to search media items from external media sources (e.g. Unsplash, Pexels, etc). |
| customizability? | ShakrEditorCustomizabilityOptions | (Optional) Options to control customizability in Amplify Editor. See ShakrEditorCustomizabilityOptions for details. |
| default_media_libraries? | 'enabled' | 'disabled' | (Optional) Whether Amplify Editor should show Amplify-provided media libraries like Unsplash or Pexels. If not set, media libraries will show by default. |
| image? | string | (Optional) URL for the custom logo image used in Amplify Editor user interface. |
| language? | 'en' | 'ko' | 'ja' | (Optional) Force Amplify Editor to display in a specific language. If not set, Amplify Editor will try to follow current browser's language. English(en), Korean(ko) and Japanese(ja) are supported. |
| media_libraries? | ShakrEditorMediaLibrary[] | (Optional) SDK consumer provided media library configs. See ShakrEditorMediaLibrary for details. |
| render_session_id? | string | (Optional) id of the Render Session object from Render Session API. |
| show_id? | string | (Optional) id of the Show object from Show API. |
| theme? | ShakrEditorTheme | (Optional) Theme setting options for Amplify Editor. See ShakrEditorTheme for details. |
| wait_rendering? | boolean | (Optional) Whether Amplify Editor should wait till the video is rendered and return a rendered video url via 'finish' event after user finishes the editing session |