.TH "SoVRMLAudioClip" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoVRMLAudioClip \- The \fBSoVRMLAudioClip\fP class is used to load and store audio data\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/VRMLnodes/SoVRMLAudioClip\&.h>\fP
.PP
Inherits \fBSoNode\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "\fBtypedef\fP \fBvoid\fP * \fBopen_func\fP(\fBconst\fP \fBSbStringList\fP &\fBurl\fP, \fBSoVRMLAudioClip\fP *clip, \fBvoid\fP *\fBuserdataptr\fP)"
.br
.ti -1c
.RI "\fBtypedef\fP size_t \fBread_func\fP(\fBvoid\fP *\fBdatasource\fP, \fBvoid\fP *buffer, int \fBnumframes\fP, int &channels, \fBSoVRMLAudioClip\fP *clip, \fBvoid\fP *\fBuserdataptr\fP)"
.br
.ti -1c
.RI "\fBtypedef\fP int \fBseek_func\fP(\fBvoid\fP *\fBdatasource\fP, \fBlong\fP offset, int \fBwhence\fP, \fBSoVRMLAudioClip\fP *clip, \fBvoid\fP *\fBuserdataptr\fP)"
.br
.ti -1c
.RI "\fBtypedef\fP \fBlong\fP \fBtell_func\fP(\fBvoid\fP *\fBdatasource\fP, \fBSoVRMLAudioClip\fP *clip, \fBvoid\fP *\fBuserdataptr\fP)"
.br
.ti -1c
.RI "\fBtypedef\fP int \fBclose_func\fP(\fBvoid\fP *\fBdatasource\fP, \fBSoVRMLAudioClip\fP *clip, \fBvoid\fP *\fBuserdataptr\fP)"
.br
.in -1c

Public Types inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "enum \fBNodeType\fP { \fBINVENTOR\fP = 0x0000, \fBVRML1\fP = 0x0001, \fBVRML2\fP = 0x0002, \fBINVENTOR_1\fP = 0x0004, \fBINVENTOR_2_0\fP = 0x0008, \fBINVENTOR_2_1\fP = 0x0010, \fBINVENTOR_2_5\fP = 0x0020, \fBINVENTOR_2_6\fP = 0x0040, \fBCOIN_1_0\fP = 0x0080, \fBCOIN_2_0\fP = 0x0100, \fBEXTENSION\fP = 0x0200, \fBCOIN_2_2\fP = 0x0400, \fBCOIN_2_3\fP = 0x0800, \fBCOIN_2_4\fP = 0x1000, \fBINVENTOR_5_0\fP = 0x2000, \fBCOIN_2_5\fP = 0x4000, \fBCOIN_3_0\fP = 0x8000, \fBINVENTOR_6_0\fP = 0x10000, \fBCOIN_4_0\fP = 0x20000 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoVRMLAudioClip\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "int \fBgetSampleRate\fP ()"
.br
.ti -1c
.RI "\fBvoid\fP * \fBopen\fP (\fBconst\fP \fBSbStringList\fP &\fBurl\fP)"
.br
.ti -1c
.RI "size_t \fBread\fP (\fBvoid\fP *\fBdatasource\fP, \fBvoid\fP *buffer, int \fBnumframes\fP, int &channels)"
.br
.ti -1c
.RI "int \fBseek\fP (\fBvoid\fP *\fBdatasource\fP, \fBlong\fP offset, int \fBwhence\fP)"
.br
.ti -1c
.RI "\fBlong\fP \fBtell\fP (\fBvoid\fP *\fBdatasource\fP)"
.br
.ti -1c
.RI "int \fBclose\fP (\fBvoid\fP *\fBdatasource\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetCallbacks\fP (open_func *\fBopencb\fP, read_func *\fBreadcb\fP, seek_func *\fBseekcb\fP, tell_func *\fBtellcb\fP, close_func *\fBclosecb\fP, \fBvoid\fP *\fBuserdataptr\fP)"
.br
.in -1c

Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBsetOverride\fP (\fBconst\fP SbBool state)"
.br
.ti -1c
.RI "SbBool \fBisOverride\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetNodeType\fP (\fBconst\fP \fBNodeType\fP type)"
.br
.ti -1c
.RI "\fBNodeType\fP \fBgetNodeType\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBcopy\fP (SbBool \fBcopyconnections\fP=FALSE) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBaffectsState\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBdoAction\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderBelowPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderInPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderOffPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcallback\fP (\fBSoCallbackAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetMatrix\fP (\fBSoGetMatrixAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBhandleEvent\fP (\fBSoHandleEventAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBpick\fP (\fBSoPickAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBrayPick\fP (\fBSoRayPickAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsearch\fP (\fBSoSearchAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBSoWriteAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBaudioRender\fP (\fBSoAudioRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgrabEventsSetup\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgrabEventsCleanup\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBstartNotify\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBl\fP)"
.br
.ti -1c
.RI "SbUniqueId \fBgetNodeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoChildList\fP * \fBgetChildren\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwriteInstance\fP (\fBSoOutput\fP *\fBout\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBaddToCopyDict\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcopyContents\fP (\fBconst\fP \fBSoFieldContainer\fP *from, SbBool \fBcopyconnections\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoFieldContainer\fP * \fBcopyThroughConnection\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBsetToDefaults\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBhasDefaultValues\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBfieldsAreEqual\fP (\fBconst\fP \fBSoFieldContainer\fP *container) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBcopyFieldValues\fP (\fBconst\fP \fBSoFieldContainer\fP *container, SbBool \fBcopyconnections\fP=FALSE)"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *\fBconst\fP fielddata)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &fielddata)"
.br
.ti -1c
.RI "\fBvirtual\fP int \fBgetFields\fP (\fBSoFieldList\fP &\fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP int \fBgetAllFields\fP (\fBSoFieldList\fP &\fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetField\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetEventIn\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetEventOut\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetFieldName\fP (\fBconst\fP \fBSoField\fP *\fBconst\fP \fBfield\fP, \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (\fBconst\fP SbBool \fBflag\fP)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *fielddata, \fBSoInput\fP *input)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &fielddata, \fBSoOutput\fP *\fBout\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBvalidateNewFieldValue\fP (\fBSoField\fP *\fBfield\fP, \fBvoid\fP *\fBnewval\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBaddWriteReference\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisfromfield\fP=FALSE)"
.br
.ti -1c
.RI "SbBool \fBgetIsBuiltIn\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetFieldsMemorySize\fP (size_t &\fBmanaged\fP, size_t &\fBunmanaged\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetUserData\fP (\fBvoid\fP *userdata) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP * \fBgetUserData\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBref\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBunref\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBunrefNoDelete\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int32_t \fBgetRefCount\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBtouch\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP"
.br
.RI "Returns \fCTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. "
.ti -1c
.RI "\fBvirtual\fP \fBSbName\fP \fBgetName\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetName\fP (\fBconst\fP \fBSbName\fP &\fBnewname\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBaddAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBconst\fP \fBSoAuditorList\fP & \fBgetAuditors\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBassertAlive\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetSubdirectories\fP (\fBconst\fP \fBSbList\fP< \fBSbString\fP > &subdirectories)"
.br
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSbStringList\fP & \fBgetSubdirectories\fP ()"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetDefaultPauseBetweenTracks\fP (\fBSbTime\fP pause)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSbTime\fP \fBgetDefaultPauseBetweenTracks\fP ()"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetDefaultIntroPause\fP (\fBSbTime\fP pause)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSbTime\fP \fBgetDefaultIntroPause\fP ()"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetDefaultSampleRate\fP (int \fBsamplerate\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetDefaultSampleRate\fP ()"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetDefaultTimerInterval\fP (\fBSbTime\fP interval)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSbTime\fP \fBgetDefaultTimerInterval\fP ()"
.br
.in -1c

Static Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP uint32_t \fBgetCompatibilityTypes\fP (\fBconst\fP \fBSoType\fP &nodetype)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoNode\fP * \fBgetByName\fP (\fBconst\fP \fBSbName\fP &name)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetByName\fP (\fBconst\fP \fBSbName\fP &name, \fBSoNodeList\fP &\fBl\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbUniqueId \fBgetNextNodeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetActionMethodIndex\fP (\fBconst\fP \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetBoundingBoxS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBGLRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcallbackS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetMatrixS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBhandleEventS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBpickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBrayPickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsearchS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBwriteS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaudioRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetPrimitiveCountS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcleanupClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitCopyDict\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP, \fBconst\fP \fBSoFieldContainer\fP *copy)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoFieldContainer\fP * \fBcheckCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoFieldContainer\fP * \fBfindCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP, \fBconst\fP SbBool \fBcopyconnections\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcopyDone\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. "
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBremoveName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBincrementCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBdecrementCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoBase\fP * \fBgetNamedBase\fP (\fBconst\fP \fBSbName\fP &name, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNamedBases\fP (\fBconst\fP \fBSbName\fP &name, \fBSoBaseList\fP &\fBbaselist\fP, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP \fBexpectedtype\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetInstancePrefix\fP (\fBconst\fP \fBSbString\fP &c)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetTraceRefs\fP (SbBool \fBtrace\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBgetTraceRefs\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, \fBconst\fP \fBSbName\fP &\fBfromnodename\fP, \fBconst\fP \fBSbName\fP &\fBfromfieldname\fP, \fBconst\fP \fBSbName\fP &\fBtonodename\fP, \fBconst\fP \fBSbName\fP &\fBtofieldname\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBreadRoute\fP (\fBSoInput\fP *input)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBSoSFString\fP \fBdescription\fP"
.br
.ti -1c
.RI "\fBSoSFBool\fP \fBloop\fP"
.br
.ti -1c
.RI "\fBSoSFFloat\fP \fBpitch\fP"
.br
.ti -1c
.RI "\fBSoSFTime\fP \fBstartTime\fP"
.br
.ti -1c
.RI "\fBSoSFTime\fP \fBstopTime\fP"
.br
.ti -1c
.RI "\fBSoMFString\fP \fBurl\fP"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP \fBSoFieldData\fP * \fBgetFieldData\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoVRMLAudioClip\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBSoNode\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoNode\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreadInstance\fP (\fBSoInput\fP *\fBin\fP, \fBunsigned\fP short flags)"
.br
.in -1c

Protected Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBSoFieldContainer\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoFieldContainer\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBSoBase\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoBase\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBdestroy\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBhasMultipleWriteRefs\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisgroup\fP, SbBool \fBisengine\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwriteFooter\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP char * \fBgetFileFormatName\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNotRec\fP \fBcreateNotRec\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetNextActionMethodIndex\fP (int index)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNextActionMethodIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBincNextActionMethodIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetCompatibilityTypes\fP (\fBconst\fP \fBSoType\fP &nodetype, \fBconst\fP uint32_t \fBbitmask\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP uint32_t \fBgetCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBstaticDataLock\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBstaticDataUnlock\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSoSFTime\fP \fBduration_changed\fP"
.br
.ti -1c
.RI "\fBSoSFBool\fP \fBisActive\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBuniqueId\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "SbBool \fBisBuiltIn\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Types inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "enum \fBBaseFlags\fP { \fBIS_ENGINE\fP = 0x01, \fBIS_GROUP\fP = 0x02 }"
.br
.in -1c

Static Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP SbUniqueId \fBnextUniqueId\fP = 1"
.br
.ti -1c
.RI "\fBstatic\fP int \fBnextActionMethodIndex\fP = 0"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoVRMLAudioClip\fP class is used to load and store audio data\&. 

Audio data is loaded using the simage library, so make sure you have built the simage library with support for the audio file formats you intend to use (libogg, libvorbis and libvorbisfile for OggVorbis, libsndfile for WAV and several other formats)\&.
.PP
\fBThe detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997)\&. It is copyright The Web3D Consortium, and is used by permission of the Consortium:\fP
.br

.br
 
.PP
.nf
AudioClip {
  exposedField   SFString description      ''
  exposedField   SFBool   loop             FALSE
  exposedField   SFFloat  pitch            1\&.0        # (0, inf)
  exposedField   SFTime   startTime        0          # (-inf, inf)
  exposedField   SFTime   stopTime         0          # (-inf, inf)
  exposedField   MFString url              []
  eventOut       SFTime   duration_changed
  eventOut       SFBool   isActive
}

.fi
.PP
.PP
An AudioClip node specifies audio data that can be referenced by Sound nodes\&. The description field specifies 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 playing the sound\&. The url field specifies the URL from which the sound is loaded\&. Browsers shall support at least the wavefile format in uncompressed PCM format (see http://www.web3d.org/documents/specifications/14772/V2.0/part1/bibliography.html#[WAV])\&. It is recommended that browsers also support the MIDI file type 1 sound format (see http://www.web3d.org/documents/specifications/14772/V2.0/part1/references.html#[MIDI]); MIDI files are presumed to use the General MIDI patch set\&. Subclause \fB4\&.5\fP, VRML and the World Wide Web (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.5), contains details on the url field\&. The results are undefined when no URLs refer to supported data types\&.
.PP
The loop, startTime, and stopTime exposedFields and the isActive eventOut, and their effects on the AudioClip node, are discussed in detail in 4\&.6\&.9, Time-dependent nodes (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.9)\&. The 'cycle' of an AudioClip 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\&. Values for the pitch field shall be greater than zero\&. Changing the pitch field affects both the pitch and playback speed of a sound\&. A set_pitch event to an active AudioClip is ignored and no pitch_changed eventOut is generated\&. If pitch is set to \fB2\&.0\fP, the sound shall 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 pitch control for MIDI (or other note sequence sound clips) 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\&. 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 have 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 \fB1\&.0\fP\&. Changing the pitch field will not trigger a duration_changed event\&. A duration value of '-1' implies that the sound data have not yet loaded or the value is unavailable for some reason\&. A duration_changed event shall be generated if the AudioClip node is loaded when the VRML file is read or the AudioClip node is added to the scene graph\&. The isActive eventOut may be used by other nodes to determine if the clip is currently active\&. If an AudioClip is active, it shall be playing the sound corresponding to the sound time (i\&.e\&., in the sound's local time system with sample 0 at time 0): 
.PP
.nf
t = (now - startTime) modulo (duration / pitch)

.fi
.PP
 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoVRMLAudioClip::SoVRMLAudioClip (\fBvoid\fP)"
Constructor\&. 
.SS "SoVRMLAudioClip::~SoVRMLAudioClip ()\fC [protected]\fP, \fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoVRMLAudioClip::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoVRMLAudioClip::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Implements \fBSoBase\fP\&.
.SS "\fBconst\fP \fBSoFieldData\fP ** SoVRMLAudioClip::getFieldDataPtr (\fBvoid\fP)\fC [static]\fP, \fC [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Returns the \fBSoFieldData\fP class which holds information about fields in this node\&. 
.br
 
.SS "\fBconst\fP \fBSoFieldData\fP * SoVRMLAudioClip::getFieldData (\fBvoid\fP) const\fC [protected]\fP, \fC [virtual]\fP"
Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. 
.PP
Reimplemented from \fBSoFieldContainer\fP\&.
.SS "\fBvoid\fP SoVRMLAudioClip::initClass (\fBvoid\fP)\fC [static]\fP"

.SS "\fBvoid\fP * SoVRMLAudioClip::open (\fBconst\fP \fBSbStringList\fP & urlref)"
Opens an audio source with the given \fIurl\fP\&. Returns a handle to the datasource\&. 
.br
 
.SS "size_t SoVRMLAudioClip::read (\fBvoid\fP * datasource, \fBvoid\fP * buffer, int numframes, int & channels)"
Reads \fInumframes\fP frames of audio with \fIchannels\fP channels from \fIdatasource\fP into \fIbuffer\fP\&. Buffer must be allocated by the caller, and must be able to hold all the audio data (size = \fInumframes\fP * \fIchannels\fP * sizeof(int16_t))\&. The function must always fill the buffer completely unless \fIbuffer\fP == NULL\&.
.PP
When an error occurs, or when end-of-file has been reached, this function returns 0\&. Otherwise, the function should return \fInumframes\fP\&.
.PP
When the caller receives a return value of 0, it will queue the returned buffer for playing\&. When this buffer is finished playing, the caller will call \fBread()\fP one final time, with \fIbuffer\fP == NULL\&. The \fBread()\fP function can then set the isActive field to FALSE, free any resources allocated, etc\&. 
.SS "int SoVRMLAudioClip::seek (\fBvoid\fP * datasource, \fBlong\fP offset, int whence)"
Moves the 'filepointer' in the \fIdatasource\fP, returns -1L on error\&. 
.br
 
.SS "\fBlong\fP SoVRMLAudioClip::tell (\fBvoid\fP * datasource)"
Returns the current position of the 'filepointer' in the \fIdatasource\fP, or -1L on error\&. 
.br
 
.SS "int SoVRMLAudioClip::close (\fBvoid\fP * datasource)"
Closes \fIdatasource\fP\&. 
.SS "\fBvoid\fP SoVRMLAudioClip::setCallbacks (open_func * opencb, read_func * readcb, seek_func * seekcb, tell_func * tellcb, close_func * closecb, \fBvoid\fP * userdataptr)"
Sets callbacks for opening, reading, seeking, telling and closing an audio source\&. Specifying NULL for a function is OK, except for the read function\&. If a function set to NULL is later called, a default implementation doing nothing is called in its place\&. 
.SH "Member Data Documentation"
.PP 
.SS "\fBSoSFString\fP SoVRMLAudioClip::description"
Description of the audio clip\&. Default value is an empty string\&. 
.SS "\fBSoSFBool\fP SoVRMLAudioClip::loop"
Specifies whether sound should be looped\&. Is FALSE by default\&. 
.SS "\fBSoSFFloat\fP SoVRMLAudioClip::pitch"
Specifies the pitch\&. The default value is \fB1\&.0\fP\&.
.PP
Alters the sampling rate at which the sound is played\&. A pitch of \fB2\&.0\fP means that the sound should be played twice as fast and one octave higher than normal\&. 
.SS "\fBSoSFTime\fP SoVRMLAudioClip::startTime"
Specifies the start time\&. Default value is 0\&. 
.SS "\fBSoSFTime\fP SoVRMLAudioClip::stopTime"
Specifies the stop time\&. Default value is 0\&. 
.SS "\fBSoMFString\fP SoVRMLAudioClip::url"
The audio data URL\&. 
.SS "SoVRMLAudioClip::duration_changed\fC [protected]\fP"
An eventOut sent when a new sound starts playing\&. 
.SS "SoVRMLAudioClip::isActive\fC [protected]\fP"
This eventOut is sent when the sound starts/stops playing\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.