Tanoda
NatSuite.Recorders.WAVRecorder Class Reference

Waveform audio recorder. More...

Inheritance diagram for NatSuite.Recorders.WAVRecorder:
NatSuite.Recorders.IMediaRecorder

Public Member Functions

 WAVRecorder (int sampleRate, int channelCount)
 Create an WAV recorder. More...
 
void CommitFrame< T > (T[] pixelBuffer=default, long timestamp=default)
 This recorder does not support committing pixel buffers. More...
 
void CommitFrame (IntPtr nativeBuffer=default, long timestamp=default)
 This recorder does not support committing pixel buffers. More...
 
void CommitSamples (float[] sampleBuffer, long timestamp=default)
 Commit an audio sample buffer for encoding. More...
 
Task< string > FinishWriting ()
 Finish writing and return the path to the recorded media file. More...
 
void CommitFrame< T > (T[] pixelBuffer, long timestamp)
 Commit a video pixel buffer for encoding. The pixel buffer MUST have an RGBA8888 pixel layout. More...
 
void CommitFrame (IntPtr nativeBuffer, long timestamp)
 Commit a video pixel buffer for encoding. The pixel buffer MUST have an RGBA8888 pixel layout. More...
 
void CommitSamples (float[] sampleBuffer, long timestamp)
 Commit an audio sample buffer for encoding. More...
 
Task< string > FinishWriting ()
 Finish writing and return the path to the recorded media file. More...
 

Public Attributes

int width
 Not supported. More...
 
- Public Attributes inherited from NatSuite.Recorders.IMediaRecorder
int width
 Recording frame size. More...
 

Properties

int int height frameSize [get]
 
- Properties inherited from NatSuite.Recorders.IMediaRecorder
int int height frameSize [get]
 

Detailed Description

Waveform audio recorder.

Definition at line 16 of file WAVRecorder.cs.

Constructor & Destructor Documentation

◆ WAVRecorder()

NatSuite.Recorders.WAVRecorder.WAVRecorder ( int  sampleRate,
int  channelCount 
)

Create an WAV recorder.

Parameters
sampleRateAudio sample rate.
channelCountAudio channel count.

Definition at line 30 of file WAVRecorder.cs.

Member Function Documentation

◆ CommitFrame()

void NatSuite.Recorders.WAVRecorder.CommitFrame ( IntPtr  nativeBuffer = default,
long  timestamp = default 
)

This recorder does not support committing pixel buffers.

Implements NatSuite.Recorders.IMediaRecorder.

Definition at line 51 of file WAVRecorder.cs.

◆ CommitFrame< T >()

void NatSuite.Recorders.WAVRecorder.CommitFrame< T > ( T[]  pixelBuffer = default,
long  timestamp = default 
)

This recorder does not support committing pixel buffers.

Implements NatSuite.Recorders.IMediaRecorder.

Type Constraints
T :struct 

Definition at line 44 of file WAVRecorder.cs.

◆ CommitSamples()

void NatSuite.Recorders.WAVRecorder.CommitSamples ( float[]  sampleBuffer,
long  timestamp = default 
)

Commit an audio sample buffer for encoding.

Parameters
sampleBufferLinear PCM audio sample buffer, interleaved by channel.
timestampNot used.

Implements NatSuite.Recorders.IMediaRecorder.

Definition at line 60 of file WAVRecorder.cs.

◆ FinishWriting()

Task< string > NatSuite.Recorders.WAVRecorder.FinishWriting ( )

Finish writing and return the path to the recorded media file.

Implements NatSuite.Recorders.IMediaRecorder.

Definition at line 76 of file WAVRecorder.cs.

Member Data Documentation

◆ width

int NatSuite.Recorders.WAVRecorder.width

Not supported.

Definition at line 23 of file WAVRecorder.cs.

Property Documentation

◆ frameSize

int int height NatSuite.Recorders.WAVRecorder.frameSize
get

Implements NatSuite.Recorders.IMediaRecorder.

Definition at line 23 of file WAVRecorder.cs.


The documentation for this class was generated from the following file: