public interface Application
extends com.tagtraum.japlscript.Reference
Modifier and Type | Field and Description |
---|---|
static com.tagtraum.japlscript.types.TypeClass |
CLASS |
Modifier and Type | Method and Description |
---|---|
void |
close(com.tagtraum.japlscript.Reference theDocumentSOrWindowSToClose,
SaveOptions shouldChangesBeSavedBeforeClosing,
com.tagtraum.japlscript.types.JaplScriptFile theFileInWhichToSaveTheDocumentIfSo)
Close a document.
|
int |
count(com.tagtraum.japlscript.Reference theObjectsToBeCounted,
com.tagtraum.japlscript.Reference theClassOfObjectsToBeCounted)
Return the number of elements of a particular class within an object.
|
int |
countAudioCompressionPresets() |
int |
countAudioCompressionPresets(String filter) |
int |
countAudioRecordingDevices() |
int |
countAudioRecordingDevices(String filter) |
int |
countDocuments() |
int |
countDocuments(String filter) |
int |
countMovieCompressionPresets() |
int |
countMovieCompressionPresets(String filter) |
int |
countScreenCompressionPresets() |
int |
countScreenCompressionPresets(String filter) |
int |
countVideoRecordingDevices() |
int |
countVideoRecordingDevices(String filter) |
int |
countWindows() |
int |
countWindows(String filter) |
void |
delete(com.tagtraum.japlscript.Reference theObjectSToDelete)
Delete an object.
|
void |
duplicate(com.tagtraum.japlscript.Reference theObjectSToCopy,
com.tagtraum.japlscript.Reference theLocationForTheNewCopyOrCopies,
com.tagtraum.japlscript.types.Record propertiesToSetInTheNewCopyOrCopiesRightAway)
Copy an object.
|
boolean |
exists(com.tagtraum.japlscript.Reference theObjectSToCheck)
Verify that an object exists.
|
void |
export(Document theMovieToExport,
com.tagtraum.japlscript.types.JaplScriptFile theDestinationFile,
String theNameOfTheExportSettingsPresetToUse)
Export a movie to another file.
|
AudioCompressionPreset |
getAudioCompressionPreset(com.tagtraum.japlscript.Id id) |
AudioCompressionPreset |
getAudioCompressionPreset(int index) |
AudioCompressionPreset[] |
getAudioCompressionPresets() |
AudioCompressionPreset[] |
getAudioCompressionPresets(String filter) |
AudioRecordingDevice |
getAudioRecordingDevice(com.tagtraum.japlscript.Id id) |
AudioRecordingDevice |
getAudioRecordingDevice(int index) |
AudioRecordingDevice[] |
getAudioRecordingDevices() |
AudioRecordingDevice[] |
getAudioRecordingDevices(String filter) |
Document |
getDocument(com.tagtraum.japlscript.Id id) |
Document |
getDocument(int index) |
Document[] |
getDocuments() |
Document[] |
getDocuments(String filter) |
boolean |
getFrontmost()
Is this the active application?
|
MovieCompressionPreset |
getMovieCompressionPreset(com.tagtraum.japlscript.Id id) |
MovieCompressionPreset |
getMovieCompressionPreset(int index) |
MovieCompressionPreset[] |
getMovieCompressionPresets() |
MovieCompressionPreset[] |
getMovieCompressionPresets(String filter) |
String |
getName()
The name of the application.
|
ScreenCompressionPreset |
getScreenCompressionPreset(com.tagtraum.japlscript.Id id) |
ScreenCompressionPreset |
getScreenCompressionPreset(int index) |
ScreenCompressionPreset[] |
getScreenCompressionPresets() |
ScreenCompressionPreset[] |
getScreenCompressionPresets(String filter) |
String |
getVersion()
The version number of the application.
|
VideoRecordingDevice |
getVideoRecordingDevice(com.tagtraum.japlscript.Id id) |
VideoRecordingDevice |
getVideoRecordingDevice(int index) |
VideoRecordingDevice[] |
getVideoRecordingDevices() |
VideoRecordingDevice[] |
getVideoRecordingDevices(String filter) |
Window |
getWindow(com.tagtraum.japlscript.Id id) |
Window |
getWindow(int index) |
Window[] |
getWindows() |
Window[] |
getWindows(String filter) |
<T extends com.tagtraum.japlscript.Reference> |
make(Class<T> klass)
Creates a new object.
|
com.tagtraum.japlscript.Reference |
make(com.tagtraum.japlscript.Reference theClassOfTheNewObject,
com.tagtraum.japlscript.Reference theLocationAtWhichToInsertTheObject,
com.tagtraum.japlscript.Reference theInitialContentsOfTheObject,
com.tagtraum.japlscript.types.Record theInitialValuesForPropertiesOfTheObject)
Create a new object.
|
void |
move(com.tagtraum.japlscript.Reference theObjectSToMove,
com.tagtraum.japlscript.Reference theNewLocationForTheObjectS)
Move an object to a new location.
|
Document |
newAudioRecording()
Create a new audio recording document.
|
Document |
newMovieRecording()
Create a new movie recording document.
|
Document |
newScreenRecording()
Create a new screen recording document.
|
Document |
open(com.tagtraum.japlscript.types.JaplScriptFile theFileSToBeOpened)
Open a document.
|
void |
openURL(String theURL)
Open a URL.
|
void |
pause(Document theRecordingToPause)
Pause the recording.
|
void |
play(Document theMovieToPlay)
Play the movie.
|
void |
present(Document theDocumentToPresent)
Present the document full screen.
|
void |
print(com.tagtraum.japlscript.types.JaplScriptFile[] theFileSDocumentSOrWindowSToBePrinted,
com.tagtraum.japlscript.Reference thePrintSettingsToUse,
boolean shouldTheApplicationShowThePrintDialog)
Print a document.
|
void |
quit(SaveOptions shouldChangesBeSavedBeforeQuitting)
Quit the application.
|
void |
resume(Document theRecordingToResume)
Resume the recording.
|
void |
save(com.tagtraum.japlscript.Reference theDocumentSOrWindowSToSave,
com.tagtraum.japlscript.types.JaplScriptFile theFileInWhichToSaveTheDocument,
com.tagtraum.japlscript.Reference theFileFormatToUse)
Save a document.
|
void |
setDocument(Document value,
int index) |
void |
showRemoteHud(Document document)
Show the document's Remote HUD.
|
void |
start(Document theRecordingToStart)
Start the movie recording.
|
void |
stepBackward(Document theMovieToStep,
int numberOfSteps)
Step the movie backward the specified number of steps (default is 1).
|
void |
stepForward(Document theMovieToStep,
int numberOfSteps)
Step the movie forward the specified number of steps (default is 1).
|
void |
stop(Document theMovieOrRecordingToStop)
Stop the movie or recording.
|
void |
trim(Document theMovieToTrim,
double startTimeInSeconds,
double endTimeInSeconds)
Trim the movie.
|
Document open(com.tagtraum.japlscript.types.JaplScriptFile theFileSToBeOpened)
theFileSToBeOpened
- The file(s) to be opened.void close(com.tagtraum.japlscript.Reference theDocumentSOrWindowSToClose, SaveOptions shouldChangesBeSavedBeforeClosing, com.tagtraum.japlscript.types.JaplScriptFile theFileInWhichToSaveTheDocumentIfSo)
theDocumentSOrWindowSToClose
- the document(s) or window(s) to close.shouldChangesBeSavedBeforeClosing
- Should changes be saved before closing?theFileInWhichToSaveTheDocumentIfSo
- The file in which to save the document, if so.void save(com.tagtraum.japlscript.Reference theDocumentSOrWindowSToSave, com.tagtraum.japlscript.types.JaplScriptFile theFileInWhichToSaveTheDocument, com.tagtraum.japlscript.Reference theFileFormatToUse)
theDocumentSOrWindowSToSave
- The document(s) or window(s) to save.theFileInWhichToSaveTheDocument
- The file in which to save the document.theFileFormatToUse
- The file format to use.void print(com.tagtraum.japlscript.types.JaplScriptFile[] theFileSDocumentSOrWindowSToBePrinted, com.tagtraum.japlscript.Reference thePrintSettingsToUse, boolean shouldTheApplicationShowThePrintDialog)
theFileSDocumentSOrWindowSToBePrinted
- The file(s), document(s), or window(s) to be printed.thePrintSettingsToUse
- The print settings to use.shouldTheApplicationShowThePrintDialog
- Should the application show the print dialog?void quit(SaveOptions shouldChangesBeSavedBeforeQuitting)
shouldChangesBeSavedBeforeQuitting
- Should changes be saved before quitting?int count(com.tagtraum.japlscript.Reference theObjectsToBeCounted, com.tagtraum.japlscript.Reference theClassOfObjectsToBeCounted)
theObjectsToBeCounted
- The objects to be counted.theClassOfObjectsToBeCounted
- The class of objects to be counted.void delete(com.tagtraum.japlscript.Reference theObjectSToDelete)
theObjectSToDelete
- The object(s) to delete.void duplicate(com.tagtraum.japlscript.Reference theObjectSToCopy, com.tagtraum.japlscript.Reference theLocationForTheNewCopyOrCopies, com.tagtraum.japlscript.types.Record propertiesToSetInTheNewCopyOrCopiesRightAway)
theObjectSToCopy
- The object(s) to copy.theLocationForTheNewCopyOrCopies
- The location for the new copy or copies.propertiesToSetInTheNewCopyOrCopiesRightAway
- Properties to set in the new copy or copies right away.boolean exists(com.tagtraum.japlscript.Reference theObjectSToCheck)
theObjectSToCheck
- The object(s) to check.com.tagtraum.japlscript.Reference make(com.tagtraum.japlscript.Reference theClassOfTheNewObject, com.tagtraum.japlscript.Reference theLocationAtWhichToInsertTheObject, com.tagtraum.japlscript.Reference theInitialContentsOfTheObject, com.tagtraum.japlscript.types.Record theInitialValuesForPropertiesOfTheObject)
theClassOfTheNewObject
- The class of the new object.theLocationAtWhichToInsertTheObject
- The location at which to insert the object.theInitialContentsOfTheObject
- The initial contents of the object.theInitialValuesForPropertiesOfTheObject
- The initial values for properties of the object.<T extends com.tagtraum.japlscript.Reference> T make(Class<T> klass)
klass
- Java type of the object to create.void move(com.tagtraum.japlscript.Reference theObjectSToMove, com.tagtraum.japlscript.Reference theNewLocationForTheObjectS)
theObjectSToMove
- The object(s) to move.theNewLocationForTheObjectS
- The new location for the object(s).void openURL(String theURL)
theURL
- the URLvoid play(Document theMovieToPlay)
theMovieToPlay
- the movie to playvoid start(Document theRecordingToStart)
theRecordingToStart
- the recording to startvoid pause(Document theRecordingToPause)
theRecordingToPause
- the recording to pausevoid resume(Document theRecordingToResume)
theRecordingToResume
- the recording to resumevoid stop(Document theMovieOrRecordingToStop)
theMovieOrRecordingToStop
- the movie or recording to stopvoid stepBackward(Document theMovieToStep, int numberOfSteps)
theMovieToStep
- the movie to stepnumberOfSteps
- number of stepsvoid stepForward(Document theMovieToStep, int numberOfSteps)
theMovieToStep
- the movie to stepnumberOfSteps
- number of stepsvoid trim(Document theMovieToTrim, double startTimeInSeconds, double endTimeInSeconds)
theMovieToTrim
- the movie to trimstartTimeInSeconds
- start time in secondsendTimeInSeconds
- end time in secondsvoid present(Document theDocumentToPresent)
theDocumentToPresent
- the document to presentDocument newMovieRecording()
Document newAudioRecording()
Document newScreenRecording()
void export(Document theMovieToExport, com.tagtraum.japlscript.types.JaplScriptFile theDestinationFile, String theNameOfTheExportSettingsPresetToUse)
theMovieToExport
- the movie to exporttheDestinationFile
- the destination filetheNameOfTheExportSettingsPresetToUse
- the name of the export settings preset to usevoid showRemoteHud(Document document)
document
- Document[] getDocuments(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"Document
sDocument getDocument(int index)
index
- index into the element listDocument
with at the requested indexDocument getDocument(com.tagtraum.japlscript.Id id)
id
- id of the itemDocument
with the requested idint countDocuments()
Document
sint countDocuments(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"void setDocument(Document value, int index)
value
- element to set in the listindex
- index into the element listWindow[] getWindows(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"Window
sWindow getWindow(int index)
index
- index into the element listWindow
with at the requested indexWindow getWindow(com.tagtraum.japlscript.Id id)
id
- id of the itemWindow
with the requested idint countWindows()
Window
sint countWindows(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"String getName()
boolean getFrontmost()
String getVersion()
VideoRecordingDevice[] getVideoRecordingDevices()
VideoRecordingDevice
sVideoRecordingDevice[] getVideoRecordingDevices(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"VideoRecordingDevice
sVideoRecordingDevice getVideoRecordingDevice(int index)
index
- index into the element listVideoRecordingDevice
with at the requested indexVideoRecordingDevice getVideoRecordingDevice(com.tagtraum.japlscript.Id id)
id
- id of the itemVideoRecordingDevice
with the requested idint countVideoRecordingDevices()
VideoRecordingDevice
sint countVideoRecordingDevices(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"AudioRecordingDevice[] getAudioRecordingDevices()
AudioRecordingDevice
sAudioRecordingDevice[] getAudioRecordingDevices(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"AudioRecordingDevice
sAudioRecordingDevice getAudioRecordingDevice(int index)
index
- index into the element listAudioRecordingDevice
with at the requested indexAudioRecordingDevice getAudioRecordingDevice(com.tagtraum.japlscript.Id id)
id
- id of the itemAudioRecordingDevice
with the requested idint countAudioRecordingDevices()
AudioRecordingDevice
sint countAudioRecordingDevices(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"AudioCompressionPreset[] getAudioCompressionPresets()
AudioCompressionPreset
sAudioCompressionPreset[] getAudioCompressionPresets(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"AudioCompressionPreset
sAudioCompressionPreset getAudioCompressionPreset(int index)
index
- index into the element listAudioCompressionPreset
with at the requested indexAudioCompressionPreset getAudioCompressionPreset(com.tagtraum.japlscript.Id id)
id
- id of the itemAudioCompressionPreset
with the requested idint countAudioCompressionPresets()
AudioCompressionPreset
sint countAudioCompressionPresets(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"MovieCompressionPreset[] getMovieCompressionPresets()
MovieCompressionPreset
sMovieCompressionPreset[] getMovieCompressionPresets(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"MovieCompressionPreset
sMovieCompressionPreset getMovieCompressionPreset(int index)
index
- index into the element listMovieCompressionPreset
with at the requested indexMovieCompressionPreset getMovieCompressionPreset(com.tagtraum.japlscript.Id id)
id
- id of the itemMovieCompressionPreset
with the requested idint countMovieCompressionPresets()
MovieCompressionPreset
sint countMovieCompressionPresets(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"ScreenCompressionPreset[] getScreenCompressionPresets()
ScreenCompressionPreset
sScreenCompressionPreset[] getScreenCompressionPresets(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"ScreenCompressionPreset
sScreenCompressionPreset getScreenCompressionPreset(int index)
index
- index into the element listScreenCompressionPreset
with at the requested indexScreenCompressionPreset getScreenCompressionPreset(com.tagtraum.japlscript.Id id)
id
- id of the itemScreenCompressionPreset
with the requested idint countScreenCompressionPresets()
ScreenCompressionPreset
sint countScreenCompressionPresets(String filter)
filter
- AppleScript filter clause without the leading "whose" or "where"Copyright © 2006–2019 tagtraum industries incorporated. All rights reserved.