@shakrmedia/editor-sdk ShakrEditorOptions

ShakrEditorOptions interface#

ShakrEditor constructor options interface

Signature:
export interface ShakrEditorOptions

Properties#

PropertyTypeDescription
access_tokenstringedit_token from Render Session API.
api_url?string(Optional) Target API url used in Shakr Editor. Default value is 'https://api.shakr.com/v2'.
boxoffice_url?string(Optional) Target url for Box office which is Shakr internal service for searching media items from external media sources (e.g. Unsplash, Pexels, etc).
image?string(Optional) Logo image url of SDK consumer used in Shakr Editor user interface.
language?'en' | 'ko' | 'ja'(Optional) Forced language setting of Shakr Editor. Without this option, Shakr Editor selects language by browser default 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. Not recommended to use.
theme?ShakrEditorTheme(Optional) Theme setting options for Shakr Editor. See ShakrEditorTheme for details.
wait_rendering?boolean(Optional) Whether Shakr Editor should wait while rendering a video after a user finishes the editing session and return a rendered video url via 'finish' event.