Scripting: SICreateImageClip2

SICreateImageClip2

Introduced

v4.0

Description

Creates and adds a new image source and a new image clip, the new clip pointing to the new source.

If the file texture is a media file such as an Advanced Authoring Format (AAF) composition that contains multiple tracks, one shared image source is created for the composition file itself, and one individual ImageClip object is created for each track it contains.

For all other file formats (including layered PhotoShop files), a single image clip will be created and returned.

This command supports downloading files from the internet. If the filename specified is a URL then the file is downloaded locally before the command is executed.

Note: This command does not use output arguments, therefore it is considered safe to use with C#, JScript, PerlScript and Python, unlike its unsafe counterpart: SICreateImageClip.

Scripting Syntax

oReturn = SICreateImageClip2( [FileName], [Name] );

Return Value

Returns an XSICollection that contains the list of newly created ImageClip objects.

Parameters

Parameter	Type	Description
FileName	String	Full path of the image source. Default Value: User is prompted to select
Name	String	The name to use for the new clip. Will be automatically set from the file name if not given.

Examples

VBScript Example

set NewClips = SICreateImageClip2("c:\windows\clock.avi" )
if IsEmpty( NewClips ) then
        logmessage "Failed To Create Image Clips"
else
        logmessage NewClips
End If