Tanoda
NatSuite.Recorders.JPGRecorder Class Reference

JPG image sequence recorder. This recorder is currently supported on macOS and Windows. This recorder is NOT thread-safe, and as such it is not fully compliant with the IMediaRecorder interfacex. More...

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

Public Member Functions

 JPGRecorder (int imageWidth, int imageHeight)
 Create a JPG recorder. More...
 
void CommitFrame< T > (T[] pixelBuffer, long timestamp=default)
 Commit a video pixel buffer for encoding. The pixel buffer MUST have an RGBA8888 pixel layout. More...
 
void CommitFrame (IntPtr nativeBuffer, long timestamp=default)
 Commit a video pixel buffer for encoding. The pixel buffer MUST have an RGBA8888 pixel layout. More...
 
void CommitSamples (float[] sampleBuffer=default, long timestamp=default)
 This recorder does not support committing audio samples. 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
 Image size. 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

JPG image sequence recorder. This recorder is currently supported on macOS and Windows. This recorder is NOT thread-safe, and as such it is not fully compliant with the IMediaRecorder interfacex.

Definition at line 21 of file JPGRecorder.cs.

Constructor & Destructor Documentation

◆ JPGRecorder()

NatSuite.Recorders.JPGRecorder.JPGRecorder ( int  imageWidth,
int  imageHeight 
)

Create a JPG recorder.

Parameters
imageWidthImage width.
imageHeightImage height.

Definition at line 35 of file JPGRecorder.cs.

Member Function Documentation

◆ CommitFrame()

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

Commit a video pixel buffer for encoding. The pixel buffer MUST have an RGBA8888 pixel layout.

Parameters
nativeBufferPixel buffer in native memory to commit.
timestampNot used.

Implements NatSuite.Recorders.IMediaRecorder.

Definition at line 64 of file JPGRecorder.cs.

◆ CommitFrame< T >()

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

Commit a video pixel buffer for encoding. The pixel buffer MUST have an RGBA8888 pixel layout.

Parameters
pixelBufferPixel buffer containing video frame to commit.
timestampNot used.

Implements NatSuite.Recorders.IMediaRecorder.

Type Constraints
T :struct 

Definition at line 51 of file JPGRecorder.cs.

◆ CommitSamples()

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

This recorder does not support committing audio samples.

Implements NatSuite.Recorders.IMediaRecorder.

Definition at line 78 of file JPGRecorder.cs.

◆ FinishWriting()

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

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

Implements NatSuite.Recorders.IMediaRecorder.

Definition at line 85 of file JPGRecorder.cs.

Member Data Documentation

◆ width

int NatSuite.Recorders.JPGRecorder.width

Image size.

Definition at line 28 of file JPGRecorder.cs.

Property Documentation

◆ frameSize

int int height NatSuite.Recorders.JPGRecorder.frameSize
get

Implements NatSuite.Recorders.IMediaRecorder.

Definition at line 28 of file JPGRecorder.cs.


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