workspace.tools.views.create Namespace Reference

Classes
class	EmptyStringException

Functions
def	createAudioFile (user, library, alias, relativeFilePath, realStartTime, staticUserMetaDataDict, md5digest=None)
	Create a new MediaFile (type audio) More...
def	createTagExample (user, tagSet, audioFile, startTime, endTime, minFreq, maxFreq)
	Create a new TagExample in the Database. More...
def	createTag (user, tagExample, tagClass, machineTagged, userTagged, strength)
	Create a new Tag in the Database. More...
def	createTagClass (user, project, className, displayName)
	Add a new TagClass to a Project. More...

Function Documentation

def workspace.tools.views.create.createAudioFile	(		user,
			library,
			alias,
			relativeFilePath,
			realStartTime,
			staticUserMetaDataDict,
			md5digest = None
	)

Create a new MediaFile (type audio)

Parameters

user	User object that owns the tag
library	Library object in which this file will be stored.
alias	The MediaFile 'alias' to store in the database
relativeFilePath	The 'relativeFilePath' of the MediaFile to store in the database, and to open the file
realStartTime	The 'real' start date/time of the file. None if not applicable/known.
staticUserMetaDataDict

Returns

The new MediaFile object, None if failure

def workspace.tools.views.create.createTag	(		user,
			tagExample,
			tagClass,
			machineTagged,
			userTagged,
			strength
	)

Create a new Tag in the Database.

Parameters

user	User object that owns the tag
tagExample	TagExample Object
tagClass	TagClass Object
machineTagged	Boolean
userTagged	Boolean
strength	Float

Returns

The new Tag Object

def workspace.tools.views.create.createTagClass	(		user,
			project,
			className,
			displayName
	)

Add a new TagClass to a Project.

Parameters

user	User Object
project	The Project Object to which the TagClass belongs
className	The Class Name of the new TagClass
displayName	The Display Name of the new TagClass

Returns

The new TagClass object (None if failure)

def workspace.tools.views.create.createTagExample	(		user,
			tagSet,
			audioFile,
			startTime,
			endTime,
			minFreq,
			maxFreq
	)

Create a new TagExample in the Database.

Parameters

user	User object that owns the tag
tagSet	TagSet object to which this TagExample belongs
audioFile	MediaFile object this TagExample references
startTime	Seconds from start of audioFile
endTime	Seconds from start of audioFile
minFreq	Hz
maxFreq	Hz

Returns

The new TagExample Object