This interface is used to access the main storyboard project. It can be used to query the sequences, scenes, panels and transitions of the project. As well, it can be used to create, delete or rename project objects.
More...
|
|
int | numberOfSequencesInProject () |
| Returns the number of sequences in the project. More...
|
|
String | sequenceInProject (int i) |
| Returns the sequenceId of the ith sequence in project. More...
|
|
String | sequenceIdOfScene (String &sceneId) |
| Returns sequenceId of the sequence of the given scene. More...
|
|
|
int | numberOfScenesInSequence (String &sequenceId) |
| returns the number of scenes in a sequence More...
|
|
String | sceneInSequence (String &sequenceId, int i) |
| Returns sceneId of the ith scene in sequence. More...
|
|
int | numberOfScenesInProject () |
| returns the number of scenes in project More...
|
|
String | sceneInProject (int i) |
| Returns sceneId of the ith scene in project. More...
|
|
String | sceneIdOfPanel (String &panelId) |
| Returns sceneId of the panel. More...
|
|
|
int | numberOfPanelsInScene (String &sceneId) |
| Returns the number of panels in a scene. More...
|
|
String | panelInScene (String &sceneId, int index) |
| Returns the panelId of the ith panel in the scene. More...
|
|
int | numberOfPanelsInProject () |
| returns the number of panels in project More...
|
|
String | panelInProject (int i) |
| Returns panelId of the ith panel in project. More...
|
|
|
String | nameOfSequence (String &sequenceId) |
| Returns the name of the sequence. More...
|
|
String | nameOfScene (String &sceneId) |
| Returns the name of the scene. More...
|
|
String | nameOfPanel (String &panelId) |
| Returns the name of the panel. More...
|
|
String | sequenceId (String &sequenceName) |
| Returns the unique id of the sequence. More...
|
|
String | sceneId (String &sequenceName, String &sceneName) |
| Returns the unique id of the scene. More...
|
|
String | panelId (String &sequenceName, String &sceneName, String &panelName) |
| Returns the unique id of the panel. More...
|
|
|
String | createSequence (String &firstShotId, String &lastShotId) |
| Creates a new sequence. More...
|
|
String | insertScene (bool after, String &shotId, String &name) |
| Inserts a new scene. More...
|
|
String | appendScene (String &name) |
| Append a scene at the end of the project. More...
|
|
String | insertPanel (bool after, String &panelId, String &name) |
| Inserts a new panel. More...
|
|
String | appendPanel (String &name) |
| Append a panel at the end of the project. More...
|
|
bool | splitPanel (String &panelId, unsigned int atFrame) |
| Split a panel into 2 panels. More...
|
|
bool | deleteSequence (String &seqId) |
| Deletes a sequence. More...
|
|
bool | deleteScene (String &sceneId) |
| Deletes a scene. More...
|
|
bool | deletePanel (String &panelId) |
| Deletes a panel. More...
|
|
bool | renameSequence (String &seqId, String &newName) |
| Renames a sequence. More...
|
|
bool | renameScene (String &sceneId, String &newName) |
| Renames a scene. More...
|
|
bool | renamePanel (String &panelId, String &newName) |
| Renames a panel. More...
|
|
int | getPanelDuration (String &panelId) |
| gets the panel Duration More...
|
|
bool | setPanelDuration (String &panelId, int frames) |
| sets the panel duration More...
|
|
int | sceneStartFrame (String &shotId) |
| returns the start frame of a scene More...
|
|
int | sceneEndFrame (String &shotId) |
| returns the last frame of a scene More...
|
|
|
For the sake of clarity, the trx is always associated with the shot to it's right.
|
StringList | scenesWithTrx () |
| returns a list of the sceneIds of scenes that have leading transitions More...
|
|
String | sceneIdOfTrx (String &trxId) |
| returns the sceneId of the shot to the right of the transition More...
|
|
String | trxIdOfScene (String &shotId) |
| returns the transition ID of the transition to the left of the shot More...
|
|
bool | sceneHasTrx (String &shotId) |
| returns whether a scene has a leading transition More...
|
|
String | trxType (String &trxId) |
| returns a string identifying the transition type More...
|
|
int | trxLength (String &trxId) |
| returns the length of the transition More...
|
|
|
String | createTrx (String &shotId, unsigned int length, String &stringType, int angle=90, bool reverse=false) |
| Create a transition ( at the beginning of the target shot ), and return the unique ID of the transition. More...
|
|
bool | modifyTrx (String &trxId, String &stringType, int angle=90, bool revers=false) |
| modify the transition More...
|
|
bool | resizeTrx (String &trxId, unsigned int length) |
| resize a transition More...
|
|
bool | deleteTrx (String &trxId) |
| delete a transition More...
|
|
This interface is used to access the main storyboard project. It can be used to query the sequences, scenes, panels and transitions of the project. As well, it can be used to create, delete or rename project objects.
Scenes, Panels and Transitions are identified by a unique id. For the sake of clarity, a transition is considered to belong to the shot to it's right. Or, the shot owns the transition to it's left.
The following examples are provided:
function projectQuery()
{
var nbSeqs = storyboard.numberOfSequencesInProject();
for ( var i =0; i < nbSeqs; ++i )
{
var id = storyboard.sequenceInProject( i );
System.
println(
"Sequence is " +
id +
" : " + storyboard.nameOfSequence(
id ) ) ;
var nbScenes = storyboard.numberOfScenesInSequence( id );
for ( var j = 0; j < nbScenes; ++ j )
{
var sceneId = storyboard.sceneInSequence( id, j );
System.
println(
" scene is " + sceneId +
" : " + storyboard.nameOfScene( sceneId ) ) ;
}
}
var nbShots = storyboard.numberOfScenesInProject();
for ( var i =0; i < nbShots; ++i )
{
var sceneId = storyboard.sceneInProject(i);
var seqId = storyboard.sequenceIdOfScene( sceneId );
System.
println(
"Scene is " + sceneId +
": " + storyboard.nameOfScene( sceneId ) +
" sequence is " + storyboard.nameOfSequence( seqId)) ;
}
}
function transitionQuery()
{
var sceneList = sb.scenesWithTrx();
for ( var i = 0; i < sceneList.length; ++i )
{
var trxId = sb.trxIdOfScene( sceneList[i] );
+ " has a transition of type "
+ sb.trxType( trxId )
+ " and of length "
+ sb.trxLength( trxId ));
}
}