Support → Audio Hijack

A complete scripting API reference for Audio Hijack

← Scripting Center

Notes About Scripting

Execution Environment

All Scripts in Audio Hijack are run on MacOS's built in JavaScript engine, the same one as used by Safari. Furthermore, all scripts are executed on the main thread, such that long loops or slow operations may block the user interface.

Audio Hijack provides two global objects, app and console, which provide services as documented in the API reference. As well, scripts executing in response to Session Events, have a third globally accessible event object that provides context-specific information.

Executing External Programs

Audio Hijack provides two methods to interface with external programs, app.runShortcut() and app.runShellCommand().

Note that both of these methods will block the main thread of Audio Hijack, so take appropriate measures if invoking slow or long-running processes.

As well, be aware of properly escaping strings when using runShellCommand(), things like file names with spaces will need escaping.

API Reference

app

Properties

recordings

• array of recordings, for all Sessions

runningSessions

• array of running sessions

sessions

• array of all sessions

Methods

sessionWithName(name)

• find a session by name

showSessionsWindow()

• show the Sessions window

stopAllSessions()

• stops all sessions

bringToFront()

• bring Audio Hijack to the front, above other apps

quit()

• quit Audio Hijack

runShellCommand(command)

• run a shell script (blocks main thread), returns (result code, stdout ,stderr)

runShortcut(shortcutName, text)

• run a shortcut in Shortcuts.app with text as input

---

console

Properties

Methods

log(message)

• write message to the log. All messages will appear in Console.app.

error(message)

• write error message to the log. All error messages will appear in Console.app.

dialog(message)

• display an alert dialog, and write to log

clear()

• clear the log

---

event

Properties

eventType

• string containing the type of event that occurred: fileDidEnd, sessionWillStart, sessionDidStop, sessionDidIdle, timerWillStart, timerDidStop, loadToCheckErrors, runScriptShortcut, runScriptTextShortcut, runNow

session

• for session events, contains the session object

file

• for fileDidEnd event, contains file object

Methods

---

session

Properties

name

• session name, settable

blocks

• array of all blocks

recordings

• array of recordings made by this session

running

• session running boolean, settable

runTime

• session running time, in seconds

windowShown

• boolean, settable, show or hide the session's window

Methods

start()

• starts session

stop()

• stops session

blockWithName()

• find a block by name

showWindow()

• show the session's window

quitApplicationSources()

• quits any apps set in Application blocks

---

file

Properties

fileName

• name of the file

filePath

• full path to the file

isPlaying

• is playing

creationDate

• creation date

modificationDate

• modification date

displayDate

• displayable date

displayName

• displayable name

displayTime

• displayable duration

fileSize

• file size, in bytes

fileTime

• duration, in seconds

briefDescription

• brief description

fullDescription

• full description

Methods

startPlaying()

• Start Playing

stopPlaying()

• Stop Playing

pausePlaying()

• Pause Playing

togglePlayPaused()

• Toggle between Playing or Pasued

showInInspector()

• show in Inspector

addToMusic()

• add to Music.app (or iTunes.app)

openInEditor()

• open in audio editor

openInApp(path)

• open using the application at path

revealInFinder()

• reveal in Finder

removeFromList()

• remove from Recording list

sendToTrash()

• move to Trash

---

block

Properties

name

• name of block, settable

type

• string indicating the type of the block

disabled

• boolean, settable, enable or disable block

Methods

---

recorder

Properties

fileName

• file name, can include %tokens. settable

folderPath

• path to recording folder, settable

fileTime

• duration of current recording

Methods

---

switch

Properties

switchPosition

• value "A" or "B", settable

Methods

switchToA()

• switch to A

switchToB()

• switch to B

---