SoundObj Class Reference

Class Description

A sound object's primary purpose is to provide a sound track for the scene. There is always one sound object in the scene.

Inheritance diagram for SoundObj:

Public Member Functions
def	GetTime (self)
def	IsMute (self)
def	Play (self, args)
def	Playing (self)
def	Scrub (self, args)
def	SetMute (self, args)
def	Stop (self)
Public Member Functions inherited from ReferenceTarget
def	FindDependentNode (self)
def	MaybeAutoDelete (self)
def	NotifyTarget (self, args)
Public Member Functions inherited from ReferenceMaker
def	ClearFlagInHierarchy (self, args)
def	DeleteMe (self)
def	DeleteReference (self, args)
def	FindRef (self, args)
def	GetNumRefs (self)
def	GetReference (self, args)
def	NotifyChanged (self)
def	NotifyDependents (self, args)
def	ReplaceReference (self, args)
def	RescaleWorldUnits (self, args)
Public Member Functions inherited from Animatable
def	AddNewKey (self, args)
def	AssignController (self, args)
def	CanAssignController (self, args)
def	CanCopyAnim (self)
def	CanCopyTrack (self, args)
def	CanDeleteSubAnim (self, args)
def	CanMakeUnique (self)
def	ClearAFlag (self, args)
def	ClearAFlagEx (self, args)
def	ClearAllAppData (self)
def	ClearFlagBit (self, args)
def	ClearFlagInAllAnimatables (args)
def	CopyKeysFromTime (self, args)
def	DeleteAppData (self, args)
def	DeleteKeyAtTime (self, args)
def	DeleteKeyByIndex (self, args)
def	DeleteKeys (self, args)
def	DeleteSubAnim (self, args)
def	DeleteTime (self, args)
def	DoesSupportTimeOperations (self)
def	EditTimeRange (self, args)
def	FreeCaches (self)
def	GetAnimByHandle (args)
def	GetAnimHandle (self)
def	GetAppData (self, args)
def	GetClassID (self)
def	GetClassName (self)
def	GetCustomAttributeContainer (self)
def	GetHasSubElements
def	GetKeyIndex (self, args)
def	GetKeyTime (self, args)
def	GetNextKeyTime (self, args)
def	GetNodeName (self)
def	GetNumKeys (self)
def	GetNumSubAnims (self)
def	GetParameterBlock (self)
def	GetSubAnim (self, args)
def	GetSubAnimName (self, args)
def	GetSuperClassID (self)
def	GetTimeRange (self, args)
def	InsertTime (self, args)
def	IsAnimated (self)
def	IsKeyAtTime (self, args)
def	IsSubClassOf (self, args)
def	MoveKeys (self, args)
def	ReverseTime (self, args)
def	ScaleKeyValues (self, args)
def	ScaleTime (self, args)
def	SetAFlag (self, args)
def	SetAFlagEx (self, args)
def	SetAppData (self, args)
def	SetFlagBit (self, args)
def	SubNumToRefNum (self, args)
def	TestAFlag (self, args)
def	TestAFlagEx (self, args)
def	TestFlagBit (self, args)
Public Member Functions inherited from InterfaceServer
def	GetInterface (self, args)
Public Member Functions inherited from Wrapper
def	GetUnwrappedPtr (self)

Static Public Attributes
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from ReferenceTarget
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from ReferenceMaker
tuple	NumRefs = _swig_property(GetNumRefs)
tuple	Refs = _swig_property(lambda self: (self.GetReference(i) for i in xrange(self.GetNumRefs())))
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from Animatable
tuple	AnimHandle = _swig_property(GetAnimHandle)
tuple	ClassID = _swig_property(GetClassID)
tuple	ClearFlagInAllAnimatables = staticmethod(ClearFlagInAllAnimatables)
tuple	GetAnimByHandle = staticmethod(GetAnimByHandle)
tuple	KeyTimes = _swig_property(lambda self: (self.GetKeyTime(i) for i in xrange(self.GetNumKeys())))
tuple	NodeName = _swig_property(GetNodeName)
tuple	NumSubAnims = _swig_property(GetNumSubAnims)
tuple	ParameterBlock = _swig_property(GetParameterBlock)
tuple	SubAnimNames = _swig_property(lambda self: (self.GetSubAnimName(i) for i in xrange(self.GetNumSubAnims())))
tuple	SubAnims = _swig_property(lambda self: (self.GetSubAnim(i) for i in xrange(self.GetNumSubAnims())))
tuple	SuperClassID = _swig_property(GetSuperClassID)
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from InterfaceServer
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from Wrapper
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Member Function Documentation

def GetTime

(

self

)

GetTime(SoundObj self) -> TimeValue

def IsMute

(

self

)

IsMute(SoundObj self) -> bool

def Play	(		self,
			args
	)

Play(SoundObj self, TimeValue tStart, TimeValue t0, TimeValue t1, TimeValue frameStep) -> bool

def Playing

(

self

)

Playing(SoundObj self) -> bool

def Scrub	(		self,
			args
	)

Scrub(SoundObj self, TimeValue t0, TimeValue t1)

def SetMute	(		self,
			args
	)

SetMute(SoundObj self, bool mute)

def Stop

(

self

)

Stop(SoundObj self) -> TimeValue