H3D API  2.4.1
H3DSoundStreamNode.h
Go to the documentation of this file.
1 // Copyright 2004-2019, SenseGraphics AB
3 //
4 // This file is part of H3D API.
5 //
6 // H3D API is free software; you can redistribute it and/or modify
7 // it under the terms of the GNU General Public License as published by
8 // the Free Software Foundation; either version 2 of the License, or
9 // (at your option) any later version.
10 //
11 // H3D API is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
15 //
16 // You should have received a copy of the GNU General Public License
17 // along with H3D API; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 //
20 // A commercial license is also available. Please contact us at
21 // www.sensegraphics.com for more information.
22 //
23 //
27 //
29 #ifndef __H3DSOUNDSTREAMNODE_H__
30 #define __H3DSOUNDSTREAMNODE_H__
31 
32 #include <H3D/Node.h>
33 
34 namespace H3D {
35 
42  class H3DAPI_API H3DSoundStreamNode : public Node {
43  public:
44 
46  virtual void reset() = 0;
47 
52  virtual unsigned int read( char *buffer, unsigned int size ) = 0;
53 
55  virtual unsigned int bitsPerSample() = 0;
56 
59  virtual unsigned int samplesPerSecond() = 0;
60 
63  virtual unsigned int nrChannels() = 0;
64 
66  virtual unsigned int totalDataSize() = 0;
67 
69  virtual H3DTime duration() = 0;
70  };
71 }
72 
73 #endif
Node base class.
This abstract node type is used to derive node types that can stream PCM sound data.
Definition: H3DSoundStreamNode.h:42
virtual unsigned int read(char *buffer, unsigned int size)=0
Read PCM data from the stream into the buffer.
virtual unsigned int samplesPerSecond()=0
Returns the number of samples per second for the current PCM data stream.
virtual H3DTime duration()=0
The duration in seconds for the the PCM data.
virtual unsigned int bitsPerSample()=0
Returns the number of bits for a sample.
virtual void reset()=0
Reset the stream to the beginning of the sound stream.
virtual unsigned int totalDataSize()=0
Returns the total size of the PCM data of the current stream.
virtual unsigned int nrChannels()=0
Returns the number of channels per second for the current PCM data stream.
Node is the base class for all classes that can be part of the H3D scene-graph.
Definition: Node.h:46
double H3DTime
H3D API namespace.
Definition: Anchor.h:38