com.openinventor.inventor.vrmlnodes

Class SoVRMLAudioClip

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.vrmlnodes.SoVRMLNode

com.openinventor.inventor.vrmlnodes.SoVRMLAudioClip

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLAudioClip
extends SoVRMLNode

Audio data node </font>. <font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

This node has an effect only on Windows.

An SoVRMLAudioClip node specifies audio data that can be referenced by other nodes that require an audio source.

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org.

An SoVRMLAudioClip node specifies audio data that can be referenced by other nodes that require an audio source.

The description field is a textual description of the audio source. A browser is not required to display the description field but may choose to do so in addition to or in place of playing the sound.

The url field specifies the URL from which the sound is loaded. Browsers must support at least the wavefile format in uncompressed PCM format. It is recommended that browsers also support the MIDI file type 1 sound format. MIDI files are presumed to use the General MIDI patch set. See the section on URLs and URNs in "Concepts - URLs and URNs" for details on the url field. Results are not defined when the URL references unsupported data types.

The loop, startTime, and stopTime exposedFields and the isActive eventOut, and their effects on the SoVRMLAudioClip node, are discussed in detail in the "Concepts - Time Dependent Nodes" section. The "cycle" of an SoVRMLAudioClip is the length of time in seconds for one playing of the audio at the specified pitch.

The pitch field specifies a multiplier for the rate at which sampled sound is played. Only positive values are valid for pitch (a value of zero or less will produce undefined results). Changing the pitch field affects both the pitch and playback speed of a sound. A set_pitch event to an active SoVRMLAudioClip is ignored (and no pitch_changed eventOut is generated). If pitch is set to 2.0, the sound should be played one octave higher than normal and played twice as fast. For a sampled sound, the pitch field alters the sampling rate at which the sound is played. The proper implementation of the pitch control for MIDI (or other note sequence sound clip) is to multiply the tempo of the playback by the pitch value and adjust the MIDI Coarse Tune and Fine Tune controls to achieve the proper pitch change. The pitch field must be > 0.0.

A duration_changed event is sent whenever there is a new value for the "normal" duration of the clip. Typically this will only occur when the current url in use changes and the sound data has been loaded, indicating that the clip is playing a different sound source. The duration is the length of time in seconds for one cycle of the audio for a pitch set to 1.0. Changing the pitch field will not trigger a duration_changed event. A duration value of -1 implies the sound data has not yet loaded or the value is unavailable for some reason.

The isActive eventOut can be used by other nodes to determine if the clip is currently active. If an SoVRMLAudioClip is active, then it should be playing the sound corresponding to the sound time (i.e., in the sound's local time system with sample 0 at time 0):

   fmod (now - startTime, duration / pitch).

File format/default:

VRMLAudioClip {

description	""
loop	false
pitch	1.0
startTime	0
stopTime	0
pauseTime	0
resumeTime	0
url	[]
metadata	NULL

}

EVENTS

eventIn

SoSFString	set_description
SoSFBool	set_loop
SoSFFloat	set_pitch
SoSFTime	set_startTime
SoSFTime	set_stopTime
SoSFTime	set_pauseTime (Note: Not implemented)
SoSFTime	set_resumeTime (Note: Not implemented)
SoMFFilePathString	set_url
SoSFNode	set_metadata

eventOut

SoSFTime	duration_changed
SoSFTime	elapsedTime (Note: Not implemented)
SoSFBool	isActive
SoSFBool	isPaused (Note: Not implemented)
SoSFString	description_changed
SoSFBool	loop_changed
SoSFFloat	pitch_changed
SoSFTime	startTime_changed
SoSFTime	stopTime_changed
SoSFTime	pauseTime_changed (Note: Not implemented)
SoSFTime	resumeTime_changed (Note: Not implemented)
SoMFFilePathString	url_changed
SoSFNode	metadata_changed

Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFString	description Deprecated. Textual description of the audio source.
SoSFBool	loop Deprecated. Controls whether the sound continues when it reaches the end of a sound cycle as defined in the audio file.
SoSFTime	pauseTime Deprecated. (Note: Not implemented) The pause time for the sound.
SoSFFloat	pitch Deprecated. Multiplier for the rate at which sampled sound is played.
SoSFTime	resumeTime Deprecated. (Note: Not implemented) The resume time for the sound.
SoSFTime	startTime Deprecated. The starting time for the sound.
SoSFTime	stopTime Deprecated. The stopping time for the sound.
SoMFFilePathString	url Deprecated. Specifies the URL from which the sound is loaded.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLNode

metadata

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLAudioClip() Deprecated. Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

public final SoSFString description

Deprecated.

Textual description of the audio source.

loop

public final SoSFBool loop

Deprecated.

Controls whether the sound continues when it reaches the end of a sound cycle as defined in the audio file. If loop is false at the end of a cycle, execution is terminated. If true, the sound continues into the next cycle.

pitch

public final SoSFFloat pitch

Deprecated.

Multiplier for the rate at which sampled sound is played.

startTime

public final SoSFTime startTime

Deprecated.

The starting time for the sound.

stopTime

public final SoSFTime stopTime

Deprecated.

The stopping time for the sound. An SoVRMLAudioClip node with loop true at the end of every cycle continues forever if startTime>=stopTime or until stopTime if stopTime>startTime.

pauseTime

public final SoSFTime pauseTime

Deprecated.

(Note: Not implemented) The pause time for the sound. An SoVRMLAudioClip node with loop true at the end of every cycle pauses if current time >= pauseTime >resumeTime

Since:

Open Inventor 5.0 NOTE 2: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it.

resumeTime

public final SoSFTime resumeTime

Deprecated.

(Note: Not implemented) The resume time for the sound. An SoVRMLAudioClip node with loop true at the end of every cycle pauses if current time >= resumeTime >pauseTime

Since:

Open Inventor 5.0 NOTE 2: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it.

url

public final SoMFFilePathString url

Deprecated.

Specifies the URL from which the sound is loaded.

Constructor Detail

SoVRMLAudioClip

public SoVRMLAudioClip()

Deprecated.

Constructor.