Skylicht Engine
Loading...
Searching...
No Matches
Skylicht::Audio::CFileStream Class Reference

Standard file stream implementation using C stdio (fopen). More...

#include <Stream/CFileStream.h>

Inheritance diagram for Skylicht::Audio::CFileStream:
Skylicht::Audio::IStream

Public Member Functions

 CFileStream (const char *fileName)
bool isError ()
 Check if the file failed to open.
virtual IStreamCursorcreateCursor ()
 Create a new file cursor.
Public Member Functions inherited from Skylicht::Audio::IStream
virtual void grab ()
 Increment reference count.
virtual bool drop ()
 Decrement reference count and delete if zero.
int getSampleRate ()
 Get expected sample rate (for recorder/procedural streams).
int getChannels ()
 Get number of channels (for recorder/procedural streams).
void setStreamAudio (int sampleRate, int channels)
 Set stream audio properties.
virtual void uploadData (unsigned char *buffer, int size)
 Upload new data to the stream (used in online/dynamic streams).
virtual void stopStream ()
 Stop the stream and clear buffers.

Protected Attributes

std::string m_fileName
FILE * m_file
int m_size
Protected Attributes inherited from Skylicht::Audio::IStream
int m_referenceCount
int m_sampleRate
int m_channels

Detailed Description

Standard file stream implementation using C stdio (fopen).

Member Function Documentation

◆ createCursor()

virtual IStreamCursor * Skylicht::Audio::CFileStream::createCursor ( )
virtual

Create a new file cursor.

Returns
Pointer to CFileStreamCursor

Implements Skylicht::Audio::IStream.

◆ isError()

bool Skylicht::Audio::CFileStream::isError ( )

Check if the file failed to open.

Returns
True if error

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