FilmLight Java API

This document details the Java API bindings for the FilmLight API server.

The FilmLight Java API connects to an API server running on a local or remote machine, and provides a set of functions and classes which can be used to manipulate the native Baselight and Daylight databases and services.

Supports:

Module

The FilmLight API classes are defined in the uk.ltd.filmlight.flapi package.

Installation

JDK 8 or Later

Ensure you are using Java SE 8 Development Kit or later.

The latest Java SE 11 Development Kit is available here:

Java SE 11 Development Kit

FLAPI Java support files

The flapi Java jar files are provided as part of the Baselight and Daylight software package in the following locations:

On Linux:

/usr/fl/baselight-<version>/share/flapi/java
/usr/fl/daylight-version>/share/flapi/java

On macOS:

/Applications/Baselight/<version>/Utilities/Resources/share/flapi/java
/Applications/Daylight/<version>/Utilities/Resources/share/flapi/java

Add the flapi.jar, json-20170516.jar and Java-WebSocket-1.3.9.jar files to your Java project.

These jars must be in your compiler and runtime classpathes to use FLAPI.

Protocol

For details of the underlying protocol, see the FilmLight JSON API specification.

Connection

In order to perform actions using the FilmLight Java API, you must first open a connection to the FilmLight API server.

This is implemented via the Connection class.

The Java API allows connecting to a local or remote FilmLight API server, or launching a local instance of the flapi service on-demand.

To connect to a local or remote FLAPI server:

import uk.ltd.filmlight.flapi.*;
class ConnectionTest {

    public static void main( String[] args )
    {
        try
        {
            Connection conn = new Connection( "localhost" );

            conn.connect();

            // Use FLAPI interfaces and methods

            conn.close();
        }
        catch( FLAPIException ex )
        {
            System.out.printf( "Could not connect to FilmLight API\n" );
            System.out.printf( ex.getMessage() );
        }
    }
}

To launch an instance of the flapi service on-demand:

import uk.ltd.filmlight.flapi.*;
class ConnectionTest {

    public static void main( String[] args )
    {
        try
        {
            Connection conn = new Connection();

            conn.launch();

            // Use FLAPI interfaces and methods

            conn.close();
        }
        catch( FLAPIException ex )
        {
            System.out.printf( ex.getMessage() );
        }
    }
}

Errors

FLAPIException

If an error occurs as part of the function call via FLAPI, it will be returned via an FLAPIException raised from the method you are calling.

If the method is asynchronous, the exception will be returned within a CompletionException raised by join() or other functions that wait on the completion of the CompletableFuture object.

Server Logs

If the FilmLight API method calls are malfunctioning, extra information can be retrieved via the flapid server log files.

The log files can be found at the following locations:

On Linux:

/usr/fl/log/<hostname>-flapid/console.txt

On macOS:

/Library/Application Support/FilmLight/log/<hostname>-flapid/console.txt

Beta Classes and Methods

Some classes and methods are marked BETA.

This means that the API is currently in flux and subject to change in subsequent releases.

Changes to API since last release

Classes

Key: Static MethodInstance MethodBeta

Application

The Application class provides information about the host application and access to its global state.

Signals

Methods

Async Methods

HashMap<String,Object> getApplicationInfo()

Information describing the application exposed via the FilmLight API

Arguments

Result

ArrayList<SDKVersion> getSdkVersions()

Get SDK version information

Arguments

Result

Long inContainer()

Returns whether the application is running in a container environment

Arguments

Result

Long daemonInSubprocess()

Returns whether the connection to the FLAPI daemon was made using conn.launch(), which starts a fresh daemon as a sub-process.

Arguments

Result

ArrayList<ConnectionInfo> getConnectionsInfo()

Get array of current connections. Each entry in the array will be a ConnectionInfo object describing that connection.

Arguments

Result

Long getVideoStreamingSupported()

Is video streaming supported (hardware, setup & licensed)

Arguments

Result

Long getVideoStreamingEnabled()

Is video streaming currently enabled

Arguments

Result

String getVideoStreamAddress()

Return address for video stream

Arguments

Result

Long isPlaying()

Is playback currently in progress

Arguments

Result

Application get() BETA

Return instance of the Application object (typically for signal connection)

Arguments

Result

Scene getCurrentScene() BETA

Return the currently active Scene within the application

Arguments

Result

String getCurrentSceneName() BETA

Return the name of the currently active Scene within the application

Arguments

Result

ArrayList<String> getOpenSceneNames() BETA

Return array of names of scenes currently open in the application. You can get the Scene object for a given name by calling get_scene_by_name().

Arguments

Result

Scene getSceneByName(String name) BETA

Return the Scene object for the scene with the given name. If no matching scene can be found, NULL is returned.

Arguments

Result

Cursor getCurrentCursor() BETA

Return the currently active Cursor within the application

Arguments

Result

ArrayList<Cursor> getCursors() BETA

Return active Cursor objects within the application

Arguments

Result

void log(String category, String severity, String message) BETA

Log message in application Log view

Arguments

Result

String messageDialog(String title, String message, ArrayList<String> buttons) BETA

Present a message box in the Application for the user to interact with

Arguments

Result

Object listDialog(String title, String message, ArrayList<KeyTextItem> items) BETA

Present a dialog to the user containing a list of items that the user can select from

Arguments

Result

String getClipboard()

Get the content of the clipboard

Arguments

Result

void setClipboard(String data)

Set the content of the clipboard

Arguments

Result

void setCustomData(String data_key, Object data_value)

Set a custom data value in the application with the supplied (string) key. Existing custom data values can be deleted from the application by supplying NULL/None/null as the data value (for an existing key).

Arguments

Result

Object getCustomData(String data_key)

Get a custom data value from the application previously set using set_custom_data.

Arguments

Result

ArrayList<String> getCustomDataKeys()

Return sorted array of (string) keys that can be used to fetch application custom data values via get_custom_data.

Arguments

Result

void openUrl(String url)

Open the given URL in a browser window

Arguments

Result

CompletableFuture<HashMap<String,Object>> getApplicationInfoAsync()

Information describing the application exposed via the FilmLight API

Arguments

Result

CompletableFuture<ArrayList<SDKVersion>> getSdkVersionsAsync()

Get SDK version information

Arguments

Result

CompletableFuture<Long> inContainerAsync()

Returns whether the application is running in a container environment

Arguments

Result

CompletableFuture<Long> daemonInSubprocessAsync()

Returns whether the connection to the FLAPI daemon was made using conn.launch(), which starts a fresh daemon as a sub-process.

Arguments

Result

CompletableFuture<ArrayList<ConnectionInfo>> getConnectionsInfoAsync()

Get array of current connections. Each entry in the array will be a ConnectionInfo object describing that connection.

Arguments

Result

CompletableFuture<Long> getVideoStreamingSupportedAsync()

Is video streaming supported (hardware, setup & licensed)

Arguments

Result

CompletableFuture<Long> getVideoStreamingEnabledAsync()

Is video streaming currently enabled

Arguments

Result

CompletableFuture<String> getVideoStreamAddressAsync()

Return address for video stream

Arguments

Result

CompletableFuture<Long> isPlayingAsync()

Is playback currently in progress

Arguments

Result

CompletableFuture<Application> getAsync() BETA

Return instance of the Application object (typically for signal connection)

Arguments

Result

CompletableFuture<Scene> getCurrentSceneAsync() BETA

Return the currently active Scene within the application

Arguments

Result

CompletableFuture<String> getCurrentSceneNameAsync() BETA

Return the name of the currently active Scene within the application

Arguments

Result

CompletableFuture<ArrayList<String>> getOpenSceneNamesAsync() BETA

Return array of names of scenes currently open in the application. You can get the Scene object for a given name by calling get_scene_by_name().

Arguments

Result

CompletableFuture<Scene> getSceneByNameAsync(String name) BETA

Return the Scene object for the scene with the given name. If no matching scene can be found, NULL is returned.

Arguments

Result

CompletableFuture<Cursor> getCurrentCursorAsync() BETA

Return the currently active Cursor within the application

Arguments

Result

CompletableFuture<ArrayList<Cursor>> getCursorsAsync() BETA

Return active Cursor objects within the application

Arguments

Result

CompletableFuture<void> logAsync(String category, String severity, String message) BETA

Log message in application Log view

Arguments

Result

CompletableFuture<String> messageDialogAsync(String title, String message, ArrayList<String> buttons) BETA

Present a message box in the Application for the user to interact with

Arguments

Result

CompletableFuture<Object> listDialogAsync(String title, String message, ArrayList<KeyTextItem> items) BETA

Present a dialog to the user containing a list of items that the user can select from

Arguments

Result

CompletableFuture<String> getClipboardAsync()

Get the content of the clipboard

Arguments

Result

CompletableFuture<void> setClipboardAsync(String data)

Set the content of the clipboard

Arguments

Result

CompletableFuture<void> setCustomDataAsync(String data_key, Object data_value)

Set a custom data value in the application with the supplied (string) key. Existing custom data values can be deleted from the application by supplying NULL/None/null as the data value (for an existing key).

Arguments

Result

CompletableFuture<Object> getCustomDataAsync(String data_key)

Get a custom data value from the application previously set using set_custom_data.

Arguments

Result

CompletableFuture<ArrayList<String>> getCustomDataKeysAsync()

Return sorted array of (string) keys that can be used to fetch application custom data values via get_custom_data.

Arguments

Result

CompletableFuture<void> openUrlAsync(String url)

Open the given URL in a browser window

Arguments

Result

AudioSync

audio sync operation

Signals

Methods

Async Methods

AudioSync create()

Create a new audio sync operation object

Arguments

Result

Long audioSync(Scene scene, AudioSyncSettings settings, ArrayList<Long> shot_ids)

Perform audio sync operation using the given audio sync settings

Arguments

Result

ArrayList<AudioSyncProgress> getLog()

Return log of progress information

Arguments

Result

CompletableFuture<AudioSync> createAsync()

Create a new audio sync operation object

Arguments

Result

CompletableFuture<Long> audioSyncAsync(Scene scene, AudioSyncSettings settings, ArrayList<Long> shot_ids)

Perform audio sync operation using the given audio sync settings

Arguments

Result

CompletableFuture<ArrayList<AudioSyncProgress>> getLogAsync()

Return log of progress information

Arguments

Result

ClientViewManager

Manages settings for connected Client Views.

Signals

Methods

Async Methods

ClientViewManager get()

Get reference to the (singleton) ClientViewManager object

Arguments

Result

ClientViewHostUserSettings getHostUserSettings()

Get object containing Settings for the Client View's host user

Arguments

Result

ClientViewClientSettings getClientSettings()

Get the connected Client View's config/settings object.

Arguments

Result

ArrayList<ClientViewStreamSettings> getStreamSettings()

Get array of stream settings objects.

Arguments

Result

Long getStreamingEnabled()

Is streaming currently enabled.

Arguments

Result

String getSessionName()

Get the current Client View session name.

Arguments

Result

ArrayList<ConnectionInfo> getSessionClients()

Get array of current session clients. Each entry in the array will be a ConnectionInfo object describing that connection.

Arguments

Result

CompletableFuture<ClientViewManager> getAsync()

Get reference to the (singleton) ClientViewManager object

Arguments

Result

CompletableFuture<ClientViewHostUserSettings> getHostUserSettingsAsync()

Get object containing Settings for the Client View's host user

Arguments

Result

CompletableFuture<ClientViewClientSettings> getClientSettingsAsync()

Get the connected Client View's config/settings object.

Arguments

Result

CompletableFuture<ArrayList<ClientViewStreamSettings>> getStreamSettingsAsync()

Get array of stream settings objects.

Arguments

Result

CompletableFuture<Long> getStreamingEnabledAsync()

Is streaming currently enabled.

Arguments

Result

CompletableFuture<String> getSessionNameAsync()

Get the current Client View session name.

Arguments

Result

CompletableFuture<ArrayList<ConnectionInfo>> getSessionClientsAsync()

Get array of current session clients. Each entry in the array will be a ConnectionInfo object describing that connection.

Arguments

Result

CurrentGrade

Used to monitor an in-progress Baselight grading session. Clients should first obtain a CurrentGrade (singleton) instance using the (static) get() function. Clients can register with this instance to receive signals when the current grade changes.

Signals

Methods

Async Methods

CurrentGrade get()

Get (singleton) current grade interface for the connected client

Arguments

Result

void requestUpdateCurrentShotSignal()

Explicitly request an 'UpdateCurrentShot' signal. This can be useful, for example, when first connecting to the current grade module for initialising a client's internal state.

Arguments

Result

Cursor getCurrentCursor()

Get an interface to the cursor currently in use by Baselight for grading.

Arguments

Result

Long isEnabled()

Is this interface currently enabled. Note: The current grade interface may be arbitrarily enabled/disabled from the host application itself.

Arguments

Result

CompletableFuture<CurrentGrade> getAsync()

Get (singleton) current grade interface for the connected client

Arguments

Result

void requestUpdateCurrentShotSignalAsync()

Explicitly request an 'UpdateCurrentShot' signal. This can be useful, for example, when first connecting to the current grade module for initialising a client's internal state.

Arguments

Result

CompletableFuture<Cursor> getCurrentCursorAsync()

Get an interface to the cursor currently in use by Baselight for grading.

Arguments

Result

CompletableFuture<Long> isEnabledAsync()

Is this interface currently enabled. Note: The current grade interface may be arbitrarily enabled/disabled from the host application itself.

Arguments

Result

Cursor

Interface for accessing cursors within a scene.

Signals

Methods

Async Methods

Double getTime()

Get cursor's position in the timeline in seconds

Arguments

Result

Long getFrame()

Get cursor's position in the timeline as a frame number

Arguments

Result

Timecode getRecordTimecode()

Get cursor's position in the timeline as a timecode

Arguments

Result

String getViewingFormatName()

Get the name of the cursor's current viewing format.

Arguments

Result

HashMap<String,Object> getViewingFormatDims()

Get basic geometry (width, height and aspect ratio) of the cursor's current viewing format

Arguments

Result

FormatMask getViewingFormatMaskName()

Get current viewing format mask name

Arguments

Result

FormatMask getViewingFormatMask()

Get current viewing format mask rectangle

Arguments

Result

Long getAge()

Get the cursor's 'age'. The age is an integer, incremented whenever an attribute which could result in a visual change to the image display has been modfied.

Arguments

Result

Long isUsingTruelight()

Is Truelight currently in use (ie. a profile has been selected & Truelight is enabled) in this cursor.

Arguments

Result

CompletableFuture<Double> getTimeAsync()

Get cursor's position in the timeline in seconds

Arguments

Result

CompletableFuture<Long> getFrameAsync()

Get cursor's position in the timeline as a frame number

Arguments

Result

CompletableFuture<Timecode> getRecordTimecodeAsync()

Get cursor's position in the timeline as a timecode

Arguments

Result

CompletableFuture<String> getViewingFormatNameAsync()

Get the name of the cursor's current viewing format.

Arguments

Result

CompletableFuture<HashMap<String,Object>> getViewingFormatDimsAsync()

Get basic geometry (width, height and aspect ratio) of the cursor's current viewing format

Arguments

Result

CompletableFuture<FormatMask> getViewingFormatMaskNameAsync()

Get current viewing format mask name

Arguments

Result

CompletableFuture<FormatMask> getViewingFormatMaskAsync()

Get current viewing format mask rectangle

Arguments

Result

CompletableFuture<Long> getAgeAsync()

Get the cursor's 'age'. The age is an integer, incremented whenever an attribute which could result in a visual change to the image display has been modfied.

Arguments

Result

CompletableFuture<Long> isUsingTruelightAsync()

Is Truelight currently in use (ie. a profile has been selected & Truelight is enabled) in this cursor.

Arguments

Result

DynamicDialog (BETA)

This class can be used to show a complex dialog box to the user BETA

Signals

Methods

Async Methods

DynamicDialog create(String title, ArrayList<DialogItem> defns, HashMap<String,Object> settings) BETA

Create a Dialog object

Arguments

Result

HashMap<String,Object> modal(String title, ArrayList<DialogItem> defns, HashMap<String,Object> settings, Long width, Long height) BETA

Display a Dialog object and return the settings

Arguments

Result

HashMap<String,Object> showModal(Long width, Long height) BETA

Show dialog to user

Arguments

Result

HashMap<String,Object> getSettings() BETA

Return current dialog settings

Arguments

Result

void setSettings(HashMap<String,Object> settings) BETA

Set current dialog settings

Arguments

Result

void setTimerCallback(Long delay, Long repeat) BETA

Set time until callback signal TimerCallback will be sent

Arguments

Result

void cancelTimerCallback() BETA

Cancel any pending timer callback

Arguments

Result

CompletableFuture<DynamicDialog> createAsync(String title, ArrayList<DialogItem> defns, HashMap<String,Object> settings) BETA

Create a Dialog object

Arguments

Result

CompletableFuture<HashMap<String,Object>> modalAsync(String title, ArrayList<DialogItem> defns, HashMap<String,Object> settings, Long width, Long height) BETA

Display a Dialog object and return the settings

Arguments

Result

CompletableFuture<HashMap<String,Object>> showModalAsync(Long width, Long height) BETA

Show dialog to user

Arguments

Result

CompletableFuture<HashMap<String,Object>> getSettingsAsync() BETA

Return current dialog settings

Arguments

Result

CompletableFuture<void> setSettingsAsync(HashMap<String,Object> settings) BETA

Set current dialog settings

Arguments

Result

CompletableFuture<void> setTimerCallbackAsync(Long delay, Long repeat) BETA

Set time until callback signal TimerCallback will be sent

Arguments

Result

CompletableFuture<void> cancelTimerCallbackAsync() BETA

Cancel any pending timer callback

Arguments

Result

Export

Export operation

Signals

Methods

Async Methods

Export create()

Create a new Export operation object

Arguments

Result

void selectAll()

Select all snots in Scene to export

Arguments

Result

void clearSelection()

Clear selection of shots in Scene to export

Arguments

Result

void selectShots(ArrayList<Shot> shots)

Set the selection to the given Shots for rendering

Arguments

Result

void selectShot(ArrayList<Shot> shot)

Add the given shot to the selection to be exported.

Arguments

Result

ExportOpInfo doExportBlg(QueueManager queue, Scene scene, BLGExportSettings settings)

Perform export BLG operation using the given Export settings

Arguments

Result

ExportOpInfo doExportCdl(QueueManager queue, Scene scene, CDLExportSettings settings)

Perform export CDL operation using the given Export settings

Arguments

Result

ExportOpInfo doExportAmf(QueueManager queue, Scene scene, AMFExportSettings settings)

Perform export AMF operation using the given Export settings

Arguments

Result

ExportOpInfo doExportCube(QueueManager queue, Scene scene, CubeExportSettings settings)

Perform export LUT operation using the given Export settings

Arguments

Result

ExportOpInfo doExportStill(QueueManager queue, Scene scene, StillExportSettings settings)

Perform export still operation using the given Export settings

Arguments

Result

ArrayList<ExportProgress> getLog()

Return log of progress information

Arguments

Result

ArrayList<HashMap<String,Object>> getPresets(Scene scene, String export_type) BETA

Return array of presets.

Note: this function is provided to make it easier to discover what settings are required when you want a particular export format (in particular for stills where it may not be obvious how to choose quality / compression settings etc). It is not, currently, intended to be a full-fledged interface to the Baselight presets.

Arguments

Result

CompletableFuture<Export> createAsync()

Create a new Export operation object

Arguments

Result

CompletableFuture<void> selectAllAsync()

Select all snots in Scene to export

Arguments

Result

CompletableFuture<void> clearSelectionAsync()

Clear selection of shots in Scene to export

Arguments

Result

CompletableFuture<void> selectShotsAsync(ArrayList<Shot> shots)

Set the selection to the given Shots for rendering

Arguments

Result

CompletableFuture<void> selectShotAsync(ArrayList<Shot> shot)

Add the given shot to the selection to be exported.

Arguments

Result

CompletableFuture<ExportOpInfo> doExportBlgAsync(QueueManager queue, Scene scene, BLGExportSettings settings)

Perform export BLG operation using the given Export settings

Arguments

Result

CompletableFuture<ExportOpInfo> doExportCdlAsync(QueueManager queue, Scene scene, CDLExportSettings settings)

Perform export CDL operation using the given Export settings

Arguments

Result

CompletableFuture<ExportOpInfo> doExportAmfAsync(QueueManager queue, Scene scene, AMFExportSettings settings)

Perform export AMF operation using the given Export settings

Arguments

Result

CompletableFuture<ExportOpInfo> doExportCubeAsync(QueueManager queue, Scene scene, CubeExportSettings settings)

Perform export LUT operation using the given Export settings

Arguments

Result

CompletableFuture<ExportOpInfo> doExportStillAsync(QueueManager queue, Scene scene, StillExportSettings settings)

Perform export still operation using the given Export settings

Arguments

Result

CompletableFuture<ArrayList<ExportProgress>> getLogAsync()

Return log of progress information

Arguments

Result

CompletableFuture<ArrayList<HashMap<String,Object>>> getPresetsAsync(Scene scene, String export_type) BETA

Return array of presets.

Note: this function is provided to make it easier to discover what settings are required when you want a particular export format (in particular for stills where it may not be obvious how to choose quality / compression settings etc). It is not, currently, intended to be a full-fledged interface to the Baselight presets.

Arguments

Result

FDL

Class representing an ASC Framing Decision List

Signals

Methods

Async Methods

FDL create(FDLDocument fdlDocument)

Create an FDL Object from an FDLDocument

Arguments

Result

FDL loadFromPath(String fdlPath, Long validate)

Load the FDL from the given path

Arguments

Result

FDL loadFromString(String fdlString, Long validate)

Load the FDL from the given JSON-formatted string

Arguments

Result

FDL getOriginalFdlFromFormat(Format format)

Get the original FDL document used to create the given format. Returns NULL if the format was not created from an FDL.

Arguments

Result

FDL createFdlFromFormats(ArrayList<Format> formats, Format workingFormat, String creatorName, String contextName)

Create an FDL document from an array of FLAPI Formats

Arguments

Result

FDL mergeFdls(ArrayList<FDL> fdls, String fdlCreator)

Create an FDL document by merging the given input FDLs into one

Arguments

Result

FDLDocument getDocument()

Get the FDLDocument within this FDL object

Arguments

Result

FDLValidation validate()

Validate the FDLDocument within this FDL.

The FDLValidation object returned contains a Valid field to indicate whether the FDL is valid, and a list of any errors encountered when validating the FDL.

Arguments

Result

String getDefaultFramingIntent()

Return default framing intent ID

Arguments

Result

ArrayList<String> getFramingIntentIds()

Return array of framing intent IDs

Arguments

Result

FDLFramingIntent getFramingIntent(String framingIntentId)

Return FDLFramingIntent for the given ID

Arguments

Result

Long getNumContexts()

Return number of Contexts within FDL

Arguments

Result

FDLContext getContext(Long index)

Get FDLContext for the given index

Arguments

Result

ArrayList<String> getCanvasIds(Long index)

Get list of canvas IDs, optionally constrained by a given context ID

Arguments

Result

FDLCanvas getCanvas(String canvasId)

Return FDLCanvas for the given canvas ID

Arguments

Result

ArrayList<String> getCanvasTemplateIds()

Get list of canvas template IDs within FDL

Arguments

Result

FDLCanvasTemplate getCanvasTemplate(String templateId)

Get FDLCanvasTemplate for the given template ID

Arguments

Result

void saveToPath(String fdlPath, Long validate)

Save the FDL document to the given path in JSON format

Arguments

Result

String saveToString(Long validate)

Save the FDL document to string in JSON format

Arguments

Result

Format createFormatFromCanvas(FDLCreateFormatFromCanvasOptions options)

Create a FilmLight Format from an FDL Canvas

Arguments

Result

CompletableFuture<FDL> createAsync(FDLDocument fdlDocument)

Create an FDL Object from an FDLDocument

Arguments

Result

CompletableFuture<FDL> loadFromPathAsync(String fdlPath, Long validate)

Load the FDL from the given path

Arguments

Result

CompletableFuture<FDL> loadFromStringAsync(String fdlString, Long validate)

Load the FDL from the given JSON-formatted string

Arguments

Result

CompletableFuture<FDL> getOriginalFdlFromFormatAsync(Format format)

Get the original FDL document used to create the given format. Returns NULL if the format was not created from an FDL.

Arguments

Result

CompletableFuture<FDL> createFdlFromFormatsAsync(ArrayList<Format> formats, Format workingFormat, String creatorName, String contextName)

Create an FDL document from an array of FLAPI Formats

Arguments

Result

CompletableFuture<FDL> mergeFdlsAsync(ArrayList<FDL> fdls, String fdlCreator)

Create an FDL document by merging the given input FDLs into one

Arguments

Result

CompletableFuture<FDLDocument> getDocumentAsync()

Get the FDLDocument within this FDL object

Arguments

Result

CompletableFuture<FDLValidation> validateAsync()

Validate the FDLDocument within this FDL.

The FDLValidation object returned contains a Valid field to indicate whether the FDL is valid, and a list of any errors encountered when validating the FDL.

Arguments

Result

CompletableFuture<String> getDefaultFramingIntentAsync()

Return default framing intent ID

Arguments

Result

CompletableFuture<ArrayList<String>> getFramingIntentIdsAsync()

Return array of framing intent IDs

Arguments

Result

CompletableFuture<FDLFramingIntent> getFramingIntentAsync(String framingIntentId)

Return FDLFramingIntent for the given ID

Arguments

Result

CompletableFuture<Long> getNumContextsAsync()

Return number of Contexts within FDL

Arguments

Result

CompletableFuture<FDLContext> getContextAsync(Long index)

Get FDLContext for the given index

Arguments

Result

CompletableFuture<ArrayList<String>> getCanvasIdsAsync(Long index)

Get list of canvas IDs, optionally constrained by a given context ID

Arguments

Result

CompletableFuture<FDLCanvas> getCanvasAsync(String canvasId)

Return FDLCanvas for the given canvas ID

Arguments

Result

CompletableFuture<ArrayList<String>> getCanvasTemplateIdsAsync()

Get list of canvas template IDs within FDL

Arguments

Result

CompletableFuture<FDLCanvasTemplate> getCanvasTemplateAsync(String templateId)

Get FDLCanvasTemplate for the given template ID

Arguments

Result

CompletableFuture<void> saveToPathAsync(String fdlPath, Long validate)

Save the FDL document to the given path in JSON format

Arguments

Result

CompletableFuture<String> saveToStringAsync(Long validate)

Save the FDL document to string in JSON format

Arguments

Result

CompletableFuture<Format> createFormatFromCanvasAsync(FDLCreateFormatFromCanvasOptions options)

Create a FilmLight Format from an FDL Canvas

Arguments

Result

FLUXManage

Interface to FLUX Manage in Baselight & Daylight

Signals

Methods

Async Methods

FLUXManage get()

Returns the shared FLUXManage object

Arguments

Result

SequenceDescriptor getPrimarySelection()

Return the primary selected sequence

Arguments

Result

ArrayList<SequenceDescriptor> getSelectedSequences()

Return the array of selected sequences

Arguments

Result

ArrayList<FLUXFileInfo> getSelectedFiles()

Return the array of selected file paths

Arguments

Result

CompletableFuture<FLUXManage> getAsync()

Returns the shared FLUXManage object

Arguments

Result

CompletableFuture<SequenceDescriptor> getPrimarySelectionAsync()

Return the primary selected sequence

Arguments

Result

CompletableFuture<ArrayList<SequenceDescriptor>> getSelectedSequencesAsync()

Return the array of selected sequences

Arguments

Result

CompletableFuture<ArrayList<FLUXFileInfo>> getSelectedFilesAsync()

Return the array of selected file paths

Arguments

Result

Format

Format defines an image resolution and pixel aspect ratio with associated masks and burnins

Signals

Methods

Async Methods

String getName()

Return name of format

Arguments

Result

String getDescription()

Return description of format

Arguments

Result

FormatInfo getResolution(String res)

Return FormatInfo for given resolution of Format

Arguments

Result

ArrayList<String> getMappingNames()

Return names of mapping from this format to other formats

Arguments

Result

FormatMapping getMapping(String name)

Return definition of mapping from this format to named format

Arguments

Result

void addMapping(String name, FormatMapping mapping)

Add mapping from this format to the given named format. The mapping struct is optional. If the mapping is omitted, a default mapping is constructed which maps the current format inside of the destination format.

If you wish to map the source format outside of the destination format, you can pass a mapping struct with the sx, sy, tx and ty parameters set to zero, and the inside flag to set to 0.

'sx' and 'sy' are the scaling factors for the X and Y axes from the source format (or source mask, if specified) to the destination format (or destination mask, if specified).

'tx' and 'ty' are the translation for the X and Y axes, relative to the destination format.

If you wish to map from a mask within the source format and/or to a mask with destination format, you can specify those masks by name in the src_mask and dest_mask fields of FormatMapping.

Arguments

Result

void deleteMapping(String name)

Delete mapping to the given named format

Arguments

Result

ArrayList<FormatMask> getMasks()

Return array of FormatMasks defined for this format

Arguments

Result

ArrayList<String> getMaskNames()

Return list of mask names defined for this format

Arguments

Result

FormatMask getMask(String name)

Return the definition for the named mask in this format

Arguments

Result

Long hasMask(String name)

Return a flag indicating whether a mask of the given name is present in this format

Arguments

Result

void addMask(String name, FormatMask mask)

Add a new mask definition to this format

Arguments

Result

void deleteMask(String name)

Delete the definition for this given mask in this format

Arguments

Result

ArrayList<String> getBurninNames()

Return array of names of burnins defined for this format

Arguments

Result

FormatBurnin getBurnin(String name)

Return FormatBurnin object for the named burnin

Arguments

Result

FormatBurnin addBurnin(String name)

Create a new burnin with the given name, and return a FormatBurnin object for it

Arguments

Result

void deleteBurnin(String name)

Delete the burnin with the given name

Arguments

Result

CompletableFuture<String> getNameAsync()

Return name of format

Arguments

Result

CompletableFuture<String> getDescriptionAsync()

Return description of format

Arguments

Result

CompletableFuture<FormatInfo> getResolutionAsync(String res)

Return FormatInfo for given resolution of Format

Arguments

Result

CompletableFuture<ArrayList<String>> getMappingNamesAsync()

Return names of mapping from this format to other formats

Arguments

Result

CompletableFuture<FormatMapping> getMappingAsync(String name)

Return definition of mapping from this format to named format

Arguments

Result

CompletableFuture<void> addMappingAsync(String name, FormatMapping mapping)

Add mapping from this format to the given named format. The mapping struct is optional. If the mapping is omitted, a default mapping is constructed which maps the current format inside of the destination format.

If you wish to map the source format outside of the destination format, you can pass a mapping struct with the sx, sy, tx and ty parameters set to zero, and the inside flag to set to 0.

'sx' and 'sy' are the scaling factors for the X and Y axes from the source format (or source mask, if specified) to the destination format (or destination mask, if specified).

'tx' and 'ty' are the translation for the X and Y axes, relative to the destination format.

If you wish to map from a mask within the source format and/or to a mask with destination format, you can specify those masks by name in the src_mask and dest_mask fields of FormatMapping.

Arguments

Result

CompletableFuture<void> deleteMappingAsync(String name)

Delete mapping to the given named format

Arguments

Result

CompletableFuture<ArrayList<FormatMask>> getMasksAsync()

Return array of FormatMasks defined for this format

Arguments

Result

CompletableFuture<ArrayList<String>> getMaskNamesAsync()

Return list of mask names defined for this format

Arguments

Result

CompletableFuture<FormatMask> getMaskAsync(String name)

Return the definition for the named mask in this format

Arguments

Result

CompletableFuture<Long> hasMaskAsync(String name)

Return a flag indicating whether a mask of the given name is present in this format

Arguments

Result

CompletableFuture<void> addMaskAsync(String name, FormatMask mask)

Add a new mask definition to this format

Arguments

Result

CompletableFuture<void> deleteMaskAsync(String name)

Delete the definition for this given mask in this format

Arguments

Result

CompletableFuture<ArrayList<String>> getBurninNamesAsync()

Return array of names of burnins defined for this format

Arguments

Result

CompletableFuture<FormatBurnin> getBurninAsync(String name)

Return FormatBurnin object for the named burnin

Arguments

Result

CompletableFuture<FormatBurnin> addBurninAsync(String name)

Create a new burnin with the given name, and return a FormatBurnin object for it

Arguments

Result

CompletableFuture<void> deleteBurninAsync(String name)

Delete the burnin with the given name

Arguments

Result

FormatBurnin

Definition of a burn-in for a Format

Signals

Methods

Async Methods

Double getOpacity()

Get burnin opacity

Arguments

Result

void setOpacity(Double opacity)

Set burnin opacity

Arguments

Result

ArrayList<Double> getBoxColour()

Set colour of box around text items

Arguments

Result

void setBoxColour(ArrayList<Double> colour)

Set colour of box around text items

Arguments

Result

String getFont()

Get font name for this burnin

Arguments

Result

void setFont(String name)

Set font name for this burnin

Arguments

Result

void addItem(FormatBurninItem item)

Add new item to the burnin

Arguments

Result

Long getNumItems()

Return number of items defined within this burnin

Arguments

Result

FormatBurninItem getItem(Long index)

Return definition for the burnin item at the given index

Arguments

Result

void setItem(Long index, FormatBurninItem item)

Return definition for the burnin item at the given index

Arguments

Result

void deleteItem(Long index)

Delete the burnin item at the given index

Arguments

Result

CompletableFuture<Double> getOpacityAsync()

Get burnin opacity

Arguments

Result

CompletableFuture<void> setOpacityAsync(Double opacity)

Set burnin opacity

Arguments

Result

CompletableFuture<ArrayList<Double>> getBoxColourAsync()

Set colour of box around text items

Arguments

Result

CompletableFuture<void> setBoxColourAsync(ArrayList<Double> colour)

Set colour of box around text items

Arguments

Result

CompletableFuture<String> getFontAsync()

Get font name for this burnin

Arguments

Result

CompletableFuture<void> setFontAsync(String name)

Set font name for this burnin

Arguments

Result

CompletableFuture<void> addItemAsync(FormatBurninItem item)

Add new item to the burnin

Arguments

Result

CompletableFuture<Long> getNumItemsAsync()

Return number of items defined within this burnin

Arguments

Result

CompletableFuture<FormatBurninItem> getItemAsync(Long index)

Return definition for the burnin item at the given index

Arguments

Result

CompletableFuture<void> setItemAsync(Long index, FormatBurninItem item)

Return definition for the burnin item at the given index

Arguments

Result

CompletableFuture<void> deleteItemAsync(Long index)

Delete the burnin item at the given index

Arguments

Result

FormatSet

The FormatSet interface allows enumeration of available resources on the FilmLight system such as formats, colour spaces, display render transforms, LUTs, etc.

Signals

Methods

Async Methods

FormatSet factoryFormats()

Return factory FormatSet object for factory (built-in) formats

Arguments

Result

FormatSet globalFormats()

Return global FormatSet object for formats defined in formats database

Arguments

Result

FormatSet jobFormats(String hostname, String jobname)

Return FormatSet object for formats defined in the given Job database

Arguments

Result

ArrayList<String> getDrtNames()

Return array of Display Rendering Transform names

Arguments

Result

DRTInfo getDrtInfo(String name)

Return information for the given Display Rendering Transform name

Arguments

Result

String getScope()

Return scope this is FormatSet represents

Arguments

Result

String getScopePath()

Return the path for FormatSets representing a job/scene scope

Arguments

Result

String getBasicFormatName(Long width, Long height, Double pixelAspectRatio)

Return name for a basic (auto-generated) format

Arguments

Result

ArrayList<String> getFormatNames()

Return array of format names

Arguments

Result

Format getFormat(String name)

Return Format object for the named format

Arguments

Result

Format addFormat(String name, String description, Long width, Long height, Double pixelAspectRatio)

Add a new format to this FormatSet

Arguments

Result

void deleteFormat(String name)

Delete a format from the FormatSet

Arguments

Result

Long hasFormat(String name)

Check if the given format name exists within this FormatSet

Arguments

Result

ArrayList<String> getColourSpaceNames()

Return array of colour space names

Arguments

Result

ColourSpaceInfo getColourSpaceInfo(String name)

Return information on the given colour space

Arguments

Result

void reload()

Reload the contents of the FormatSet from database

Arguments

Result

CompletableFuture<FormatSet> factoryFormatsAsync()

Return factory FormatSet object for factory (built-in) formats

Arguments

Result

CompletableFuture<FormatSet> globalFormatsAsync()

Return global FormatSet object for formats defined in formats database

Arguments

Result

CompletableFuture<FormatSet> jobFormatsAsync(String hostname, String jobname)

Return FormatSet object for formats defined in the given Job database

Arguments

Result

CompletableFuture<ArrayList<String>> getDrtNamesAsync()

Return array of Display Rendering Transform names

Arguments

Result

CompletableFuture<DRTInfo> getDrtInfoAsync(String name)

Return information for the given Display Rendering Transform name

Arguments

Result

CompletableFuture<String> getScopeAsync()

Return scope this is FormatSet represents

Arguments

Result

CompletableFuture<String> getScopePathAsync()

Return the path for FormatSets representing a job/scene scope

Arguments

Result

CompletableFuture<String> getBasicFormatNameAsync(Long width, Long height, Double pixelAspectRatio)

Return name for a basic (auto-generated) format

Arguments

Result

CompletableFuture<ArrayList<String>> getFormatNamesAsync()

Return array of format names

Arguments

Result

CompletableFuture<Format> getFormatAsync(String name)

Return Format object for the named format

Arguments

Result

CompletableFuture<Format> addFormatAsync(String name, String description, Long width, Long height, Double pixelAspectRatio)

Add a new format to this FormatSet

Arguments

Result

CompletableFuture<void> deleteFormatAsync(String name)

Delete a format from the FormatSet

Arguments

Result

CompletableFuture<Long> hasFormatAsync(String name)

Check if the given format name exists within this FormatSet

Arguments

Result

CompletableFuture<ArrayList<String>> getColourSpaceNamesAsync()

Return array of colour space names

Arguments

Result

CompletableFuture<ColourSpaceInfo> getColourSpaceInfoAsync(String name)

Return information on the given colour space

Arguments

Result

CompletableFuture<void> reloadAsync()

Reload the contents of the FormatSet from database

Arguments

Result

Image

Signals

Methods

Async Methods

HashMap<String,Object> getRawMetadata(String filename)

Returns raw metadata for the image or movie at the supplied path

Arguments

Result

CompletableFuture<HashMap<String,Object>> getRawMetadataAsync(String filename)

Returns raw metadata for the image or movie at the supplied path

Arguments

Result

JobManager

Query and manipulate the FilmLight job database

Signals

Methods

Async Methods

ArrayList<String> getJobs(String host)

Fetch list of jobs in job database

Arguments

Result

ArrayList<String> getFolders(String host, String job, String folder, Long recursive)

Fetch list of folder names within job/folder in job database

Arguments

Result

ArrayList<String> getScenes(String host, String job, String folder)

Fetch list of scene names within job/folder in job database

Arguments

Result

void createJob(String host, String jobname)

Create a new job

Arguments

Result

void renameJob(String host, String jobname, String new_jobname)

Rename job

Arguments

Result

void deleteJob(String host, String jobname, Long force)

Delete job

Arguments

Result

Long jobExists(String host, String jobname)

Check if job exists

Arguments

Result

void createFolder(String host, String jobname, String foldername)

Create a folder within job

Arguments

Result

void renameFolder(String host, String jobname, String foldername, String new_foldername)

Rename folder

Arguments

Result

void deleteFolder(String host, String jobname, String foldername)

Delete folder

Arguments

Result

SceneInfo getSceneInfo(String host, String jobname, String scenename)

Return information about scene

Arguments

Result

Long sceneExists(String host, String jobname, String scenename)

Check if scene exists

Arguments

Result

void deleteScene(String host, String jobname, String scenename, Long ignoreLocks)

Delete scene

Arguments

Result

void renameScene(String host, String jobname, String scenename, String newname)

Rename scene

Arguments

Result

CompletableFuture<ArrayList<String>> getJobsAsync(String host)

Fetch list of jobs in job database

Arguments

Result

CompletableFuture<ArrayList<String>> getFoldersAsync(String host, String job, String folder, Long recursive)

Fetch list of folder names within job/folder in job database

Arguments

Result

CompletableFuture<ArrayList<String>> getScenesAsync(String host, String job, String folder)

Fetch list of scene names within job/folder in job database

Arguments

Result

CompletableFuture<void> createJobAsync(String host, String jobname)

Create a new job

Arguments

Result

CompletableFuture<void> renameJobAsync(String host, String jobname, String new_jobname)

Rename job

Arguments

Result

CompletableFuture<void> deleteJobAsync(String host, String jobname, Long force)

Delete job

Arguments

Result

CompletableFuture<Long> jobExistsAsync(String host, String jobname)

Check if job exists

Arguments

Result

CompletableFuture<void> createFolderAsync(String host, String jobname, String foldername)

Create a folder within job

Arguments

Result

CompletableFuture<void> renameFolderAsync(String host, String jobname, String foldername, String new_foldername)

Rename folder

Arguments

Result

CompletableFuture<void> deleteFolderAsync(String host, String jobname, String foldername)

Delete folder

Arguments

Result

CompletableFuture<SceneInfo> getSceneInfoAsync(String host, String jobname, String scenename)

Return information about scene

Arguments

Result

CompletableFuture<Long> sceneExistsAsync(String host, String jobname, String scenename)

Check if scene exists

Arguments

Result

CompletableFuture<void> deleteSceneAsync(String host, String jobname, String scenename, Long ignoreLocks)

Delete scene

Arguments

Result

CompletableFuture<void> renameSceneAsync(String host, String jobname, String scenename, String newname)

Rename scene

Arguments

Result

Licence

Licence management

Signals

Methods

Async Methods

String getSystemId()

Return the system ID used to identify this system for licensing

Arguments

Result

ArrayList<LicenceItem> getLicenceInfo(Long include_expired)

Return licence information

Arguments

Result

void installLicence(String licenceData)

Install the given licence data

Arguments

Result

CompletableFuture<String> getSystemIdAsync()

Return the system ID used to identify this system for licensing

Arguments

Result

CompletableFuture<ArrayList<LicenceItem>> getLicenceInfoAsync(Long include_expired)

Return licence information

Arguments

Result

CompletableFuture<void> installLicenceAsync(String licenceData)

Install the given licence data

Arguments

Result

Mark

Mark defined in a Shot or Scene

Signals

Methods

Async Methods

Long getId()

Return Mark object ID

Arguments

Result

String getType()

Return Mark type

Arguments

Result

Double getPosition()

Return Mark position For Shot marks, this value is a frame number relative to the start of the image sequence. For Strip marks, this value is a time in seconds relative to the start of the strip. For Timeline marks, this value is a time in seconds relative to the start of the timeline.

Arguments

Result

Double getTime()

Return Mark position in seconds For Shot and Strip marks, this returns the time relative to the start of the shot For Timeline marks, this returns the time relative to the start of the timeline

Arguments

Result

String getNoteText()

Return Mark note text

Arguments

Result

ArrayList<Double> getColour()

Return Mark colour

Arguments

Result

String getCategory()

Return Mark category

Arguments

Result

Long getSourceFrame(String eye)

Return the source image frame number for this mark Only applicable for Shot/Strip marks. Will fail for Timeline marks

Arguments

Result

Timecode getSourceTimecode(String eye)

Return the source image timecode for this mark Only applicable for Shot/Strip marks. Will fail for Timeline marks

Arguments

Result

Long getRecordFrame()

Return the source image frame number for this mark

Arguments

Result

Timecode getRecordTimecode()

Return the source image timecode for this mark

Arguments

Result

HashMap<String,Object> getProperties()

Return dictionary of properties for this Mark object

Arguments

Result

void setProperties(HashMap<String,Object> props)

Set the property values for the given dictionary of keys & values. Setting a value to NULL will remove it from the property set.

Arguments

Result

CompletableFuture<Long> getIdAsync()

Return Mark object ID

Arguments

Result

CompletableFuture<String> getTypeAsync()

Return Mark type

Arguments

Result

CompletableFuture<Double> getPositionAsync()

Return Mark position For Shot marks, this value is a frame number relative to the start of the image sequence. For Strip marks, this value is a time in seconds relative to the start of the strip. For Timeline marks, this value is a time in seconds relative to the start of the timeline.

Arguments

Result

CompletableFuture<Double> getTimeAsync()

Return Mark position in seconds For Shot and Strip marks, this returns the time relative to the start of the shot For Timeline marks, this returns the time relative to the start of the timeline

Arguments

Result

CompletableFuture<String> getNoteTextAsync()

Return Mark note text

Arguments

Result

CompletableFuture<ArrayList<Double>> getColourAsync()

Return Mark colour

Arguments

Result

CompletableFuture<String> getCategoryAsync()

Return Mark category

Arguments

Result

CompletableFuture<Long> getSourceFrameAsync(String eye)

Return the source image frame number for this mark Only applicable for Shot/Strip marks. Will fail for Timeline marks

Arguments

Result

CompletableFuture<Timecode> getSourceTimecodeAsync(String eye)

Return the source image timecode for this mark Only applicable for Shot/Strip marks. Will fail for Timeline marks

Arguments

Result

CompletableFuture<Long> getRecordFrameAsync()

Return the source image frame number for this mark

Arguments

Result

CompletableFuture<Timecode> getRecordTimecodeAsync()

Return the source image timecode for this mark

Arguments

Result

CompletableFuture<HashMap<String,Object>> getPropertiesAsync()

Return dictionary of properties for this Mark object

Arguments

Result

CompletableFuture<void> setPropertiesAsync(HashMap<String,Object> props)

Set the property values for the given dictionary of keys & values. Setting a value to NULL will remove it from the property set.

Arguments

Result

A menu in the application user interface, which contains MenuItems BETA

Signals

Methods

Async Methods

Create new Menu object

Arguments

Result

Add MenuItem to menu

Arguments

Result

Get number of items in menu

Arguments

Result

Get MenuItem at given index within menu

Arguments

Result

Return the index of the given MenuItem within this Menu

Arguments

Result

Remove menu item at the given index

Arguments

Result

Remove menu item from menu

Arguments

Result

Remove all menu items from menu

Arguments

Result

Create new Menu object

Arguments

Result

Add MenuItem to menu

Arguments

Result

Get number of items in menu

Arguments

Result

Get MenuItem at given index within menu

Arguments

Result

Return the index of the given MenuItem within this Menu

Arguments

Result

Remove menu item at the given index

Arguments

Result

Remove menu item from menu

Arguments

Result

Remove all menu items from menu

Arguments

Result

A menu item in the application user interface, which can trigger actions BETA

Signals

Methods

Async Methods

Create a new MenuItem object

Arguments

Result

Register this menu item to insert it into the application's UI

Arguments

Result

Get menu item title

Arguments

Result

Set menu item title

Arguments

Result

Get menu item enabled state

Arguments

Result

Set menu item enabled state

Arguments

Result

Get menu item hidden state

Arguments

Result

Set menu item hidden state

Arguments

Result

Get sub-menu for this menu item

Arguments

Result

Set sub-menu for this menu item

Arguments

Result

Set keyboard accelerator for this menu item.

This method can fail if the accelerator is already in use.

Arguments

Result

Create a new MenuItem object

Arguments

Result

Register this menu item to insert it into the application's UI

Arguments

Result

Get menu item title

Arguments

Result

Set menu item title

Arguments

Result

Get menu item enabled state

Arguments

Result

Set menu item enabled state

Arguments

Result

Get menu item hidden state

Arguments

Result

Set menu item hidden state

Arguments

Result

Get sub-menu for this menu item

Arguments

Result

Set sub-menu for this menu item

Arguments

Result

Set keyboard accelerator for this menu item.

This method can fail if the accelerator is already in use.

Arguments

Result

MultiPaste

Multi-Paste operation

Signals

Methods

Async Methods

MultiPaste create()

Create a new Multi-Paste operation object

Arguments

Result

Long multiPaste(Scene scene, MultiPasteSettings settings, ArrayList<Long> shot_ids)

Perform multi-paste operation using the given Multi-Paste settings

Arguments

Result

ArrayList<MultiPasteProgress> getLog()

Return log of progress information

Arguments

Result

CompletableFuture<MultiPaste> createAsync()

Create a new Multi-Paste operation object

Arguments

Result

CompletableFuture<Long> multiPasteAsync(Scene scene, MultiPasteSettings settings, ArrayList<Long> shot_ids)

Perform multi-paste operation using the given Multi-Paste settings

Arguments

Result

CompletableFuture<ArrayList<MultiPasteProgress>> getLogAsync()

Return log of progress information

Arguments

Result

ProgressDialog (BETA)

Display a progress dialog within the application BETA

Signals

Methods

Async Methods

ProgressDialog create(String title, String msg, Long cancellable) BETA

Create a new ProgressDialog

Arguments

Result

void show(Double delay) BETA

Show the progress dialog

Arguments

Result

void setTitle(String title) BETA

Set the title of the progress dialog

Arguments

Result

void setProgress(Double progress, String message) BETA

Update the progress & message displayed in dialog

Arguments

Result

Long isCancelled() BETA

Return flag indicating whether the user has clicked the Cancel button on this ProgressDialog

Arguments

Result

void hide() BETA

Hide the progress dialog

Arguments

Result

CompletableFuture<ProgressDialog> createAsync(String title, String msg, Long cancellable) BETA

Create a new ProgressDialog

Arguments

Result

CompletableFuture<void> showAsync(Double delay) BETA

Show the progress dialog

Arguments

Result

CompletableFuture<void> setTitleAsync(String title) BETA

Set the title of the progress dialog

Arguments

Result

CompletableFuture<void> setProgressAsync(Double progress, String message) BETA

Update the progress & message displayed in dialog

Arguments

Result

CompletableFuture<Long> isCancelledAsync() BETA

Return flag indicating whether the user has clicked the Cancel button on this ProgressDialog

Arguments

Result

CompletableFuture<void> hideAsync() BETA

Hide the progress dialog

Arguments

Result

QueueManager

Interface for managing the Queue on a Baselight/Daylight system

Signals

Methods

Async Methods

QueueManager create(String zone)

Create a QueueManager object to examine and manipulate the queue on the given zone

Arguments

Result

QueueManager createLocal()

Create a QueueManager object to examine and manipulate the queue on the local zone

Arguments

Result

QueueManager createNoDatabase()

Create a QueueManager object to examine and manipulate a non-database queue in the FLAPI process. In addition, the QueueManager object will process any operations added to the queue within the FLAPI process.

Arguments

Result

ArrayList<String> getQueueZones()

Return list of available zones running queue services

Arguments

Result

ArrayList<Long> getOperationIds()

Return list operation IDs in queue

Arguments

Result

QueueOp getOperation(Long id)

Return definition of given operation ID

Arguments

Result

QueueOpStatus getOperationStatus(Long id)

Return status of given operation ID

Arguments

Result

ArrayList<QueueLogItem> getOperationLog(Long id)

Return log for given operation ID

Arguments

Result

void pauseOperation(Long id)

Pause operation with given operation ID

Arguments

Result

void resumeOperation(Long id)

Resume operation with given operation ID

Arguments

Result

void restartOperation(Long id)

Restart operation with given operation ID

Arguments

Result

void deleteOperation(Long id)

Delete operation with given operation ID

Arguments

Result

void archiveOperation(Long id)

Archive operation with given operation ID

Arguments

Result

void enableUpdates()

Enable status update signals

Arguments

Result

void disableUpdates()

Disable status update signals

Arguments

Result

Long newOperation(String opType, String desc, HashMap<String,Object> params, ArrayList<QueueOpTask> tasks, Set<Long> dependsOn) BETA

Create a new custom operation and return its ID

Arguments

Result

void addTasksToOperation(Long opid, ArrayList<QueueOpTask> tasks) BETA

Add more tasks to the given operation

Arguments

Result

void setOperationReady(Long opid) BETA

Mark operation as ready to process. Should be called after calling add_tasks_to_operation().

Arguments

Result

Long getNextOperationOfType(String opType, Long wait) BETA

Find the next operation for the given operation type that is ready to execute

Arguments

Result

HashMap<String,Object> getOperationParams(Long opid) BETA

Get params for given operation ID

Arguments

Result

QueueOpTask getNextTask(Long opid) BETA

Get the next task ready to execute for the given operation ID

Arguments

Result

void setTaskProgress(Long opid, Long taskseq, Double progress) BETA

Set task progress

Arguments

Result

void setTaskDone(Long opid, Long taskseq, String msg) BETA

Mark task as completed

Arguments

Result

void setTaskFailed(Long opid, Long taskseq, String msg, String detail, Long frame) BETA

Mark task as failed

Arguments

Result

void addOperationLog(Long opid, String type, String msg, String detail) BETA

Add log entry for operation

Arguments

Result

void addTaskLog(Long opid, Long taskseq, String type, String msg, String detail, Long frame) BETA

Add log entry for operation

Arguments

Result

CompletableFuture<QueueManager> createAsync(String zone)

Create a QueueManager object to examine and manipulate the queue on the given zone

Arguments

Result

CompletableFuture<QueueManager> createLocalAsync()

Create a QueueManager object to examine and manipulate the queue on the local zone

Arguments

Result

CompletableFuture<QueueManager> createNoDatabaseAsync()

Create a QueueManager object to examine and manipulate a non-database queue in the FLAPI process. In addition, the QueueManager object will process any operations added to the queue within the FLAPI process.

Arguments

Result

CompletableFuture<ArrayList<String>> getQueueZonesAsync()

Return list of available zones running queue services

Arguments

Result

CompletableFuture<ArrayList<Long>> getOperationIdsAsync()

Return list operation IDs in queue

Arguments

Result

CompletableFuture<QueueOp> getOperationAsync(Long id)

Return definition of given operation ID

Arguments

Result

CompletableFuture<QueueOpStatus> getOperationStatusAsync(Long id)

Return status of given operation ID

Arguments

Result

CompletableFuture<ArrayList<QueueLogItem>> getOperationLogAsync(Long id)

Return log for given operation ID

Arguments

Result

CompletableFuture<void> pauseOperationAsync(Long id)

Pause operation with given operation ID

Arguments

Result

CompletableFuture<void> resumeOperationAsync(Long id)

Resume operation with given operation ID

Arguments

Result

CompletableFuture<void> restartOperationAsync(Long id)

Restart operation with given operation ID

Arguments

Result

CompletableFuture<void> deleteOperationAsync(Long id)

Delete operation with given operation ID

Arguments

Result

CompletableFuture<void> archiveOperationAsync(Long id)

Archive operation with given operation ID

Arguments

Result

CompletableFuture<void> enableUpdatesAsync()

Enable status update signals

Arguments

Result

CompletableFuture<void> disableUpdatesAsync()

Disable status update signals

Arguments

Result

CompletableFuture<Long> newOperationAsync(String opType, String desc, HashMap<String,Object> params, ArrayList<QueueOpTask> tasks, Set<Long> dependsOn) BETA

Create a new custom operation and return its ID

Arguments

Result

CompletableFuture<void> addTasksToOperationAsync(Long opid, ArrayList<QueueOpTask> tasks) BETA

Add more tasks to the given operation

Arguments

Result

CompletableFuture<void> setOperationReadyAsync(Long opid) BETA

Mark operation as ready to process. Should be called after calling add_tasks_to_operation().

Arguments

Result

CompletableFuture<Long> getNextOperationOfTypeAsync(String opType, Long wait) BETA

Find the next operation for the given operation type that is ready to execute

Arguments

Result

CompletableFuture<HashMap<String,Object>> getOperationParamsAsync(Long opid) BETA

Get params for given operation ID

Arguments

Result

CompletableFuture<QueueOpTask> getNextTaskAsync(Long opid) BETA

Get the next task ready to execute for the given operation ID

Arguments

Result

CompletableFuture<void> setTaskProgressAsync(Long opid, Long taskseq, Double progress) BETA

Set task progress

Arguments

Result

CompletableFuture<void> setTaskDoneAsync(Long opid, Long taskseq, String msg) BETA

Mark task as completed

Arguments

Result

CompletableFuture<void> setTaskFailedAsync(Long opid, Long taskseq, String msg, String detail, Long frame) BETA

Mark task as failed

Arguments

Result

CompletableFuture<void> addOperationLogAsync(Long opid, String type, String msg, String detail) BETA

Add log entry for operation

Arguments

Result

CompletableFuture<void> addTaskLogAsync(Long opid, Long taskseq, String type, String msg, String detail, Long frame) BETA

Add log entry for operation

Arguments

Result

RenderProcessor

A RenderProcessor will execute a RenderSetup and produce deliverable data

Signals

Methods

Async Methods

RenderProcessor get()

Get RenderProcessor instance

Arguments

Result

void start(RenderSetup renderSetup)

Start render operation for the given RenderSetup

Arguments

Result

RenderStatus getProgress()

Returns current render progress

Arguments

Result

ArrayList<RenderProcessorLogItem> getLog()

Get log of operation progress

Arguments

Result

void shutdown()

Shutdown the RenderProcessor instance. This releases any resources in use by the RenderProcessor.

Arguments

Result

CompletableFuture<RenderProcessor> getAsync()

Get RenderProcessor instance

Arguments

Result

CompletableFuture<void> startAsync(RenderSetup renderSetup)

Start render operation for the given RenderSetup

Arguments

Result

CompletableFuture<RenderStatus> getProgressAsync()

Returns current render progress

Arguments

Result

CompletableFuture<ArrayList<RenderProcessorLogItem>> getLogAsync()

Get log of operation progress

Arguments

Result

CompletableFuture<void> shutdownAsync()

Shutdown the RenderProcessor instance. This releases any resources in use by the RenderProcessor.

Arguments

Result

RenderSetup

Setup Baselight/Daylight scene for rendering

Signals

Methods

Async Methods

ArrayList<RenderFileTypeInfo> getImageTypes()

Return array of supported image types for rendering

Arguments

Result

ArrayList<RenderFileTypeInfo> getMovieTypes()

Return array of movie types for rendering

Arguments

Result

ArrayList<RenderCodecInfo> getMovieCodecs(String movieType)

Return array of video codecs available for the given movie type

Arguments

Result

ArrayList<RenderCodecInfo> getMovieAudioCodecs(String movieType)

Return array of audio codecs available for the given movie type

Arguments

Result

RenderSetup create()

Create a new RenderSetup instance

Arguments

Result

RenderSetup createFromScene(Scene scene)

Create a new RenderSetup instance configured to render the given Scene using its default deliverables

Arguments

Result

Scene getScene()

Return Scene object for RenderSetup

Arguments

Result

void setScene(Scene scene)

Set Scene to Render

Arguments

Result

void saveIntoScene(Scene scene)

Save the deliverables from this RenderSetup into the Scene. If a delta is not in progress on the Scene, a new delta will be created for the save operation.

Arguments

Result

void setDeliverablesFromScene(Scene scene)

Load Deliverables from Scene object assigned to this RenderSetup object

Arguments

Result

Long getNumDeliverables()

Render number of deliverables defined for this Scene

Arguments

Result

ArrayList<String> getDeliverableNames()

Return array of deliverable names

Arguments

Result

RenderDeliverable getDeliverable(Long index)

Return the RenderDeliverable definition at the given index

Arguments

Result

void setDeliverable(Long index, RenderDeliverable deliverable)

Set the settings for the deliverable at the given index

Arguments

Result

RenderDeliverable getDeliverableByName(String name)

Get the settings for the RenderDeliverable definition with the given name. Returns NULL if not matching deliverable can be found.

Arguments

Result

void setDeliverableByName(String name, RenderDeliverable deliverable)

Set the settings for the RenderDeliverable definition with the given name

Arguments

Result

void addDeliverable(RenderDeliverable deliverable)

Add a new deliverable to be generated as part of this render operation

Arguments

Result

void deleteDeliverable(Long index)

Delete the deliverable at the given index

Arguments

Result

void deleteAllDeliverables()

Delete all deliverables defined in the RenderSetup

Arguments

Result

void getDeliverableEnabled(Long index)

Get enabled state of deliverable at given index

Arguments

Result

void setDeliverableEnabled(Long index, Long enabled)

Set enabled state of deliverable at given index

Arguments

Result

String getOutputFilenameForDeliverable(Long index, Long leave_container, Long frame)

Return the full filename for the given frame number of a deliverable

Arguments

Result

void setContainer(String container)

Set the output container directory for all deliverables

Arguments

Result

ArrayList<FrameRange> getFrames()

Get list of frame ranges to render

Arguments

Result

void setFrames(ArrayList<FrameRange> frames)

Set list of frame ranges to render

Arguments

Result

void selectAll()

Select all frames in Scene to render

Arguments

Result

void selectShots(ArrayList<Shot> shots)

Select the given Shots for rendering

Arguments

Result

void selectShotIds(ArrayList<Long> shotids)

Select the given Shots identified by their ID for rendering

Arguments

Result

void selectGradedShots()

Select all graded shots to render

Arguments

Result

void selectTimelineMarks(Set<String> categories)

Select timeline marks matching the categories in the given category set

Arguments

Result

void selectShotMarks(Set<String> categories)

Select shot marks matching the categories in the given category set

Arguments

Result

void selectPosterFrames()

Select all shot poster frames to render

Arguments

Result

void selectShotsOfCategory(Set<String> categories)

Select shots marked with one of the categories in the given category set

Arguments

Result

RenderOpInfo submitToQueue(QueueManager queue, String opname)

Submit the current Render operation to a Queue for processing

Arguments

Result

CompletableFuture<ArrayList<RenderFileTypeInfo>> getImageTypesAsync()

Return array of supported image types for rendering

Arguments

Result

CompletableFuture<ArrayList<RenderFileTypeInfo>> getMovieTypesAsync()

Return array of movie types for rendering

Arguments

Result

CompletableFuture<ArrayList<RenderCodecInfo>> getMovieCodecsAsync(String movieType)

Return array of video codecs available for the given movie type

Arguments

Result

CompletableFuture<ArrayList<RenderCodecInfo>> getMovieAudioCodecsAsync(String movieType)

Return array of audio codecs available for the given movie type

Arguments

Result

CompletableFuture<RenderSetup> createAsync()

Create a new RenderSetup instance

Arguments

Result

CompletableFuture<RenderSetup> createFromSceneAsync(Scene scene)

Create a new RenderSetup instance configured to render the given Scene using its default deliverables

Arguments

Result

CompletableFuture<Scene> getSceneAsync()

Return Scene object for RenderSetup

Arguments

Result

CompletableFuture<void> setSceneAsync(Scene scene)

Set Scene to Render

Arguments

Result

CompletableFuture<void> saveIntoSceneAsync(Scene scene)

Save the deliverables from this RenderSetup into the Scene. If a delta is not in progress on the Scene, a new delta will be created for the save operation.

Arguments

Result

CompletableFuture<void> setDeliverablesFromSceneAsync(Scene scene)

Load Deliverables from Scene object assigned to this RenderSetup object

Arguments

Result

CompletableFuture<Long> getNumDeliverablesAsync()

Render number of deliverables defined for this Scene

Arguments

Result

CompletableFuture<ArrayList<String>> getDeliverableNamesAsync()

Return array of deliverable names

Arguments

Result

CompletableFuture<RenderDeliverable> getDeliverableAsync(Long index)

Return the RenderDeliverable definition at the given index

Arguments

Result

CompletableFuture<void> setDeliverableAsync(Long index, RenderDeliverable deliverable)

Set the settings for the deliverable at the given index

Arguments

Result

CompletableFuture<RenderDeliverable> getDeliverableByNameAsync(String name)

Get the settings for the RenderDeliverable definition with the given name. Returns NULL if not matching deliverable can be found.

Arguments

Result

CompletableFuture<void> setDeliverableByNameAsync(String name, RenderDeliverable deliverable)

Set the settings for the RenderDeliverable definition with the given name

Arguments

Result

CompletableFuture<void> addDeliverableAsync(RenderDeliverable deliverable)

Add a new deliverable to be generated as part of this render operation

Arguments

Result

CompletableFuture<void> deleteDeliverableAsync(Long index)

Delete the deliverable at the given index

Arguments

Result

CompletableFuture<void> deleteAllDeliverablesAsync()

Delete all deliverables defined in the RenderSetup

Arguments

Result

CompletableFuture<void> getDeliverableEnabledAsync(Long index)

Get enabled state of deliverable at given index

Arguments

Result

CompletableFuture<void> setDeliverableEnabledAsync(Long index, Long enabled)

Set enabled state of deliverable at given index

Arguments

Result

CompletableFuture<String> getOutputFilenameForDeliverableAsync(Long index, Long leave_container, Long frame)

Return the full filename for the given frame number of a deliverable

Arguments

Result

CompletableFuture<void> setContainerAsync(String container)

Set the output container directory for all deliverables

Arguments

Result

CompletableFuture<ArrayList<FrameRange>> getFramesAsync()

Get list of frame ranges to render

Arguments

Result

CompletableFuture<void> setFramesAsync(ArrayList<FrameRange> frames)

Set list of frame ranges to render

Arguments

Result

CompletableFuture<void> selectAllAsync()

Select all frames in Scene to render

Arguments

Result

CompletableFuture<void> selectShotsAsync(ArrayList<Shot> shots)

Select the given Shots for rendering

Arguments

Result

CompletableFuture<void> selectShotIdsAsync(ArrayList<Long> shotids)

Select the given Shots identified by their ID for rendering

Arguments

Result

CompletableFuture<void> selectGradedShotsAsync()

Select all graded shots to render

Arguments

Result

CompletableFuture<void> selectTimelineMarksAsync(Set<String> categories)

Select timeline marks matching the categories in the given category set

Arguments

Result

CompletableFuture<void> selectShotMarksAsync(Set<String> categories)

Select shot marks matching the categories in the given category set

Arguments

Result

CompletableFuture<void> selectPosterFramesAsync()

Select all shot poster frames to render

Arguments

Result

CompletableFuture<void> selectShotsOfCategoryAsync(Set<String> categories)

Select shots marked with one of the categories in the given category set

Arguments

Result

CompletableFuture<RenderOpInfo> submitToQueueAsync(QueueManager queue, String opname)

Submit the current Render operation to a Queue for processing

Arguments

Result

Scene

Interface for opening, creating, accessing and modifying Scenes.

Scene modifications are usually made using a delta. A delta batches together one or more scene edits/modifications into a single, undo-able transaction. A client wishing to modify a scene would typically:

  1. Start a delta using the start_delta() method (supplying a user friendly name for the delta/operation they're performing).
  2. Make edits on the scene using whatever 'set' type methods are required for the operation.
  3. End the delta using the end_delta() method.

Signals

Methods

Async Methods

ScenePath parsePath(String str)

Convert the given string into a ScenePath object contaning Host, Job, Scene components, or raise an error if the path is invalid

Arguments

Result

String pathToString(ScenePath scenepath)

Convert the given ScenePath object into a string

Arguments

Result

Scene create()

Create an empty Scene object, which can then be used to create a temporary scene, a new scene, or load an existing scene. After creating an empty Scene object, you must call ::temporary_scene_nonblock::, ::new_scene_nonblock:: or ::open_scene_nonblock::.

Arguments

Result

Scene newScene(ScenePath scenepath, NewSceneOptions options)

Create a new scene stored in a database. This function will block until the new scene has been created in the database. If the new scene cannot be created, this function will raise an exception containing an error message.

Arguments

Result

Scene openScene(ScenePath scenepath, Set<String> flags)

Open a scene. This function will block until the scene has been opened. If the scene cannot be opened, this function will raise an exception containing an error message.

Arguments

Result

Scene temporaryScene(NewSceneOptions options)

Create a temporary scene that is not stored in a database. This function will block until the temporary scene has been created. If the temporary scene cannot be created, this function will raise an exception containing an error message.

Arguments

Result

void newSceneNonblock(ScenePath scenepath, NewSceneOptions options)

Create a new scene

Arguments

Result

void openSceneNonblock(ScenePath scenepath, Set<String> flags)

Open a scene

Arguments

Result

void temporarySceneNonblock(NewSceneOptions options)

Create a temporary scene that is not stored in a database

Arguments

Result

void saveScene()

Save changes to scene into database

Arguments

Result

OpenSceneStatus getOpenStatus()

Fetch status of scene open operation

Arguments

Result

OpenSceneStatus waitUntilOpen()

Wait for any scene opening/creation operations to complete, and return the status

Arguments

Result

Long closeScene()

Close scene

Arguments

Result

String getScenePathname()

Get current scene's 'pathname' string (typically 'host:job:scene')

Arguments

Result

String getSceneContainer()

Get the current container for the scene

Arguments

Result

void setSceneContainer(String container)

Set the current container for the scene

Arguments

Result

void startDelta(String name)

Start a 'delta' on a scene that has been opened read/write. A delta is a set of modifcations/edits on a scene that together constitute a single, logical operation/transaction. Each start_delta call must have a matching end_delta call (with one or more editing operations in between). Every delta has a user visible name (eg. 'Change Film Grade Exposure'). Once a delta has been completed/ended it becomes an atomic, undoable operation.

Arguments

Result

void cancelDelta()

Cancel a 'delta' (a set of scene modifications/edits) previously started via the start_delta() method, reverting the Scene back to the state it was in before start_delta().

Arguments

Result

void endDelta()

End a 'delta' (a set of scene modifications/edits) previously started via the start_delta() method.

Arguments

Result

Long isReadOnly()

Has this scene interface been opened 'read only'. Interfaces opened read only cannot modify their scene using the standard start_delta, make changes, end_delta paradigm. At any given time, multiple interfaces may reference/open the same scene in read only mode. However, at most only a single interface may reference a scene in read/write mode

Arguments

Result

Long isReadOnlyForHost()

Is the scene opened 'read only' for the host application. Note: This will be false if any interface has opened the scene in read/write mode (or the host has explicitly opened the scene read/write itself)

Arguments

Result

FormatSet getFormats()

Return FormatSet for formats defined within this Scene

Arguments

Result

SceneSettings getSceneSettings()

Return SceneSettings object for this Scene

Arguments

Result

CategoryInfo getCategory(String key)

Return category definition

Arguments

Result

void setCategory(String name, ArrayList<Double> colour)

Overwrites an existing category in the scene, or adds a new category if a category of that name doesn't exist. Will fail if an attempt is made to overwrite an built-in, read-only category.

Arguments

Result

ArrayList<String> getMarkCategories()

Return array of mark category keys

Arguments

Result

ArrayList<String> getStripCategories()

Return array of strip category keys

Arguments

Result

Long getStartFrame()

Get frame number of start of first shot in scene

Arguments

Result

Long getEndFrame()

Get frame number of end of last shot in scene

Arguments

Result

Double getWorkingFrameRate()

Get the working frame rate of the current scene (in FPS)

Arguments

Result

Timecode getRecordTimecodeForFrame(Long frame_num)

Get record timecode for a given (timeline) frame number

Arguments

Result

ShotIndexRange getShotIndexRange(Double startFrame, Double endFrame)

Get index range of shots intersecting the (end exclusive) timeline frame range supplied

Arguments

Result

Long getNumShots()

Get number of Shots within scene

Arguments

Result

Long getShotIdAt(Long frame)

Return the ID of the shot at the timeline frame number supplied

Arguments

Result

Long getShotId(Long index)

Return the ID for the shot at the given index within the Scene

Arguments

Result

ArrayList<ShotInfo> getShotIds(Long firstIndex, Long lastIndex)

Get an array of shots in the supplied indexed range. Each array entry is an object containing basic information for that shot. Explicitly, each shot entry will contain the following keys:

Returns new array shot list on success, NULL on error.

Arguments

Result

Shot getShot(Long shot_id)

Create a new Shot object for the given shot ID

Arguments

Result

void deleteShot(Long shot_id, Long cleanup, Long closeGap)

Delete the given shot and its associated layers from the Scene

Arguments

Result

Shot insertBars(String barType, Double duration, String where, Shot relativeTo, String barsColourSpace, String stackColourSpace)

Insert a Bars strip into the Scene

Arguments

Result

Shot insertBlank(Double red, Double green, Double blue, Double duration, String where, Shot relativeTo, String colourSpace)

Insert a Blank strip into the Scene

Arguments

Result

Shot insertSequence(SequenceDescriptor sequence, String where, Shot relativeTo, String colourSpace, String format, Double frameRate)

Insert an image/movie sequence into the Scene

Arguments

Result

Shot insertText(String text, Double duration, String where, Shot relativeTo, String alignment)

Insert a Text strip into the Scene

Arguments

Result

Long getNumMarks(String type)

Return number of Timeline Marks in Scene

Arguments

Result

ArrayList<Long> getMarkIds(Long offset, Long count, String type)

Return array of mark ids

Arguments

Result

ArrayList<Long> getMarkIdsInRange(Long startF, Long endF, String type)

Return array of mark ids within the given frame range in the Scene

Arguments

Result

Mark getMark(Long id)

Return Mark object for the given mark ID

Arguments

Result

Long addMark(Long frame, String category, String note)

Add new Mark to the Scene at the given frame number

Arguments

Result

void deleteMark(Long id)

Remove Mark object with the given ID

Arguments

Result

ArrayList<MetadataItem> getMetadataDefinitions()

Return array of metadata item definitions

Arguments

Result

MetadataItem addMetadataDefn(String name, String type)

Add a new Metadata Item field to the Scene

Arguments

Result

void deleteMetadataDefn(String key)

Delete a Metadata Item field from the Scene

Arguments

Result

ArrayList<MetadataProperty> getMetadataPropertyTypes()

Return list of properties that can be defined for each MetadataItem

Arguments

Result

String getMetadataDefnProperty(String key, String property)

Set the value for the given property for the given metadata item key

Arguments

Result

void setMetadataDefnProperty(String key, String property, String value)

Set the value for the given property for the given metadata item key

Arguments

Result

ArrayList<String> getLookNames()

Return names of available Looks

Arguments

Result

ArrayList<LookInfo> getLookInfos()

Get an array of available Looks. Each array entry is a LookInfo object containing the Name and Group for each Look. Explicitly, each entry will contain the following keys:

Returns new array of LookInfo objects on success, NULL on error.

Arguments

Result

void setTransientWriteLockDeltas(Long enable) BETA

Use to enable (or disable) creation of deltas in a scene where FLAPI does not have the write lock. In particular, this is needed for FLAPI scripts running inside the main application that wish to modify the current scene.

When you open such a delta, you are preventing anything else from being able to make normal scene modifications. You should therefore ensure you hold it open for as short a time as possible. Note also that you should not disable transient deltas while a transient delta is in progress.

Arguments

Result

void stereoCombineShots(ArrayList<Shot> shots)

Takes a list of shots to combine into stereo stacks, the shots should have an opposite eye above it. The scene must be a stereo scene and a delta should be started before the call.

Arguments

Result

void setCustomData(String data_key, Object data_value)

Set a custom data value in the scene with the supplied (string) key. Setting a custom data value does not require a delta. Also custom data values are unaffected by undo/redo. Existing custom data values can be deleted from a scene by supplying NULL/None/null as the data value (for an existing key).

Arguments

Result

Object getCustomData(String data_key)

Get a custom data value from the scene previously set using set_custom_data.

Arguments

Result

ArrayList<String> getCustomDataKeys()

Return sorted array of (string) keys that can be used to fetch scene custom data values via get_custom_data.

Arguments

Result

CompletableFuture<ScenePath> parsePathAsync(String str)

Convert the given string into a ScenePath object contaning Host, Job, Scene components, or raise an error if the path is invalid

Arguments

Result

CompletableFuture<String> pathToStringAsync(ScenePath scenepath)

Convert the given ScenePath object into a string

Arguments

Result

CompletableFuture<Scene> createAsync()

Create an empty Scene object, which can then be used to create a temporary scene, a new scene, or load an existing scene. After creating an empty Scene object, you must call ::temporary_scene_nonblock::, ::new_scene_nonblock:: or ::open_scene_nonblock::.

Arguments

Result

CompletableFuture<Scene> newSceneAsync(ScenePath scenepath, NewSceneOptions options)

Create a new scene stored in a database. This function will block until the new scene has been created in the database. If the new scene cannot be created, this function will raise an exception containing an error message.

Arguments

Result

CompletableFuture<Scene> openSceneAsync(ScenePath scenepath, Set<String> flags)

Open a scene. This function will block until the scene has been opened. If the scene cannot be opened, this function will raise an exception containing an error message.

Arguments

Result

CompletableFuture<Scene> temporarySceneAsync(NewSceneOptions options)

Create a temporary scene that is not stored in a database. This function will block until the temporary scene has been created. If the temporary scene cannot be created, this function will raise an exception containing an error message.

Arguments

Result

CompletableFuture<void> newSceneNonblockAsync(ScenePath scenepath, NewSceneOptions options)

Create a new scene

Arguments

Result

CompletableFuture<void> openSceneNonblockAsync(ScenePath scenepath, Set<String> flags)

Open a scene

Arguments

Result

CompletableFuture<void> temporarySceneNonblockAsync(NewSceneOptions options)

Create a temporary scene that is not stored in a database

Arguments

Result

CompletableFuture<void> saveSceneAsync()

Save changes to scene into database

Arguments

Result

CompletableFuture<OpenSceneStatus> getOpenStatusAsync()

Fetch status of scene open operation

Arguments

Result

CompletableFuture<OpenSceneStatus> waitUntilOpenAsync()

Wait for any scene opening/creation operations to complete, and return the status

Arguments

Result

CompletableFuture<Long> closeSceneAsync()

Close scene

Arguments

Result

CompletableFuture<String> getScenePathnameAsync()

Get current scene's 'pathname' string (typically 'host:job:scene')

Arguments

Result

CompletableFuture<String> getSceneContainerAsync()

Get the current container for the scene

Arguments

Result

CompletableFuture<void> setSceneContainerAsync(String container)

Set the current container for the scene

Arguments

Result

CompletableFuture<void> startDeltaAsync(String name)

Start a 'delta' on a scene that has been opened read/write. A delta is a set of modifcations/edits on a scene that together constitute a single, logical operation/transaction. Each start_delta call must have a matching end_delta call (with one or more editing operations in between). Every delta has a user visible name (eg. 'Change Film Grade Exposure'). Once a delta has been completed/ended it becomes an atomic, undoable operation.

Arguments

Result

CompletableFuture<void> cancelDeltaAsync()

Cancel a 'delta' (a set of scene modifications/edits) previously started via the start_delta() method, reverting the Scene back to the state it was in before start_delta().

Arguments

Result

CompletableFuture<void> endDeltaAsync()

End a 'delta' (a set of scene modifications/edits) previously started via the start_delta() method.

Arguments

Result

CompletableFuture<Long> isReadOnlyAsync()

Has this scene interface been opened 'read only'. Interfaces opened read only cannot modify their scene using the standard start_delta, make changes, end_delta paradigm. At any given time, multiple interfaces may reference/open the same scene in read only mode. However, at most only a single interface may reference a scene in read/write mode

Arguments

Result

CompletableFuture<Long> isReadOnlyForHostAsync()

Is the scene opened 'read only' for the host application. Note: This will be false if any interface has opened the scene in read/write mode (or the host has explicitly opened the scene read/write itself)

Arguments

Result

CompletableFuture<FormatSet> getFormatsAsync()

Return FormatSet for formats defined within this Scene

Arguments

Result

CompletableFuture<SceneSettings> getSceneSettingsAsync()

Return SceneSettings object for this Scene

Arguments

Result

CompletableFuture<CategoryInfo> getCategoryAsync(String key)

Return category definition

Arguments

Result

CompletableFuture<void> setCategoryAsync(String name, ArrayList<Double> colour)

Overwrites an existing category in the scene, or adds a new category if a category of that name doesn't exist. Will fail if an attempt is made to overwrite an built-in, read-only category.

Arguments

Result

CompletableFuture<ArrayList<String>> getMarkCategoriesAsync()

Return array of mark category keys

Arguments

Result

CompletableFuture<ArrayList<String>> getStripCategoriesAsync()

Return array of strip category keys

Arguments

Result

CompletableFuture<Long> getStartFrameAsync()

Get frame number of start of first shot in scene

Arguments

Result

CompletableFuture<Long> getEndFrameAsync()

Get frame number of end of last shot in scene

Arguments

Result

CompletableFuture<Double> getWorkingFrameRateAsync()

Get the working frame rate of the current scene (in FPS)

Arguments

Result

CompletableFuture<Timecode> getRecordTimecodeForFrameAsync(Long frame_num)

Get record timecode for a given (timeline) frame number

Arguments

Result

CompletableFuture<ShotIndexRange> getShotIndexRangeAsync(Double startFrame, Double endFrame)

Get index range of shots intersecting the (end exclusive) timeline frame range supplied

Arguments

Result

CompletableFuture<Long> getNumShotsAsync()

Get number of Shots within scene

Arguments

Result

CompletableFuture<Long> getShotIdAtAsync(Long frame)

Return the ID of the shot at the timeline frame number supplied

Arguments

Result

CompletableFuture<Long> getShotIdAsync(Long index)

Return the ID for the shot at the given index within the Scene

Arguments

Result

CompletableFuture<ArrayList<ShotInfo>> getShotIdsAsync(Long firstIndex, Long lastIndex)

Get an array of shots in the supplied indexed range. Each array entry is an object containing basic information for that shot. Explicitly, each shot entry will contain the following keys:

Returns new array shot list on success, NULL on error.

Arguments

Result

CompletableFuture<Shot> getShotAsync(Long shot_id)

Create a new Shot object for the given shot ID

Arguments

Result

CompletableFuture<void> deleteShotAsync(Long shot_id, Long cleanup, Long closeGap)

Delete the given shot and its associated layers from the Scene

Arguments

Result

CompletableFuture<Shot> insertBarsAsync(String barType, Double duration, String where, Shot relativeTo, String barsColourSpace, String stackColourSpace)

Insert a Bars strip into the Scene

Arguments

Result

CompletableFuture<Shot> insertBlankAsync(Double red, Double green, Double blue, Double duration, String where, Shot relativeTo, String colourSpace)

Insert a Blank strip into the Scene

Arguments

Result

CompletableFuture<Shot> insertSequenceAsync(SequenceDescriptor sequence, String where, Shot relativeTo, String colourSpace, String format, Double frameRate)

Insert an image/movie sequence into the Scene

Arguments

Result

CompletableFuture<Shot> insertTextAsync(String text, Double duration, String where, Shot relativeTo, String alignment)

Insert a Text strip into the Scene

Arguments

Result

CompletableFuture<Long> getNumMarksAsync(String type)

Return number of Timeline Marks in Scene

Arguments

Result

CompletableFuture<ArrayList<Long>> getMarkIdsAsync(Long offset, Long count, String type)

Return array of mark ids

Arguments

Result

CompletableFuture<ArrayList<Long>> getMarkIdsInRangeAsync(Long startF, Long endF, String type)

Return array of mark ids within the given frame range in the Scene

Arguments

Result

CompletableFuture<Mark> getMarkAsync(Long id)

Return Mark object for the given mark ID

Arguments

Result

CompletableFuture<Long> addMarkAsync(Long frame, String category, String note)

Add new Mark to the Scene at the given frame number

Arguments

Result

CompletableFuture<void> deleteMarkAsync(Long id)

Remove Mark object with the given ID

Arguments

Result

CompletableFuture<ArrayList<MetadataItem>> getMetadataDefinitionsAsync()

Return array of metadata item definitions

Arguments

Result

CompletableFuture<MetadataItem> addMetadataDefnAsync(String name, String type)

Add a new Metadata Item field to the Scene

Arguments

Result

CompletableFuture<void> deleteMetadataDefnAsync(String key)

Delete a Metadata Item field from the Scene

Arguments

Result

CompletableFuture<ArrayList<MetadataProperty>> getMetadataPropertyTypesAsync()

Return list of properties that can be defined for each MetadataItem

Arguments

Result

CompletableFuture<String> getMetadataDefnPropertyAsync(String key, String property)

Set the value for the given property for the given metadata item key

Arguments

Result

CompletableFuture<void> setMetadataDefnPropertyAsync(String key, String property, String value)

Set the value for the given property for the given metadata item key

Arguments

Result

CompletableFuture<ArrayList<String>> getLookNamesAsync()

Return names of available Looks

Arguments

Result

CompletableFuture<ArrayList<LookInfo>> getLookInfosAsync()

Get an array of available Looks. Each array entry is a LookInfo object containing the Name and Group for each Look. Explicitly, each entry will contain the following keys:

Returns new array of LookInfo objects on success, NULL on error.

Arguments

Result

CompletableFuture<void> setTransientWriteLockDeltasAsync(Long enable) BETA

Use to enable (or disable) creation of deltas in a scene where FLAPI does not have the write lock. In particular, this is needed for FLAPI scripts running inside the main application that wish to modify the current scene.

When you open such a delta, you are preventing anything else from being able to make normal scene modifications. You should therefore ensure you hold it open for as short a time as possible. Note also that you should not disable transient deltas while a transient delta is in progress.

Arguments

Result

CompletableFuture<void> stereoCombineShotsAsync(ArrayList<Shot> shots)

Takes a list of shots to combine into stereo stacks, the shots should have an opposite eye above it. The scene must be a stereo scene and a delta should be started before the call.

Arguments

Result

CompletableFuture<void> setCustomDataAsync(String data_key, Object data_value)

Set a custom data value in the scene with the supplied (string) key. Setting a custom data value does not require a delta. Also custom data values are unaffected by undo/redo. Existing custom data values can be deleted from a scene by supplying NULL/None/null as the data value (for an existing key).

Arguments

Result

CompletableFuture<Object> getCustomDataAsync(String data_key)

Get a custom data value from the scene previously set using set_custom_data.

Arguments

Result

CompletableFuture<ArrayList<String>> getCustomDataKeysAsync()

Return sorted array of (string) keys that can be used to fetch scene custom data values via get_custom_data.

Arguments

Result

SceneSettings

This class provides an interface to get/set scene settings, which affect all Shots in a Scene.

Signals

Properties

These properties names can be used as keys with the get() and set() methods to read or modify scene settings.


Methods

Async Methods

ArrayList<String> getSettingKeys()

Return array of keys that can be used to get/set Scene Settings parameters

Arguments

Result

SceneSettingDefinition getSettingDefinition(String key)

Return SceneSettings parameter type definition for the given key

Arguments

Result

HashMap<String,Object> get(ArrayList<String> keys)

Return values for given SceneSettings keys

Arguments

Result

Object getSingle(String key)

Return value for given SceneSettings key

Arguments

Result

void set(HashMap<String,Object> values)

Set values for the given SceneSettings keys

Arguments

Result

void setSingle(String key, Object value)

Set value for the given SceneSettings key

Arguments

Result

CompletableFuture<ArrayList<String>> getSettingKeysAsync()

Return array of keys that can be used to get/set Scene Settings parameters

Arguments

Result

CompletableFuture<SceneSettingDefinition> getSettingDefinitionAsync(String key)

Return SceneSettings parameter type definition for the given key

Arguments

Result

CompletableFuture<HashMap<String,Object>> getAsync(ArrayList<String> keys)

Return values for given SceneSettings keys

Arguments

Result

CompletableFuture<Object> getSingleAsync(String key)

Return value for given SceneSettings key

Arguments

Result

CompletableFuture<void> setAsync(HashMap<String,Object> values)

Set values for the given SceneSettings keys

Arguments

Result

CompletableFuture<void> setSingleAsync(String key, Object value)

Set value for the given SceneSettings key

Arguments

Result

SequenceDescriptor

A SequenceDescriptor represents a movie file (e.g. /vol/bl000-images/myjob/media/A001_C001_00000A_001.R3D) or a sequence of image files (e.g. /vol/bl000-images/myjob/renders/day1_%.7F.exr) on disk. It has a frame range (which does not have to cover the full length of the media on disk) and associated metadata. Audio-only media (e.g. OpAtom MXF audio, or .wav files) is also described using a SequenceDescriptor.

Signals

Methods

Async Methods

ArrayList<SequenceDescriptor> getForTemplate(String template, Long start, Long end)

Search the filesystem and return zero or more SequenceDescriptors which match the given filename template (e.g. "/vol/images/A001B002.mov" or "/vol/san/folder/%.6F.dpx", and optionally intersecting the given start and end frame numbers.

Arguments

Result

ArrayList<SequenceDescriptor> getForTemplateWithTimecode(String template, Timecode startTC, Timecode endTC)

Search the filesystem and return zero or more SequenceDescriptors which match the given filename template (e.g. "/vol/images/A001B002.mov" or "/vol/san/folder/%.6F.dpx", and optionally intersecting the given start and end timecodes.

Arguments

Result

SequenceDescriptor getForFile(String filepath)

Create a SequenceDescriptor for a single file

Arguments

Result

Long getStartFrame()

Return the first frame number, which does not necessarily correspond with the first frame of the files on disk.

Arguments

Result

Long getEndFrame()

Return the last frame number, which does not necessarily correspond with the last frame of the files on disk.

Arguments

Result

Timecode getStartTimecode(Long index)

Return the timecode at the first frame of the sequence. Some media can support two timecode tracks, so you must specify which one you want (0 or 1).

Arguments

Result

Timecode getEndTimecode(Long index)

Return the timecode at the last frame of the sequence. Some media can support two timecode tracks, so you must specify which one you want (0 or 1).

Arguments

Result

Keycode getStartKeycode()

Return the keycode at the first frame of the sequence.

Arguments

Result

Keycode getEndKeycode()

Return the keycode at the last frame of the sequence.

Arguments

Result

Long getStartHandle()

Return the first frame number on disk (0 for movie files).

Arguments

Result

Long getEndHandle()

Return the last frame number on disk (inclusive).

Arguments

Result

Long getWidth()

Return the width (in pixels) of the images in this sequence. Returns 0 for audio-only media.

Arguments

Result

Long getHeight()

Return the height (in pixels) of the images in this sequence. Returns 0 for audio-only media.

Arguments

Result

Double getPixelAspectRatio()

Return the pixel aspect ratio (width/height) of the images in this sequence. Returns 1.0 if unknown.

Arguments

Result

String getPath()

Return the path to the folder containing this sequence.

Arguments

Result

String getName()

Return the filename (for a movie) or the filename template (for an image sequence, using FilmLight %.#F syntax for frame numbering), excluding the folder path.

Arguments

Result

String getExt()

Return the filename extension (including the leading '.') for this sequence.

Arguments

Result

String getPrefix()

Return filename prefix before numeric component

Arguments

Result

String getPostfix()

Return filename postfix after numeric component

Arguments

Result

Long getFormatLen()

Return number of digits in numerical component of filename

Arguments

Result

String getBaseFilenameWithF()

Return filename (without path) using FilmLight %.#F syntax for the frame number pattern

Arguments

Result

String getBaseFilenameWithD()

Return filename (without path) using printf %0#d syntax for the frame number pattern

Arguments

Result

String getFullFilenameWithF()

Return filename (with path) using FilmLight %.#F syntax for the frame number pattern

Arguments

Result

String getFullFilenameWithD()

Return filename (with path) using printf %0#d syntax for the frame number pattern

Arguments

Result

String getBaseFilename(Long frame)

Return filename (without path) for the given frame number

Arguments

Result

String getFilenameForFrame(Long frame)

Return filename (with path) for the given frame number

Arguments

Result

ArrayList<String> getChannels()

Get channel names. Intended for OpenEXR media only; other media will return an empty array.

Arguments

Result

String getTape(Long index)

Return the tape name. Some media can support two tracks, so you must specify which one you want (0 or 1).

Arguments

Result

HashMap<String,Object> getMetadata()

Return the metadata read when the sequence was scanned on disk, in human-readable form.

Arguments

Result

Long isMovie()

Return whether sequence is a movie file

Arguments

Result

Double getMovieFps()

Return the frame rate of a movie file

Arguments

Result

Long hasBlg()

Return whether sequence has BLG (Baselight Linked Grade) information

Arguments

Result

Long isBlg()

Return whether sequence is a BLG (Baselight Linked Grade)

Arguments

Result

Long hasAudio()

Return whether movie file has audio

Arguments

Result

Long getAudioChannels()

Return number of audio channels in movie

Arguments

Result

Long getAudioSampleRate()

Return audio sample rate (in Hz)

Arguments

Result

Long getAudioLengthInSamples()

Return total number of audio samples in file

Arguments

Result

void trimMovie(String output, Long start, Long length)

Create (if possible) a trimmed copy of the movie specified by this descriptor

Arguments

Result

CompletableFuture<ArrayList<SequenceDescriptor>> getForTemplateAsync(String template, Long start, Long end)

Search the filesystem and return zero or more SequenceDescriptors which match the given filename template (e.g. "/vol/images/A001B002.mov" or "/vol/san/folder/%.6F.dpx", and optionally intersecting the given start and end frame numbers.

Arguments

Result

CompletableFuture<ArrayList<SequenceDescriptor>> getForTemplateWithTimecodeAsync(String template, Timecode startTC, Timecode endTC)

Search the filesystem and return zero or more SequenceDescriptors which match the given filename template (e.g. "/vol/images/A001B002.mov" or "/vol/san/folder/%.6F.dpx", and optionally intersecting the given start and end timecodes.

Arguments

Result

CompletableFuture<SequenceDescriptor> getForFileAsync(String filepath)

Create a SequenceDescriptor for a single file

Arguments

Result

CompletableFuture<Long> getStartFrameAsync()

Return the first frame number, which does not necessarily correspond with the first frame of the files on disk.

Arguments

Result

CompletableFuture<Long> getEndFrameAsync()

Return the last frame number, which does not necessarily correspond with the last frame of the files on disk.

Arguments

Result

CompletableFuture<Timecode> getStartTimecodeAsync(Long index)

Return the timecode at the first frame of the sequence. Some media can support two timecode tracks, so you must specify which one you want (0 or 1).

Arguments

Result

CompletableFuture<Timecode> getEndTimecodeAsync(Long index)

Return the timecode at the last frame of the sequence. Some media can support two timecode tracks, so you must specify which one you want (0 or 1).

Arguments

Result

CompletableFuture<Keycode> getStartKeycodeAsync()

Return the keycode at the first frame of the sequence.

Arguments

Result

CompletableFuture<Keycode> getEndKeycodeAsync()

Return the keycode at the last frame of the sequence.

Arguments

Result

CompletableFuture<Long> getStartHandleAsync()

Return the first frame number on disk (0 for movie files).

Arguments

Result

CompletableFuture<Long> getEndHandleAsync()

Return the last frame number on disk (inclusive).

Arguments

Result

CompletableFuture<Long> getWidthAsync()

Return the width (in pixels) of the images in this sequence. Returns 0 for audio-only media.

Arguments

Result

CompletableFuture<Long> getHeightAsync()

Return the height (in pixels) of the images in this sequence. Returns 0 for audio-only media.

Arguments

Result

CompletableFuture<Double> getPixelAspectRatioAsync()

Return the pixel aspect ratio (width/height) of the images in this sequence. Returns 1.0 if unknown.

Arguments

Result

CompletableFuture<String> getPathAsync()

Return the path to the folder containing this sequence.

Arguments

Result

CompletableFuture<String> getNameAsync()

Return the filename (for a movie) or the filename template (for an image sequence, using FilmLight %.#F syntax for frame numbering), excluding the folder path.

Arguments

Result

CompletableFuture<String> getExtAsync()

Return the filename extension (including the leading '.') for this sequence.

Arguments

Result

CompletableFuture<String> getPrefixAsync()

Return filename prefix before numeric component

Arguments

Result

CompletableFuture<String> getPostfixAsync()

Return filename postfix after numeric component

Arguments

Result

CompletableFuture<Long> getFormatLenAsync()

Return number of digits in numerical component of filename

Arguments

Result

CompletableFuture<String> getBaseFilenameWithFAsync()

Return filename (without path) using FilmLight %.#F syntax for the frame number pattern

Arguments

Result

CompletableFuture<String> getBaseFilenameWithDAsync()

Return filename (without path) using printf %0#d syntax for the frame number pattern

Arguments

Result

CompletableFuture<String> getFullFilenameWithFAsync()

Return filename (with path) using FilmLight %.#F syntax for the frame number pattern

Arguments

Result

CompletableFuture<String> getFullFilenameWithDAsync()

Return filename (with path) using printf %0#d syntax for the frame number pattern

Arguments

Result

CompletableFuture<String> getBaseFilenameAsync(Long frame)

Return filename (without path) for the given frame number

Arguments

Result

CompletableFuture<String> getFilenameForFrameAsync(Long frame)

Return filename (with path) for the given frame number

Arguments

Result

CompletableFuture<ArrayList<String>> getChannelsAsync()

Get channel names. Intended for OpenEXR media only; other media will return an empty array.

Arguments

Result

CompletableFuture<String> getTapeAsync(Long index)

Return the tape name. Some media can support two tracks, so you must specify which one you want (0 or 1).

Arguments

Result

CompletableFuture<HashMap<String,Object>> getMetadataAsync()

Return the metadata read when the sequence was scanned on disk, in human-readable form.

Arguments

Result

CompletableFuture<Long> isMovieAsync()

Return whether sequence is a movie file

Arguments

Result

CompletableFuture<Double> getMovieFpsAsync()

Return the frame rate of a movie file

Arguments

Result

CompletableFuture<Long> hasBlgAsync()

Return whether sequence has BLG (Baselight Linked Grade) information

Arguments

Result

CompletableFuture<Long> isBlgAsync()

Return whether sequence is a BLG (Baselight Linked Grade)

Arguments

Result

CompletableFuture<Long> hasAudioAsync()

Return whether movie file has audio

Arguments

Result

CompletableFuture<Long> getAudioChannelsAsync()

Return number of audio channels in movie

Arguments

Result

CompletableFuture<Long> getAudioSampleRateAsync()

Return audio sample rate (in Hz)

Arguments

Result

CompletableFuture<Long> getAudioLengthInSamplesAsync()

Return total number of audio samples in file

Arguments

Result

void trimMovieAsync(String output, Long start, Long length)

Create (if possible) a trimmed copy of the movie specified by this descriptor

Arguments

Result

Shot

A shot in Baselight is a set of strips comprising a top strip (typically containing a Sequence operator referencing input media) and the strips lying directly underneath it. These strips apply image-processing and other operations to the top strip.

Signals

Methods

Async Methods

Long isValid()

Called to determine if the shot object references a valid top strip an open scene. A shot object may become invalid in a couple of ways:

Arguments

Result

Scene getScene()

Get the scene object which this shot is a part of.

Arguments

Result

Long getId()

Get the shot's identifier, an integer which uniquely identifies the shot within the timeline. The id is persistent, remaining constant even if the scene containing the shot is closed and reopened.

Arguments

Result

Double getStartFrame()

Get the start frame of the shot within the scene which contains it. Because the time extent of a shot is actually defined by the shot's top strip, the start frame is actually the start frame of the top strip.

Arguments

Result

Double getEndFrame()

Get the end frame of the shot within the scene which contains it. Because the time extent of a shot is defined by the shot's top strip, the end frame is actually the end frame of the top strip. In Baselight, shot extents are defined in floating-point frames and are start-inclusive and end-exclusive. This means that the shot goes all the way up to the beginning of the end frame, but doesn't include it.

So a 5-frame shot starting at frame 100.0 would have an end frame 105.0 and 104.75, 104.9 and 104.99999 would all lie within the shot.

Arguments

Result

Double getPosterFrame()

Get the poster frame of the shot within the scene that contains it.

Arguments

Result

Timecode getStartTimecode()

Get the start record timecode of the shot

Arguments

Result

Timecode getEndTimecode()

Get the end record timecode of the shot

Arguments

Result

Timecode getTimecodeAtFrame(Long frame)

Get the record timecode at the given frame within the shot

Arguments

Result

Long getSrcStartFrame()

Return start frame number within source sequence/movie

Arguments

Result

Long getSrcEndFrame()

Return end frame number within source sequence/movie (exclusive)

Arguments

Result

Timecode getSrcStartTimecode()

Return start timecode within source sequence/movie

Arguments

Result

Timecode getSrcEndTimecode()

Return end timecode within source sequence/movie (exclusive)

Arguments

Result

Timecode getSrcTimecodeAtFrame(Long frame)

Return source timecode at the given frame within the shot

Arguments

Result

Keycode getSrcStartKeycode()

Return start keycode within source sequence/movie

Arguments

Result

Keycode getSrcEndKeycode()

Return end keycode within source sequence/movie (exclusive)

Arguments

Result

String getInputColourSpace(String eye)

Return the input colour space defined for this shot. Can be 'None', indicating no specific colour space defined. For RAW codecs, this may be 'Auto' indicating that the input colour space will be determined by the SDK used to decode to the image data. In either case the actual input colour space can be determined by call get_actual_input_colour_space().

Arguments

Result

void setInputColourSpace(String name, String eye)

Set the input colour space

Arguments

Result

Long inputColourSpaceDerivedFromMedia(String eye)

Return whether or not the shot's input colour space was derived from the media file's inate properties or metadata. If 1 is returned, this indicates a high degree of confidence that the shot's colour space journey is correct.

Arguments

Result

String acesIdtForInputColourSpace(String eye, String aces_version)

Returns the name of the ACES IDT transform which is equivalent to the current input colour space. This IDT transform converts to ACES AP0

Arguments

Result

void setStackColourSpace(String name, String eye)

Set the stack colour space

Arguments

Result

String getActualInputColourSpace(String eye)

Return the input colour space for this shot. If the input colour space is set to 'Auto', the actual colour space name will be returned.

Arguments

Result

String getInputFormat(String eye)

Return the input format name for this shot

Arguments

Result

void setInputFormat(String name, String eye)

Set the input format name for this shot

Arguments

Result

String getInputVideoLut(String eye)

Return the input video lut value for this shot

Arguments

Result

void setInputVideoLut(String video_lut, String eye)

Set the input video LUT for this shot

Arguments

Result

String getInputOrientation(String eye)

Return the orientation transform for the input sequence

Arguments

Result

void setInputOrientation(String orientation, String eye)

Set the orientation transform for the input sequence

Arguments

Result

Double getFrameRate()

Return the frame rate of the Sequence for this shot

Arguments

Result

HashMap<String,Object> getMetadata(Set<Object> md_keys)

Get metadata values for the keys provided. The possible keys and the value type for each key are obtained using the Scene.get_metadata_definitions method.

Arguments

Result

HashMap<String,Object> getMetadataStrings(Set<Object> md_keys)

Get metadata values expressed as strings for the keys provided. The possible keys are obtained using the Scene.get_metadata_definitions method.

Arguments

Result

void setMetadata(HashMap<String,Object> metadata)

Set metadata values for the keys provided. The possible keys and the value type for each key are obtained using the Scene.get_metadata_definitions method.

Arguments

Result

SequenceDescriptor getSequenceDescriptor()

Get a SequenceDescriptor object that represents the input media for this shot.

Arguments

Result

Long supportsClientEventData()

Does this shot support client event lists/data.

Arguments

Result

ArrayList<HashMap<String,Object>> getClientEventList(Long list_frame)

Get array of client events (notes/flags) for either an entire shot, or a specific frame of a shot. When querying the event list at a specific frame, NULL/None/null will be returned if no event list exists at that frame or the shot. The events array returned will be chronologically sorted (oldest first). Each event entry is itself a dictionary describing that event.

Arguments

Result

Long addClientNote(String client_name, String note_text, Long event_list_frame)

Add a client note to either the client event list for an entire shot, or to the client event list at a specific frame number.

Arguments

Result

Long addClientFlag(String client_name, Long event_list_frame)

Add a new client flag entry to either the client event list for an entire shot, or to the client event list at a specific frame number. A client event list only supports a single flag event for a given client name; If one already exists, a call to this method will replace it with a new one.

Arguments

Result

Long deleteClientEvent(String event_id)

Delete the (note or flag) event with the supplied id from the shot's client event list.

Arguments

Result

void setClientEventMetadata(Long client_event_id, HashMap<String,Object> metadata)

Set custom metadata key/value pairs for the client event with the supplied ID.

Arguments

Result

HashMap<String,Object> getClientEventMetadata(Long client_event_id, Set<Object> md_keys)

Get custom metadata key/value pairs for the client event with the supplied ID.

Arguments

Result

void deleteClientEventMetadata(Long client_event_id, Object metadata_key)

Delete a single metadata key/value item from the client event with the supplied ID.

Arguments

Result

ArrayList<Long> getClientEventListFrames()

Get array of (shot start relative) frame numbers of frames with client event lists

Arguments

Result

void deleteFrameClientEventList(Long list_frame)

Delete the entire client event list at the given shot frame (if any).

Arguments

Result

HashMap<String,Object> getClientDataSummary()

Get summary info on any client data associated with this shot.

Arguments

Result

Long getNumMarks(String type)

Get number of marks within shot. If type is supplied, only return number of marks of the given type

Arguments

Result

ArrayList<Long> getMarkIds(Long offset, Long count, String type, String eye)

Get shot mark ids within the shot. Shot marks are marks which are attached to the shot's top strip. If type is specified, only return marks of matching type.

Arguments

Result

Mark getMark(Long id)

Get Mark object for given ID

Arguments

Result

Long addMark(Long frame, String category, String note, String eye)

Add new Mark to the shot at the given source frame

Arguments

Result

void deleteMark(Long id, String eye)

Delete the Mark object with the given mark ID

Arguments

Result

Set<String> getCategories()

Get the set of categories assigned to this shot.

Arguments

Result

void setCategories(Set<String> categories)

Set the categories assigned to this shot

Arguments

Result

void insertBlgStack(String blg_path)

Insert a BLG stack at the bottom of the shot.

Arguments

Result

String getBlgPayload()

Returns the BLG payload for this shot.

Arguments

Result

void applyBlgPayload(String blg_payload, String blg_resources)

Insert a BLG stack at the bottom of the shot.

Arguments

Result

String getBlgResources()

Returns the BLG resources for this shot.

Arguments

Result

String getAmfOutputColourSpace(String amf_path)

Static utility method used to obtain the equivalent Truelight Colour Space name for the aces:outputTransform of the AMF.

Arguments

Result

String insertAmfStack(String amf_path, AMFInsertSettings settings)

Insert a AMF stack at the bottom of the shot.

Arguments

Result

String setInputFormatFromFdl(FDL fdl_obj, ShotSetInputFormatFromFDLOptions options, String eye)

Apply an ASC Framing Decision List (FDL) to specify the input format for this Shot. If no context, canvas or framing decision IDs are specified, the first FDL Canvas which matches the sequence resolution will be used.

If no matching canvas is found, this method will return NULL.

If an existing format is found that matches the FDL Canvas, that format will be used.

Arguments

Result

String createFormatFromFdlCanvasTemplate(FDL fdl_obj, String canvas_template_id, String format_name, String context_name, String canvas_name, String eye)

Apply an ASC Framing Decision List (FDL) Canvas Template to create a new format. This format can be used to create a deliverable from the input format.

Arguments

Result

FDL getFdl(String output_format_name, String eye)

Get the FDL representing the framing decisions in this shot

Arguments

Result

void insertBasegradeLayer(HashMap<String,Object> values)

Insert a BaseGrade layer at the bottom of the stack.

Arguments

Result

void insertCdlLayer(ArrayList<Double> cdl_values)

Insert a CDLGrade layer at the bottom of the shot.

Arguments

Result

void insertCdlLayerAbove(ArrayList<Double> cdl_values)

Insert a CDLGrade layer at the top of the shot.

Arguments

Result

void insertLookLayer(String look_name)

Insert a Look kayer at the bottom of the shot.

Arguments

Result

void insertTruelightLayer(String lut_path)

Insert a Truelight layer at the bottom of the shot. The Truelight operator is used for applying 1D and 3D LUTs to an image.

Arguments

Result

void insertShapeLayerFromSvg(String svg_path, String fit_mode, String mask_format, String mask_name)

Insert a layer with a shape strip populated from an SVG file at the bottom of the shot.

Arguments

Result

void insertColourSpaceLayer(String toColourSpace, String drt, Long identify)

Insert a ColourSpace operator at the bottom of the stack for this shot

Arguments

Result

void insertLutLayer(String location, String file, String inputColourSpace, String outputColourSpace, Long inputLegalRange, Long outputLegalRange, Long tetrahedral)

Insert a LUT operator at the bottom of the stack for this shot

Arguments

Result

void deleteAllLayers()

Remove all layers from the shot.

Arguments

Result

String getCodec()

Method to obtain the codec of the input media of the shot.

Arguments

Result

ArrayList<String> getDecodeParameterTypes()

Return list of supported decode parameter codec keys

Arguments

Result

String getDecodeParameterTypeForCodec(String codec)

Return the key identifying the decode parameters type to use for the given video codec

Arguments

Result

ArrayList<DecodeParameterDefinition> getDecodeParameterDefinitions(String decode_type)

Static method called to obtain the image decode parameter definitions for a given codec. The decode parameters are used to control how an RGBA image is generated from RAW formats like ARRIRAW, R3D etc.

This method returns an array of image decode parameter definitions for a given decode parameter type, one per parameter. Each parameter definition is a collection of key/value pairs, with different entries dependent on the type of parameter.

Arguments

Result

HashMap<String,Object> getDecodeParameters()

This method returns the image decode parameters for the shot.

Arguments

Result

void setDecodeParameters(HashMap<String,Object> decode_params)

Set some or all of the image decode parameters for the shot.

Arguments

Result

AudioSequenceSettings getAudioSettings()

Return the audio settings defined for this shot. Returns NULL if the shot has no audio defined.

Arguments

Result

void setAudioSettings(AudioSequenceSettings audio_settings)

Set the audio settings for this shot.

Arguments

Result

Set<Object> getMatteReferences(String eye)

Return a set of referenced/used mattes/channels for the shot.

Arguments

Result

void updateMatteReferences(HashMap<String,Object> matteChannels)

This method will update the matte channel names in any Reference operators within the Shot

Arguments

Result

CompletableFuture<Long> isValidAsync()

Called to determine if the shot object references a valid top strip an open scene. A shot object may become invalid in a couple of ways:

Arguments

Result

CompletableFuture<Scene> getSceneAsync()

Get the scene object which this shot is a part of.

Arguments

Result

CompletableFuture<Long> getIdAsync()

Get the shot's identifier, an integer which uniquely identifies the shot within the timeline. The id is persistent, remaining constant even if the scene containing the shot is closed and reopened.

Arguments

Result

CompletableFuture<Double> getStartFrameAsync()

Get the start frame of the shot within the scene which contains it. Because the time extent of a shot is actually defined by the shot's top strip, the start frame is actually the start frame of the top strip.

Arguments

Result

CompletableFuture<Double> getEndFrameAsync()

Get the end frame of the shot within the scene which contains it. Because the time extent of a shot is defined by the shot's top strip, the end frame is actually the end frame of the top strip. In Baselight, shot extents are defined in floating-point frames and are start-inclusive and end-exclusive. This means that the shot goes all the way up to the beginning of the end frame, but doesn't include it.

So a 5-frame shot starting at frame 100.0 would have an end frame 105.0 and 104.75, 104.9 and 104.99999 would all lie within the shot.

Arguments

Result

CompletableFuture<Double> getPosterFrameAsync()

Get the poster frame of the shot within the scene that contains it.

Arguments

Result

CompletableFuture<Timecode> getStartTimecodeAsync()

Get the start record timecode of the shot

Arguments

Result

CompletableFuture<Timecode> getEndTimecodeAsync()

Get the end record timecode of the shot

Arguments

Result

CompletableFuture<Timecode> getTimecodeAtFrameAsync(Long frame)

Get the record timecode at the given frame within the shot

Arguments

Result

CompletableFuture<Long> getSrcStartFrameAsync()

Return start frame number within source sequence/movie

Arguments

Result

CompletableFuture<Long> getSrcEndFrameAsync()

Return end frame number within source sequence/movie (exclusive)

Arguments

Result

CompletableFuture<Timecode> getSrcStartTimecodeAsync()

Return start timecode within source sequence/movie

Arguments

Result

CompletableFuture<Timecode> getSrcEndTimecodeAsync()

Return end timecode within source sequence/movie (exclusive)

Arguments

Result

CompletableFuture<Timecode> getSrcTimecodeAtFrameAsync(Long frame)

Return source timecode at the given frame within the shot

Arguments

Result

CompletableFuture<Keycode> getSrcStartKeycodeAsync()

Return start keycode within source sequence/movie

Arguments

Result

CompletableFuture<Keycode> getSrcEndKeycodeAsync()

Return end keycode within source sequence/movie (exclusive)

Arguments

Result

CompletableFuture<String> getInputColourSpaceAsync(String eye)

Return the input colour space defined for this shot. Can be 'None', indicating no specific colour space defined. For RAW codecs, this may be 'Auto' indicating that the input colour space will be determined by the SDK used to decode to the image data. In either case the actual input colour space can be determined by call get_actual_input_colour_space().

Arguments

Result

CompletableFuture<void> setInputColourSpaceAsync(String name, String eye)

Set the input colour space

Arguments

Result

CompletableFuture<Long> inputColourSpaceDerivedFromMediaAsync(String eye)

Return whether or not the shot's input colour space was derived from the media file's inate properties or metadata. If 1 is returned, this indicates a high degree of confidence that the shot's colour space journey is correct.

Arguments

Result

CompletableFuture<String> acesIdtForInputColourSpaceAsync(String eye, String aces_version)

Returns the name of the ACES IDT transform which is equivalent to the current input colour space. This IDT transform converts to ACES AP0

Arguments

Result

CompletableFuture<void> setStackColourSpaceAsync(String name, String eye)

Set the stack colour space

Arguments

Result

CompletableFuture<String> getActualInputColourSpaceAsync(String eye)

Return the input colour space for this shot. If the input colour space is set to 'Auto', the actual colour space name will be returned.

Arguments

Result

CompletableFuture<String> getInputFormatAsync(String eye)

Return the input format name for this shot

Arguments

Result

CompletableFuture<void> setInputFormatAsync(String name, String eye)

Set the input format name for this shot

Arguments

Result

CompletableFuture<String> getInputVideoLutAsync(String eye)

Return the input video lut value for this shot

Arguments

Result

CompletableFuture<void> setInputVideoLutAsync(String video_lut, String eye)

Set the input video LUT for this shot

Arguments

Result

CompletableFuture<String> getInputOrientationAsync(String eye)

Return the orientation transform for the input sequence

Arguments

Result

CompletableFuture<void> setInputOrientationAsync(String orientation, String eye)

Set the orientation transform for the input sequence

Arguments

Result

CompletableFuture<Double> getFrameRateAsync()

Return the frame rate of the Sequence for this shot

Arguments

Result

CompletableFuture<HashMap<String,Object>> getMetadataAsync(Set<Object> md_keys)

Get metadata values for the keys provided. The possible keys and the value type for each key are obtained using the Scene.get_metadata_definitions method.

Arguments

Result

CompletableFuture<HashMap<String,Object>> getMetadataStringsAsync(Set<Object> md_keys)

Get metadata values expressed as strings for the keys provided. The possible keys are obtained using the Scene.get_metadata_definitions method.

Arguments

Result

CompletableFuture<void> setMetadataAsync(HashMap<String,Object> metadata)

Set metadata values for the keys provided. The possible keys and the value type for each key are obtained using the Scene.get_metadata_definitions method.

Arguments

Result

CompletableFuture<SequenceDescriptor> getSequenceDescriptorAsync()

Get a SequenceDescriptor object that represents the input media for this shot.

Arguments

Result

CompletableFuture<Long> supportsClientEventDataAsync()

Does this shot support client event lists/data.

Arguments

Result

CompletableFuture<ArrayList<HashMap<String,Object>>> getClientEventListAsync(Long list_frame)

Get array of client events (notes/flags) for either an entire shot, or a specific frame of a shot. When querying the event list at a specific frame, NULL/None/null will be returned if no event list exists at that frame or the shot. The events array returned will be chronologically sorted (oldest first). Each event entry is itself a dictionary describing that event.

Arguments

Result

CompletableFuture<Long> addClientNoteAsync(String client_name, String note_text, Long event_list_frame)

Add a client note to either the client event list for an entire shot, or to the client event list at a specific frame number.

Arguments

Result

CompletableFuture<Long> addClientFlagAsync(String client_name, Long event_list_frame)

Add a new client flag entry to either the client event list for an entire shot, or to the client event list at a specific frame number. A client event list only supports a single flag event for a given client name; If one already exists, a call to this method will replace it with a new one.

Arguments

Result

CompletableFuture<Long> deleteClientEventAsync(String event_id)

Delete the (note or flag) event with the supplied id from the shot's client event list.

Arguments

Result

CompletableFuture<void> setClientEventMetadataAsync(Long client_event_id, HashMap<String,Object> metadata)

Set custom metadata key/value pairs for the client event with the supplied ID.

Arguments

Result

CompletableFuture<HashMap<String,Object>> getClientEventMetadataAsync(Long client_event_id, Set<Object> md_keys)

Get custom metadata key/value pairs for the client event with the supplied ID.

Arguments

Result

CompletableFuture<void> deleteClientEventMetadataAsync(Long client_event_id, Object metadata_key)

Delete a single metadata key/value item from the client event with the supplied ID.

Arguments

Result

CompletableFuture<ArrayList<Long>> getClientEventListFramesAsync()

Get array of (shot start relative) frame numbers of frames with client event lists

Arguments

Result

CompletableFuture<void> deleteFrameClientEventListAsync(Long list_frame)

Delete the entire client event list at the given shot frame (if any).

Arguments

Result

CompletableFuture<HashMap<String,Object>> getClientDataSummaryAsync()

Get summary info on any client data associated with this shot.

Arguments

Result

CompletableFuture<Long> getNumMarksAsync(String type)

Get number of marks within shot. If type is supplied, only return number of marks of the given type

Arguments

Result

CompletableFuture<ArrayList<Long>> getMarkIdsAsync(Long offset, Long count, String type, String eye)

Get shot mark ids within the shot. Shot marks are marks which are attached to the shot's top strip. If type is specified, only return marks of matching type.

Arguments

Result

CompletableFuture<Mark> getMarkAsync(Long id)

Get Mark object for given ID

Arguments

Result

CompletableFuture<Long> addMarkAsync(Long frame, String category, String note, String eye)

Add new Mark to the shot at the given source frame

Arguments

Result

CompletableFuture<void> deleteMarkAsync(Long id, String eye)

Delete the Mark object with the given mark ID

Arguments

Result

CompletableFuture<Set<String>> getCategoriesAsync()

Get the set of categories assigned to this shot.

Arguments

Result

CompletableFuture<void> setCategoriesAsync(Set<String> categories)

Set the categories assigned to this shot

Arguments

Result

CompletableFuture<void> insertBlgStackAsync(String blg_path)

Insert a BLG stack at the bottom of the shot.

Arguments

Result

CompletableFuture<String> getBlgPayloadAsync()

Returns the BLG payload for this shot.

Arguments

Result

CompletableFuture<void> applyBlgPayloadAsync(String blg_payload, String blg_resources)

Insert a BLG stack at the bottom of the shot.

Arguments

Result

CompletableFuture<String> getBlgResourcesAsync()

Returns the BLG resources for this shot.

Arguments

Result

CompletableFuture<String> getAmfOutputColourSpaceAsync(String amf_path)

Static utility method used to obtain the equivalent Truelight Colour Space name for the aces:outputTransform of the AMF.

Arguments

Result

CompletableFuture<String> insertAmfStackAsync(String amf_path, AMFInsertSettings settings)

Insert a AMF stack at the bottom of the shot.

Arguments

Result

CompletableFuture<String> setInputFormatFromFdlAsync(FDL fdl_obj, ShotSetInputFormatFromFDLOptions options, String eye)

Apply an ASC Framing Decision List (FDL) to specify the input format for this Shot. If no context, canvas or framing decision IDs are specified, the first FDL Canvas which matches the sequence resolution will be used.

If no matching canvas is found, this method will return NULL.

If an existing format is found that matches the FDL Canvas, that format will be used.

Arguments

Result

CompletableFuture<String> createFormatFromFdlCanvasTemplateAsync(FDL fdl_obj, String canvas_template_id, String format_name, String context_name, String canvas_name, String eye)

Apply an ASC Framing Decision List (FDL) Canvas Template to create a new format. This format can be used to create a deliverable from the input format.

Arguments

Result

CompletableFuture<FDL> getFdlAsync(String output_format_name, String eye)

Get the FDL representing the framing decisions in this shot

Arguments

Result

CompletableFuture<void> insertBasegradeLayerAsync(HashMap<String,Object> values)

Insert a BaseGrade layer at the bottom of the stack.

Arguments

Result

CompletableFuture<void> insertCdlLayerAsync(ArrayList<Double> cdl_values)

Insert a CDLGrade layer at the bottom of the shot.

Arguments

Result

CompletableFuture<void> insertCdlLayerAboveAsync(ArrayList<Double> cdl_values)

Insert a CDLGrade layer at the top of the shot.

Arguments

Result

CompletableFuture<void> insertLookLayerAsync(String look_name)

Insert a Look kayer at the bottom of the shot.

Arguments

Result

CompletableFuture<void> insertTruelightLayerAsync(String lut_path)

Insert a Truelight layer at the bottom of the shot. The Truelight operator is used for applying 1D and 3D LUTs to an image.

Arguments

Result

CompletableFuture<void> insertShapeLayerFromSvgAsync(String svg_path, String fit_mode, String mask_format, String mask_name)

Insert a layer with a shape strip populated from an SVG file at the bottom of the shot.

Arguments

Result

CompletableFuture<void> insertColourSpaceLayerAsync(String toColourSpace, String drt, Long identify)

Insert a ColourSpace operator at the bottom of the stack for this shot

Arguments

Result

CompletableFuture<void> insertLutLayerAsync(String location, String file, String inputColourSpace, String outputColourSpace, Long inputLegalRange, Long outputLegalRange, Long tetrahedral)

Insert a LUT operator at the bottom of the stack for this shot

Arguments

Result

CompletableFuture<void> deleteAllLayersAsync()

Remove all layers from the shot.

Arguments

Result

CompletableFuture<String> getCodecAsync()

Method to obtain the codec of the input media of the shot.

Arguments

Result

CompletableFuture<ArrayList<String>> getDecodeParameterTypesAsync()

Return list of supported decode parameter codec keys

Arguments

Result

CompletableFuture<String> getDecodeParameterTypeForCodecAsync(String codec)

Return the key identifying the decode parameters type to use for the given video codec

Arguments

Result

CompletableFuture<ArrayList<DecodeParameterDefinition>> getDecodeParameterDefinitionsAsync(String decode_type)

Static method called to obtain the image decode parameter definitions for a given codec. The decode parameters are used to control how an RGBA image is generated from RAW formats like ARRIRAW, R3D etc.

This method returns an array of image decode parameter definitions for a given decode parameter type, one per parameter. Each parameter definition is a collection of key/value pairs, with different entries dependent on the type of parameter.

Arguments

Result

CompletableFuture<HashMap<String,Object>> getDecodeParametersAsync()

This method returns the image decode parameters for the shot.

Arguments

Result

CompletableFuture<void> setDecodeParametersAsync(HashMap<String,Object> decode_params)

Set some or all of the image decode parameters for the shot.

Arguments

Result

CompletableFuture<AudioSequenceSettings> getAudioSettingsAsync()

Return the audio settings defined for this shot. Returns NULL if the shot has no audio defined.

Arguments

Result

CompletableFuture<void> setAudioSettingsAsync(AudioSequenceSettings audio_settings)

Set the audio settings for this shot.

Arguments

Result

CompletableFuture<Set<Object>> getMatteReferencesAsync(String eye)

Return a set of referenced/used mattes/channels for the shot.

Arguments

Result

CompletableFuture<void> updateMatteReferencesAsync(HashMap<String,Object> matteChannels)

This method will update the matte channel names in any Reference operators within the Shot

Arguments

Result

ThumbnailManager

Interface used to generate shot thumbnails

Signals

Methods

Async Methods

String getPosterUri(Shot shot_if, HashMap<String,Object> options)

Get a poster (or specific) frame thumbnail URI for a shot

Arguments

Result

ArrayList<String> getScrubUriTemplate(Scene scene_if, Shot shot_id, HashMap<String,Object> options)

Get a scrub image URI template (prefix & suffix strings). This can be used while scrubbing to generate image URIs without additional roundtrips/calls to the server.

Arguments

Result

CompletableFuture<String> getPosterUriAsync(Shot shot_if, HashMap<String,Object> options)

Get a poster (or specific) frame thumbnail URI for a shot

Arguments

Result

CompletableFuture<ArrayList<String>> getScrubUriTemplateAsync(Scene scene_if, Shot shot_id, HashMap<String,Object> options)

Get a scrub image URI template (prefix & suffix strings). This can be used while scrubbing to generate image URIs without additional roundtrips/calls to the server.

Arguments

Result

Timer (BETA)

A Timer allows your script to be triggered periodically to perform processing BETA

Signals

Methods

Async Methods

Timer create(Long interval, Long repeat)

Create a new Timer object

Arguments

Result

void start()

Start timer running

Arguments

Result

Long isStarted()

Inquire if timer is started

Arguments

Result

void stop()

Stop timer firing

Arguments

Result

Long getInterval()

Return interval between timer ticks firing

Arguments

Result

void setInterval(Long interval)

Set interval between timer ticks firing

Arguments

Result

CompletableFuture<Timer> createAsync(Long interval, Long repeat)

Create a new Timer object

Arguments

Result

CompletableFuture<void> startAsync()

Start timer running

Arguments

Result

CompletableFuture<Long> isStartedAsync()

Inquire if timer is started

Arguments

Result

CompletableFuture<void> stopAsync()

Stop timer firing

Arguments

Result

CompletableFuture<Long> getIntervalAsync()

Return interval between timer ticks firing

Arguments

Result

CompletableFuture<void> setIntervalAsync(Long interval)

Set interval between timer ticks firing

Arguments

Result

Utilities

Utility functions

Signals

Methods

Async Methods

Timecode timecodeFromString(String str, Long fps, Long wraphour)

Convert string to Timecode

Arguments

Result

ArrayList<EnumInfo> getAllowedEnumValues(String enumType)

Returns an array of EnumInfo objects representing the allowed values for a given enumeration type. Explictly, each returned entry has two fields: * Value - The (unique) internal value. * Desc - The user-friendly description for the value (so that you would typically present Desc to the user and use Value in calls to FLAPI functions).

Arguments

Result

CompletableFuture<Timecode> timecodeFromStringAsync(String str, Long fps, Long wraphour)

Convert string to Timecode

Arguments

Result

CompletableFuture<ArrayList<EnumInfo>> getAllowedEnumValuesAsync(String enumType)

Returns an array of EnumInfo objects representing the allowed values for a given enumeration type. Explictly, each returned entry has two fields: * Value - The (unique) internal value. * Desc - The user-friendly description for the value (so that you would typically present Desc to the user and use Value in calls to FLAPI functions).

Arguments

Result

Volumes

Query and configure storage for this system

Signals

Methods

Async Methods

ArrayList<String> getVolumeKeys()

Return keys for volumes accessible from this system

Arguments

Result

ArrayList<String> getLocalVolumeKeys()

Return volumes defined locally on this system

Arguments

Result

VolumeInfo getVolumeInfo(ArrayList<String> keys)

Return VolumeInfo describing the volume with the given key

Arguments

Result

CompletableFuture<ArrayList<String>> getVolumeKeysAsync()

Return keys for volumes accessible from this system

Arguments

Result

CompletableFuture<ArrayList<String>> getLocalVolumeKeysAsync()

Return volumes defined locally on this system

Arguments

Result

CompletableFuture<VolumeInfo> getVolumeInfoAsync(ArrayList<String> keys)

Return VolumeInfo describing the volume with the given key

Arguments

Result

Value Types

AMFExportSettings

Settings to use for AMF exports

Fields

AMFInsertSettings

Settings to use for AMF stack insertion

Fields

APIUserInfo

Settings for an API user

Fields

AudioSequenceSettings

Settings defining the behaviour of an Audio Sequence

Fields

AudioSyncProgress

Progress information from audio sync operation

Fields

AudioSyncSettings

Settings to use for AudioSync operation

Fields

BLGExportSettings

Settings to use for BLG exports

Fields

CDLExportSettings

Settings to use for CDL exports

Fields

CategoryInfo

Definition of a Category used to annotate marks, shots or strips

Fields

ClientViewClientSettings

Settings for a connected Client View

Fields

ClientViewHostUserSettings

Settings for user hosting the Client View

Fields

ClientViewStreamSettings

Settings for a Client View stream

Fields

ColourSpaceInfo

Description of a Truelight Colour Space

Fields

ConnectionInfo

Dictionary describing a single connection.

Fields

CubeExportSettings

Settings to use for Cube exports

Fields

CustomerInfo

Dictionary containing customer related settings/preferences.

Fields

DRTInfo

Description of a Truelight Display Rendering Transform

Fields

DecodeParameterChoice

Fields

DecodeParameterDefinition

This type is returned by get_decode_parameter_definitions to define the data type, label, ranges and values for each decode parameter that can be get or set for a Shot.

Fields

DialogItem (BETA)

Definition of an item to be shown in a DynamicDialog BETA

Fields

EnumInfo

Information about a defined enumerated value

Fields

ExportOpInfo

This type is returned to return information about export operations queued via QueueManager

Fields

ExportProgress

Progress information from Export operation

Fields

FDLCanvas

FDL Canvas within a Context

Fields

FDLCanvasTemplate

FDL Canvas Template

Fields

FDLContext

FDL Context containing Canvases

Fields

FDLCreateFormatFromCanvasOptions

Options for the FDL create_format_from_canvas() function

Fields

FDLDimension

Dimension defining an integer width & height

Fields

FDLDocument

Top level of Framing Decision List

Fields

FDLFramingDecision

FDL Framing Decision representing a framing intent within a Canvas

Fields

FDLFramingIntent

FDL Framing Intent

Fields

FDLPoint

Point defining an integer 2D position

Fields

FDLRealDimension

Dimension defining a floating-point width & height

Fields

FDLRealPoint

Point defining an floating-point 2D position

Fields

FDLRound

Rounding mode used when calculating canvas size

Fields

FDLValidation

Result of validating an FDL

Fields

FDLVersion

Version number of FDL

Fields

FLUXFileInfo

Description of a file selected in FLUX Manage Browser

Fields

FormatBurninItem

Definition of a text element within a FormatBurnin

Fields

FormatInfo

Specifies the width, height, pixel aspect ratio

Fields

FormatMapping

Defines the mapping from one Format to another Format

Fields

FormatMask

Specifies the area of Mark defined with a Format

Fields

FrameRange

Defines a range of frames

Fields

KeyTextItem

A mapping for a key object to a user-readable string describing that key

Fields

LicenceItem

Description of a installed licence option

Fields

LookInfo

Information for a Look

Fields

MetadataItem

Definition of a Metadata field that exists across all shots in a Scene

Fields

MetadataProperty

Definition of a Property that can specified for each MetadataItem defined in a Scene

Fields

MultiPasteProgress

Progress information from Multi-Paste operation

Fields

MultiPasteSettings

Settings to use for MultiPaste operation

Fields

NewSceneOptions

Options for create a new database or temporary scene

Fields

OpenSceneStatus

Status of scene opening or creation operation

Fields

QueueLogItem

Log Item from Queue Operation

Fields

QueueOp

Description of an Operation in a Queue

Fields

QueueOpStatus

Status of an Operation in a Queue

Fields

Rational

Holds a rational number. Used in situations where exact ratios are required.

Fields

RenderCodecInfo

Definition of a Codec that is supported for an image or movie file type

Fields

RenderCodecParameterInfo

Definition of a parameter to an image or movie codec

Fields

RenderCodecParameterValue

Definition of a valid value for a codec parameter

Fields

RenderDeliverable

This type is used to specify the render settings for an individual deliverable defined within a RenderSetup

Fields

RenderFileTypeInfo

Definition of an image or movie type

Fields

RenderOpInfo

This type is returned to return information about render operations queued via QueueManager

Fields

RenderProcessorLogItem

Log Item from RenderProcessor

Fields

RenderStatus

Status of render operation

Fields

SDKVersion

Version information for 3rd-party SDKs used in the application

Fields

SceneInfo

Return general information about the state of a scene

Fields

ScenePath

A ScenePath defines the host, job, folder and scene names required to create or open a FilmLight scene

Fields

SceneSettingDefinition

Type information for an SceneSettings parameter

Fields

ShotIndexRange

shot index range

Fields

ShotInfo

Shot info object

Fields

ShotSetInputFormatFromFDLOptions

Settings for Shot set_input_format_from_fdl() method

Fields

StillExportSettings

Settings to use for Still exports

Fields

VolumeInfo

Definition of a volume attached to, or accessible from, a FilmLight system

Fields

Constants & Enumerations

AFFINE_TYPE

Specify Sequence orientation affine transform type

AMFEXPORT_CLFHANDLING

Values for AMFExportSettings CLFHandling

AMFEXPORT_CLIPFILENAMEMODE

Values for AMFExportSettings ClipFilenameMode

AMF_APPLY

Values for AMFInsertSettings Apply

AUDIOSEQ_TYPE

Type of Audio in an Audio Sequence

AUDIOSYNCSTATUS

Status info related to audio sync progress

AUDIOSYNC_CRITERIA

Values for AudioSyncSettings Criteria

AUDIOSYNC_FPS

Values for AudioSyncSettings FPS

AUDIOSYNC_METADATA

Values for AudioSyncSettings Metadata

AUDIOSYNC_RATIO

Values for AudioSyncSettings Ratio

AUDIOSYNC_READLTC

Values for AudioSyncSettings ReadLTC

AUDIOSYNC_SUBSEARCH

Values for AudioSyncSettings SubSearch

AUDIO_RATE

Audio Sample Rate

BLGEXPORT_LOCKGRADE

Values for BLGExportSettings LockGrade

BLGEXPORT_SCALE

Values for BLGExportSettings Scale

BURNIN_BORDER

Define border type for burnin text item

BURNIN_HALIGN

Define horizontal alignment of burnin text item

BURNIN_ITEM_TYPE

Specify burnin item type

BURNIN_VALIGN

Define vertical alignment of burnin text item

CAT_MODE

Chromatic Adaptation Transform

CDLEXPORT_CDLLAYER

Values for CDLExportSettings CDLLayer

CDLEXPORT_FORMAT

Values for CDLExportSettings Format

CUBEEXPORT_CUBERESOLUTION

Values for CubeExportSettings CubeResolution

CUBEEXPORT_EXTENDEDRANGES

Values for CubeExportSettings ExtendedRanges

CUBEEXPORT_LUT1OPTIONS

Values for CubeExportSettings LUT1Options

CUBEEXPORT_LUT2OPTIONS

Values for CubeExportSettings LUT2Options

CUBEEXPORT_LUT3OPTIONS

Values for CubeExportSettings LUT3Options

CUBEEXPORT_LUTFORMAT

Values for CubeExportSettings LUTFormat

CUBEEXPORT_LUTRESOLUTION

Values for CubeExportSettings LUTResolution

CUBEEXPORT_NUMLUTS

Values for CubeExportSettings NumLUTs

DECODEPARAM_TYPE

Data type for a DecodeParameterDefinition

DECODEQUALITY

Decode Qulity to use for decoding source images for RAW codecs

DIALOG_ITEM_TYPE

Type for a DynamicDialogItem used in a DynamicDialog BETA

DOLBY_VISION_MODE

Dolby Vision Mode

EXPORTSTATUS

Status info related to Export progress

EXPORTTYPE

Type of Exporter BETA

EXPORT_CATEGORYMATCH

Values for Exporter CategoryMatch field

EXPORT_FRAMES

Values for Exporter Frames field

EXPORT_OVERWRITE

Values for Exporter Overwrite field

EXPORT_SOURCE

Values for Exporter Source field

EXPORT_STEREO

Values for Exporter Stereo field

FDL_ALIGNMENT_METHOD_HORIZONTAL

Policy for horizontally aligning source within target dimensions

FDL_ALIGNMENT_METHOD_VERTICAL

Policy for vertically aligning source within target dimensions

FDL_EVEN_MODE

Policy to use when canvas template size

FDL_FIT_METHOD

Method to fit source dimensions into target dimensions

FDL_FIT_SOURCE

Which area of source canvas to use when applying a canvas template

FDL_PRESERVE_MODE

Policy for preserving areas of source canvas in target canvas

FDL_ROUND_MODE

Policy to use when rounding floating-point values for canvas template size

FIELDORDER

Field order behaviour

FORMATSET_SCOPE

Defines the scope that a FormatSet is defined in

FSFILTER

Type of items to return from Filesystem get_items method

HDR_CLIPPING_BEHAVIOUR

HDR Clipping Behaviour

IMAGETRANSFORM_MODE

Specify filtering kernel to use for image resampling/transform operations

INSERT_POSITION

Specify where to insert a sequence in a Scene

LOG_SEVERITY

Log Message Severity BETA

LUT_LOCATION

Specify where LUT data should be found for a LUT operator

MARK_TYPE

Used to distinguish between timeline, shot and strip marks

MASTERING_OPERATION

Mastering Operation

MASTERING_WHITE_POINT

Mastering White Point

Location within application of new menu or menu item BETA

MULTIPASTESTATUS

Status info related to Multi-Paste progress

MULTIPASTE_BLGRESOURCECONFLICT

Values for MultiPasteSettings BLGResourceConflict

MULTIPASTE_DESTSELECTION

Values for MultiPasteSettings DestSelection

MULTIPASTE_DESTSHOTS

Values for MultiPasteSettings DestShots

MULTIPASTE_EDLAPPLYASCCDL

Values for MultiPasteSettings EDLApplyASCCDL

MULTIPASTE_LAYERZEROBEHAVIOUR

Values for MultiPasteSettings LayerZeroBehaviour

MULTIPASTE_LAYERZEROCATEGORIES

Values for MultiPasteSettings LayerZeroCategories

MULTIPASTE_MATCHBY

Values for MultiPasteSettings MatchBy

MULTIPASTE_MATCHQUALITY

Values for MultiPasteSettings MatchQuality

MULTIPASTE_PASTELOCATION

Values for MultiPasteSettings PasteLocation

MULTIPASTE_SOURCE

Values for MultiPasteSettings Source

MULTIPASTE_SOURCESHOTS

Values for MultiPasteSettings SourceShots

OPENFLAG

Flags used to control opening a scene

OPERATOR_BARS_TYPE

Define the type of Bars to render

OPSTATUS

Status of an operation in Queue or Processor

OPTICALFLOW_QUALITY

Optical Flow Quality

OPTICALFLOW_SMOOTHING

Optical Flow Smoothing

PROXY_RESOLUTION

Proxy Resolution of Render Format

QUEUE_LOG_TYPE

Message type for log entry queue operation log BETA

RENDER_ALPHA_HANDLING

Special values to use for AlphaHandling in RenderDeliverable

RENDER_CLIPNAME_SOURCE

Which clip name to embed into rendered output

RENDER_COLOURSPACE

Special values to use for RenderColourSpace in RenderDeliverable

RENDER_EMPTY_BEHAVIOUR

Action to take when encountering frames in timeline with no strips/shots

RENDER_ERROR_BEHAVIOUR

Action to take when encountering frames in timeline with no strips/shots

RENDER_FORMAT

Special values to use for RenderFormat in RenderDeliverable

RENDER_FRAMENUM

Specify how frame number for sequence should be calculated

RENDER_INCOMPLETE_BEHAVIOUR

Action to take when encountering shots with missing strips

RENDER_LAYER

Layers to include when rendering. This can be a layer number or one of the following constants.

RENDER_MASK

Select whether to crop to the mask, or set the black value for the masked area

RENDER_NCLC_TAG

Which NCLC tag to use in QuickTime Movie files for colourimetry

RENDER_TAPENAME_SOURCE

Which tape name to embed into rendered output

RENDER_TIMECODE_SOURCE

Which timecode to embed into rendered output

ROP_TEXT_ALIGN

Text alignment

SEQRESAMPLE_MODE

Sequence Resample Mode to use when resampling a sequence to a different video frame rate

STEREO_EYE

Stereo eye

STEREO_MODE

Stereo Mode

STILLEXPORT_BURNIN

Values for StillExportSettings Burnin

STILLEXPORT_DECODEQUALITY

Values for StillExportSettings DecodeQuality

STILLEXPORT_FILETYPE

Values for StillExportSettings FileType

STILLEXPORT_FORMAT

Values for StillExportSettings Format

STILLEXPORT_MASK

Values for StillExportSettings Mask

STILLEXPORT_MASKMODE

Values for StillExportSettings MaskMode

STILLEXPORT_RESOLUTION

Values for StillExportSettings Resolution

STILLEXPORT_TRUELIGHT

Values for StillExportSettings Truelight

SVGFITMODE

Controls how an SVG is transformed/fitted into a shape strip's 'target area' (the working format area or an optional mask area transformed to the working format).

TIMELINE_CACHING_MODE

Timeline Caching Mode

VIDEOLUT

Video Scaling LUT

Generated on Mon 12 Jan 2026 at 13:03:12