Bento4 MP4 SDK: AP4_FileByteStream Class Reference

Bento4 MP4 SDK

previous page next page

AP4_FileByteStream Class Reference

#include <Ap4FileByteStream.h>

Inheritance diagram for AP4_FileByteStream:
AP4_ByteStream AP4_Referenceable

List of all members.

Public Types

enum  Mode {
  STREAM_MODE_READ = 0,
  STREAM_MODE_WRITE = 1,
  STREAM_MODE_READ_WRITE = 2
}

Public Member Functions

 AP4_FileByteStream (AP4_ByteStream *delegate)
 AP4_FileByteStream (const char *name, Mode mode)
AP4_Result ReadPartial (void *buffer, AP4_Size bytesToRead, AP4_Size &bytesRead)
AP4_Result WritePartial (const void *buffer, AP4_Size bytesToWrite, AP4_Size &bytesWritten)
AP4_Result Seek (AP4_Position position)
AP4_Result Tell (AP4_Position &position)
AP4_Result GetSize (AP4_LargeSize &size)
AP4_Result Flush ()
void AddReference ()
void Release ()

Static Public Member Functions

static AP4_Result Create (const char *name, Mode mode, AP4_ByteStream *&stream)
 Create a stream from a file (opened or created).

Protected Member Functions

virtual ~AP4_FileByteStream ()

Protected Attributes

AP4_ByteStream * m_Delegate

Detailed Description

Definition at line 42 of file Ap4FileByteStream.h.

Member Enumeration Documentation

enum AP4_FileByteStream::Mode
Enumerator:
STREAM_MODE_READ 
STREAM_MODE_WRITE 
STREAM_MODE_READ_WRITE 

Definition at line 46 of file Ap4FileByteStream.h.

Constructor & Destructor Documentation

AP4_FileByteStream::AP4_FileByteStream ( AP4_ByteStream *  delegate  )  [inline]

Definition at line 65 of file Ap4FileByteStream.h.

AP4_FileByteStream::AP4_FileByteStream ( const char *  name,
Mode  mode 
)
Deprecated:
virtual AP4_FileByteStream::~AP4_FileByteStream (  )  [inline, protected, virtual]

Definition at line 96 of file Ap4FileByteStream.h.

References m_Delegate.

Member Function Documentation

void AP4_FileByteStream::AddReference (  )  [inline, virtual]

Implements AP4_Referenceable.

Definition at line 91 of file Ap4FileByteStream.h.

References AP4_Referenceable::AddReference(), and m_Delegate.

static AP4_Result AP4_FileByteStream::Create ( const char *  name,
Mode  mode,
AP4_ByteStream *&  stream 
) [static]

Create a stream from a file (opened or created).

Parameters:
name Name of the file open or create
mode Mode to use for the file
stream Refrence to a pointer where the stream object will be returned
Returns:
AP4_SUCCESS if the file can be opened or created, or an error code if it cannot
AP4_Result AP4_FileByteStream::Flush (  )  [inline, virtual]

Reimplemented from AP4_ByteStream.

Definition at line 88 of file Ap4FileByteStream.h.

References AP4_ByteStream::Flush(), and m_Delegate.

AP4_Result AP4_FileByteStream::GetSize ( AP4_LargeSize &  size  )  [inline, virtual]

Implements AP4_ByteStream.

Definition at line 87 of file Ap4FileByteStream.h.

References AP4_ByteStream::GetSize(), and m_Delegate.

AP4_Result AP4_FileByteStream::ReadPartial ( void *  buffer,
AP4_Size  bytesToRead,
AP4_Size &  bytesRead 
) [inline, virtual]

Implements AP4_ByteStream.

Definition at line 75 of file Ap4FileByteStream.h.

References m_Delegate, and AP4_ByteStream::ReadPartial().

void AP4_FileByteStream::Release (  )  [inline, virtual]

Implements AP4_Referenceable.

Definition at line 92 of file Ap4FileByteStream.h.

References m_Delegate, and AP4_Referenceable::Release().

AP4_Result AP4_FileByteStream::Seek ( AP4_Position  position  )  [inline, virtual]

Implements AP4_ByteStream.

Definition at line 85 of file Ap4FileByteStream.h.

References m_Delegate, and AP4_ByteStream::Seek().

AP4_Result AP4_FileByteStream::Tell ( AP4_Position &  position  )  [inline, virtual]

Implements AP4_ByteStream.

Definition at line 86 of file Ap4FileByteStream.h.

References m_Delegate, and AP4_ByteStream::Tell().

AP4_Result AP4_FileByteStream::WritePartial ( const void *  buffer,
AP4_Size  bytesToWrite,
AP4_Size &  bytesWritten 
) [inline, virtual]

Implements AP4_ByteStream.

Definition at line 80 of file Ap4FileByteStream.h.

References m_Delegate, and AP4_ByteStream::WritePartial().

Member Data Documentation

AP4_ByteStream* AP4_FileByteStream::m_Delegate [protected]

Definition at line 101 of file Ap4FileByteStream.h.

Referenced by AddReference(), Flush(), GetSize(), ReadPartial(), Release(), Seek(), Tell(), WritePartial(), and ~AP4_FileByteStream().

The documentation for this class was generated from the following file:
Generated on Thu May 13 16:37:18 2010 for Bento4 MP4 SDK by  doxygen 1.6.3
previous page start next page