Package libavg :: Module avg :: Class Sound

Class Sound

A sound played from a file.

Instance Methods

acodec

getAudioCodec()
Returns the codec used as a string such as 'mp2'

samplerate

getAudioSampleRate()
Returns the sample rate in samples per second (for example, 44100).

numchannels

getNumAudioChannels()
Returns the number of channels.

pause()
Stops audio playback but doesn't close the object.

play()
Starts audio playback.

setEOFCallback(pyfunc)
Sets a python callable to be invoked when the video reaches end of file.

stop()
Stops audio playback.

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __getattribute__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Inherited from AreaNode

AreaNode

getElementByPos(pos)
Returns the topmost child node that is at the position given.

mediasize

getMediaSize()
Returns the size in pixels of the media in the node.

Inherited from Node

__eq__(...)

__hash__(...)
hash(x)

__init__(...)
Raises an exception This class cannot be instantiated from Python

__ne__(...)

abspos

getAbsPos(relpos)
Transforms a position in coordinates relative to the node to a position in window coordinates.

node

getParent()
Returns the container (AVGNode or DivNode) the node is in.

relpos

getRelPos(abspos)
Transforms a position in window coordinates to a position in coordinates relative to the node.

releaseEventCapture(cursorid)
Restores normal mouse operation after a call to setEventCapture().

setEventCapture(cursorid)
Sets up event capturing so that cursor events are sent to this node regardless of the cursor position.

setEventHandler(type, source, pyfunc)
Sets a callback function that is invoked whenever an event of the specified type from the specified source occurs.

None

unlink(kill)
Removes a node from it's parent container.

Inherited from AreaNode
Properties
	duration The duration of the sound file in milliseconds (ro).
	href The source filename of the sound.
	loop Whether to start the sound again when it has ended (ro).
	volume Audio playback volume for this sound.
Inherited from `object`: `__class__`
	angle The angle that the node is rotated to in radians.
	height
	pivot The position of the point that the node is rotated around.
	pivotx Deprecated.
	pivoty Deprecated.
	pos The position of the node's top left corner relative to it's parent node.
	size
	width
	x The position of the node's left edge relative to it's parent node.
	y The position of the node's top edge relative to it's parent node.
Inherited from Node
	active If this attribute is true, the node behaves as usual.
	id A unique identifier that can be used to reference the node.
	opacity A measure of the node's transparency.
	sensitive A node only reacts to events if sensitive is true.

Method Details

getNumAudioChannels()

Returns the number of channels. 2 for stereo, etc.

Returns: numchannels

pause()

Stops audio playback but doesn't close the object. The playback cursor stays at the same position.

stop()

Stops audio playback. Closes the object and 'rewinds' the playback cursor.

Property Details

duration

The duration of the sound file in milliseconds (ro).

Get Method:: unreachable(...)

href

The source filename of the sound.

Get Method:: unreachable(...)
Set Method:: unreachable(...)

loop

Whether to start the sound again when it has ended (ro).

Get Method:: unreachable(...)

volume

Audio playback volume for this sound. 0 is silence, 1 passes media file volume through unchanged. Values higher than 1 can be used to amplify sound if the sound file doesn't use the complete dynamic range.

Get Method:: unreachable(...)
Set Method:: unreachable(...)