mcopy/app/lib/filmout/Readme.md

lib/filmout

• lib/filmout
  • ~FilmOut
    • .init()
    • .listen()
    • .hash(data)
    • .set(dir)
    • .move() ⇒ number
    • .start()
    • .end()
    • .onConnect(evt, arg) ⇒ boolean
    • .onPreExport(evt, arg) ⇒ any
    • .isGifAnimated(pathStr) ⇒ boolean
    • .stillInfo(pathStr) ⇒ object
    • .dirInfo(images) ⇒ object
    • .dirList(pathStr) ⇒ array
    • .previewFrame(evt, arg)
    • .preview(evt, arg)
    • .focus()
    • .field()
    • .meter()
    • .close()
    • .onDisplay()

lib/filmout~FilmOut

Class representing all filmout features.

Kind: inner class of lib/filmout

• ~FilmOut
  • .init()
  • .listen()
  • .hash(data)
  • .set(dir)
  • .move() ⇒ number
  • .start()
  • .end()
  • .onConnect(evt, arg) ⇒ boolean
  • .onPreExport(evt, arg) ⇒ any
  • .isGifAnimated(pathStr) ⇒ boolean
  • .stillInfo(pathStr) ⇒ object
  • .dirInfo(images) ⇒ object
  • .dirList(pathStr) ⇒ array
  • .previewFrame(evt, arg)
  • .preview(evt, arg)
  • .focus()
  • .field()
  • .meter()
  • .close()
  • .onDisplay()

filmOut.init()

Async function for requiring log, ipcMain and bind events.

Kind: instance method of FilmOut

filmOut.listen()

Kind: instance method of FilmOut

filmOut.hash(data)

Create a hash of a string.

Kind: instance method of FilmOut

Param	Type	Description
data	string	Data to produce hash of

filmOut.set(dir)

Sets filmout direction.

Kind: instance method of FilmOut

Param	Type	Description
dir	boolean	Direction of filmout

filmOut.move() ⇒ number

Moves filmout a frame at a time.

Kind: instance method of FilmOut
Returns: number - Time since start

filmOut.start()

Begin the process of exporting single frames from the video for display.

Kind: instance method of FilmOut

filmOut.end()

Ends the filmout process and closes the display.

Kind: instance method of FilmOut

filmOut.onConnect(evt, arg) ⇒ boolean

Use a video file as a film out source on "projector"

Kind: instance method of FilmOut
Returns: boolean - Success state

Param	Type	Description
evt	object	Original connect event
arg	object	Arguments from ipc message

filmOut.onPreExport(evt, arg) ⇒ any

Pre-export all frames from video for display.

Kind: instance method of FilmOut
Returns: any - UI send call

Param	Type	Description
evt	object	IPC event
arg	object	IPC args

filmOut.isGifAnimated(pathStr) ⇒ boolean

Return true if gif is animated, false if it is a still

Kind: instance method of FilmOut
Returns: boolean - Whether or not gif is animated

Param	Type	Description
pathStr	string	Path to gif to check

filmOut.stillInfo(pathStr) ⇒ object

Return information on a still image using the Jimp module

Kind: instance method of FilmOut
Returns: object - Info about still from sharp

Param	Type	Description
pathStr	string	Path to gif to check

filmOut.dirInfo(images) ⇒ object

Return information on the first still image found in a directory using the Jimp module.

Kind: instance method of FilmOut
Returns: object - Info about first image

Param	Type	Description
images	array	List of image paths

filmOut.dirList(pathStr) ⇒ array

Returns a list of images within a directory, filtered for supported types and sorted.

Kind: instance method of FilmOut
Returns: array - Array of image paths

Param	Type	Description
pathStr	string	Path to directory

filmOut.previewFrame(evt, arg)

Preview a frame from the selected video.

Kind: instance method of FilmOut

Param	Type	Description
evt	object	Original event
arg	object	Arguments from message

filmOut.preview(evt, arg)

Open a single frame in a display window to preview filmout.

Kind: instance method of FilmOut

Param	Type	Description
evt	object	Original event
arg	object	Arguments from message

filmOut.focus()

Kind: instance method of FilmOut

filmOut.field()

Kind: instance method of FilmOut

filmOut.meter()

Kind: instance method of FilmOut

filmOut.close()

Kind: instance method of FilmOut

filmOut.onDisplay()

Kind: instance method of FilmOut