## lib/filmout * [lib/filmout](#module_lib/filmout) * [~FilmOut](#module_lib/filmout..FilmOut) * [.init()](#module_lib/filmout..FilmOut+init) * [.listen()](#module_lib/filmout..FilmOut+listen) * [.hash(data)](#module_lib/filmout..FilmOut+hash) * [.set(dir)](#module_lib/filmout..FilmOut+set) * [.move()](#module_lib/filmout..FilmOut+move) ⇒ number * [.start()](#module_lib/filmout..FilmOut+start) * [.end()](#module_lib/filmout..FilmOut+end) * [.onConnect(evt, arg)](#module_lib/filmout..FilmOut+onConnect) ⇒ boolean * [.onPreExport(evt, arg)](#module_lib/filmout..FilmOut+onPreExport) ⇒ any * [.isGifAnimated(pathStr)](#module_lib/filmout..FilmOut+isGifAnimated) ⇒ boolean * [.stillInfo(pathStr)](#module_lib/filmout..FilmOut+stillInfo) ⇒ object * [.dirInfo(images)](#module_lib/filmout..FilmOut+dirInfo) ⇒ object * [.dirList(pathStr)](#module_lib/filmout..FilmOut+dirList) ⇒ array * [.previewFrame(evt, arg)](#module_lib/filmout..FilmOut+previewFrame) * [.preview(evt, arg)](#module_lib/filmout..FilmOut+preview) * [.focus()](#module_lib/filmout..FilmOut+focus) * [.field()](#module_lib/filmout..FilmOut+field) * [.meter()](#module_lib/filmout..FilmOut+meter) * [.close()](#module_lib/filmout..FilmOut+close) * [.onDisplay()](#module_lib/filmout..FilmOut+onDisplay) ### lib/filmout~FilmOut Class representing all filmout features. **Kind**: inner class of [lib/filmout](#module_lib/filmout) * [~FilmOut](#module_lib/filmout..FilmOut) * [.init()](#module_lib/filmout..FilmOut+init) * [.listen()](#module_lib/filmout..FilmOut+listen) * [.hash(data)](#module_lib/filmout..FilmOut+hash) * [.set(dir)](#module_lib/filmout..FilmOut+set) * [.move()](#module_lib/filmout..FilmOut+move) ⇒ number * [.start()](#module_lib/filmout..FilmOut+start) * [.end()](#module_lib/filmout..FilmOut+end) * [.onConnect(evt, arg)](#module_lib/filmout..FilmOut+onConnect) ⇒ boolean * [.onPreExport(evt, arg)](#module_lib/filmout..FilmOut+onPreExport) ⇒ any * [.isGifAnimated(pathStr)](#module_lib/filmout..FilmOut+isGifAnimated) ⇒ boolean * [.stillInfo(pathStr)](#module_lib/filmout..FilmOut+stillInfo) ⇒ object * [.dirInfo(images)](#module_lib/filmout..FilmOut+dirInfo) ⇒ object * [.dirList(pathStr)](#module_lib/filmout..FilmOut+dirList) ⇒ array * [.previewFrame(evt, arg)](#module_lib/filmout..FilmOut+previewFrame) * [.preview(evt, arg)](#module_lib/filmout..FilmOut+preview) * [.focus()](#module_lib/filmout..FilmOut+focus) * [.field()](#module_lib/filmout..FilmOut+field) * [.meter()](#module_lib/filmout..FilmOut+meter) * [.close()](#module_lib/filmout..FilmOut+close) * [.onDisplay()](#module_lib/filmout..FilmOut+onDisplay) #### filmOut.init() Async function for requiring log, ipcMain and bind events. **Kind**: instance method of [FilmOut](#module_lib/filmout..FilmOut) #### filmOut.listen() **Kind**: instance method of [FilmOut](#module_lib/filmout..FilmOut) #### filmOut.hash(data) Create a hash of a string. **Kind**: instance method of [FilmOut](#module_lib/filmout..FilmOut) | Param | Type | Description | | --- | --- | --- | | data | string | Data to produce hash of | #### filmOut.set(dir) Sets filmout direction. **Kind**: instance method of [FilmOut](#module_lib/filmout..FilmOut) | Param | Type | Description | | --- | --- | --- | | dir | boolean | Direction of filmout | #### filmOut.move() ⇒ number Moves filmout a frame at a time. **Kind**: instance method of [FilmOut](#module_lib/filmout..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](#module_lib/filmout..FilmOut) #### filmOut.end() Ends the filmout process and closes the display. **Kind**: instance method of [FilmOut](#module_lib/filmout..FilmOut) #### filmOut.onConnect(evt, arg) ⇒ boolean Use a video file as a film out source on "projector" **Kind**: instance method of [FilmOut](#module_lib/filmout..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](#module_lib/filmout..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](#module_lib/filmout..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](#module_lib/filmout..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](#module_lib/filmout..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](#module_lib/filmout..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](#module_lib/filmout..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](#module_lib/filmout..FilmOut) | Param | Type | Description | | --- | --- | --- | | evt | object | Original event | | arg | object | Arguments from message | #### filmOut.focus() **Kind**: instance method of [FilmOut](#module_lib/filmout..FilmOut) #### filmOut.field() **Kind**: instance method of [FilmOut](#module_lib/filmout..FilmOut) #### filmOut.meter() **Kind**: instance method of [FilmOut](#module_lib/filmout..FilmOut) #### filmOut.close() **Kind**: instance method of [FilmOut](#module_lib/filmout..FilmOut) #### filmOut.onDisplay() **Kind**: instance method of [FilmOut](#module_lib/filmout..FilmOut)