Class VideoTemplate

constructor

• new VideoTemplate(options): VideoTemplate

• Creates an instance of the JS2Video class

  Parameters

  • options: {
        autoPlay?: boolean;
        enableUnsecureMode?: boolean;
        loop?: boolean;
        params?: any;
        parentElement?: HTMLElement;
        templateUrl: string;
        videoFilePrefix?: string;
    }

    • OptionalautoPlay?: boolean

      Play video immediately after loading? Default: false.

    • OptionalenableUnsecureMode?: boolean

      Enables the template to be loaded and executed from outside an iframe. Use with caution, and only set to 'true' if you trust the template code as it enables code execution on the current page. Default: false.

    • Optionalloop?: boolean

      Loop the video? Default: false.

    • Optionalparams?: any

      Video template params. Default: {}.

    • OptionalparentElement?: HTMLElement

      Parent element. Default: document.body.

    • templateUrl: string

      The URL to the video template.

    • OptionalvideoFilePrefix?: string

      String to prefix exported video file names with. default: js2video.

  Returns VideoTemplate

autoPlay

bitrate

canvas

canvasElement

enableUnsecureMode

isDisposed

isExporting

isLoaded

isPlaying

loop

objects

params

parentElement

range

templateUrl

timeline

videoFilePrefix

currentTime

• get currentTime(): number

• Returns number

duration

• get duration(): number

• Returns number

progress

• get progress(): number

• Returns number

rangeEnd

• get rangeEnd(): number

• Returns number

rangeEndTime

• get rangeEndTime(): number

• Returns number

rangeStart

• get rangeStart(): number

• Returns number

rangeStartTime

• get rangeStartTime(): number

• Returns number

cleanupExport

• cleanupExport(): Promise<void>

• Returns Promise<void>

dispose

• dispose(): Promise<void>

• Disposes the video template and all its resources.

  Returns Promise<void>

export

• export(options?): Promise<ExportResult>

• Exports the video to MP4 from the browser or server.

  Parameters

  • Optionaloptions: {
        signal?: AbortSignal;
    }

    The options for the export.

    • Optionalsignal?: AbortSignal

      The signal that can be used to abort the export process.

  Returns Promise<ExportResult>

load

• load(): Promise<void>

• Loads the video template instance

  Returns Promise<void>

mergeAudio

• mergeAudio(): Promise<any>

• Returns Promise<any>

pause

• pause(): void

• Pauses the video playback

  Returns void

play

• play(): void

• Starts/resumes video playback

  Returns void

progressToTime

• progressToTime(progress): number

• Parameters

  • progress: any

  Returns number

renderAll

• renderAll(): void

• Returns void

resizeHandler

• resizeHandler(): void

• Returns void

rewind

• rewind(): Promise<void>

• Rewinds the video playback to its starting position

  Returns Promise<void>

scaleToFit

• scaleToFit(): void

• Scales the video canvas to fit into its parent element.

  Returns void

scrub

• scrub(options): void

• Updates the progress of the video timeline.

  This method calls the progress() method of the associated timeline with the given progress value to update the video's current position.

  Parameters

  • options: {
        progress?: number;
        time?: number;
    }

    • Optionalprogress?: number

    • Optionaltime?: number

  Returns void

seek

• seek(options): Promise<void>

• Seeks to a specific time in the video

  Parameters

  • options: {
        progress?: number;
        time?: number;
    }

    • Optionalprogress?: number

      Progress to seek to

    • Optionaltime?: number

      Time to seek to

  Returns Promise<void>

sendEvent

• sendEvent(type?): void

• Parameters

  • Optionaltype: string

  Returns void

setBitrate

• setBitrate(bitrate): void

• Parameters

  • bitrate: any

  Returns void

setRange

• setRange(start, end): void

• Parameters

  • start: any
  • end: any

  Returns void

setTimeRange

• setTimeRange(startTime, endTime): void

• Parameters

  • startTime: any
  • endTime: any

  Returns void

timeToProgress

• timeToProgress(time): number

• Parameters

  • time: any

  Returns number

togglePlay

• togglePlay(): void

• Toggles play/pause playback

  Returns void

triggerEvent

• triggerEvent(type): void

• Parameters

  • type: any

  Returns void