All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class vlc.vrml.generic.geometry.AudioClip

java.lang.Object
   |
   +----vlc.vrml.generic.geometry.VrmlObject
           |
           +----vlc.vrml.generic.geometry.AudioClip

public class AudioClip
extends VrmlObject
implements AudioNode
JVerge

Version:
0.8 (beta 4) Copyright 1997 The Virtual Light Company under the GNU LGPL

The latest information and bugs in JVerge can be found at http://www.vlc.com.au/JVerge

For definition of the Anchor node please see the VRML 97 Anchor specification

Author:
Justin Couch justin@vlc.com.au

Constructor Index

 o AudioClip()
Basic constructor.

Method Index

 o cleanup()
Call when about to remove the node from the scenegraph.
 o clone()
Make a clone of this object
 o get_description()
Get the description field
 o get_loop()
Get the current looping condition for this node
 o get_pitch()
Get the amount of pitch bending currently applied
 o get_startTime()
Get the current starting time of this AudioClip
 o get_stopTime()
Get the current stopping time of this AudioClip
 o get_url()
Get the list of URLs that this node is currently using
 o set_description(String)
Set the string which describes what this node is
 o set_loop(boolean)
Set whether this clip should loop its output
 o set_pitch(float)
Set the pitch value of the node.
 o set_startTime(double)
Set the time at which the AudioClip is to start running
 o set_stopTime(double)
Set the time at which the AudioClip is to stop running
 o set_url(String[])
Set the list of URLs for the source of the sound
 o writeToStream(int)
Prints the formatted contents of this node to the given stream.

Constructors

 o AudioClip
 public AudioClip()
Basic constructor. Used when the Browser reference has previously been defined using the set_browser method

Methods

 o cleanup
 public void cleanup()
Call when about to remove the node from the scenegraph.

Overrides:
cleanup in class VrmlObject
 o writeToStream
 public void writeToStream(int indent)
Prints the formatted contents of this node to the given stream.

Parameters:
indent - The number of spaces to indent this node in the string
Overrides:
writeToStream in class VrmlObject
 o set_url
 public void set_url(String url[])
Set the list of URLs for the source of the sound

Parameters:
The - list of URLs in decending order of preference
 o get_url
 public String[] get_url()
Get the list of URLs that this node is currently using

Returns:
The lsit of URLs in decending order of preference
 o set_loop
 public void set_loop(boolean val)
Set whether this clip should loop its output

Parameters:
val - true if the output is to loop, false if not
 o get_loop
 public boolean get_loop()
Get the current looping condition for this node

Returns:
true if the node is set to loop, false if not.
 o set_pitch
 public void set_pitch(float val)
Set the pitch value of the node.

Parameters:
A - value greater than zero representing the amount of pitch change
 o get_pitch
 public float get_pitch()
Get the amount of pitch bending currently applied

Returns:
A value representing amount of pitch bending
 o set_startTime
 public void set_startTime(double val)
Set the time at which the AudioClip is to start running

Parameters:
The - start time in seconds
 o get_startTime
 public double get_startTime()
Get the current starting time of this AudioClip

Returns:
The current start time in seconds
 o set_stopTime
 public void set_stopTime(double val)
Set the time at which the AudioClip is to stop running

Parameters:
The - stop time in seconds
 o get_stopTime
 public double get_stopTime()
Get the current stopping time of this AudioClip

Returns:
The current stop time in seconds
 o set_description
 public void set_description(String description)
Set the string which describes what this node is

Parameters:
description - The string representing the new description
 o get_description
 public String get_description()
Get the description field

Returns:
The string which is the description used for this node
 o clone
 public Object clone()
Make a clone of this object

Returns:
A deep clone copy of this object
Overrides:
clone in class VrmlObject

All Packages  Class Hierarchy  This Package  Previous  Next  Index