class CMMFClip : public CBase |
Abstract class to represent a source or sink that contains a multimedia clip (i.e. not a stream or hardware device).
Typical examples are a file or an area of memory (descriptor).
Public Member Functions | |
---|---|
TInt64 | BytesFree() |
TInt | Delete() |
void | ReadBufferL(TInt, CMMFBuffer *, TInt, MDataSink *) |
void | ReadBufferL(CMMFBuffer *, TInt, MDataSink *) |
void | ReadBufferL(CMMFBuffer *, TInt) |
TInt | SetSize(TInt) |
TInt | Size() |
void | WriteBufferL(TInt, CMMFBuffer *, TInt, MDataSource *) |
void | WriteBufferL(CMMFBuffer *, TInt, MDataSource *) |
void | WriteBufferL(CMMFBuffer *, TInt) |
Protected Member Functions | |
---|---|
CMMFClip(TUid, TUid) |
CMMFClip | ( | TUid | aSourceType, |
TUid | aSinkType | ||
) | [protected, inline] |
Protected constructor.
TInt64 | BytesFree | ( | ) | [pure virtual] |
Returns the amount of space available for the clip.
This is a virtual function that each derived class must implement.
The amount of space available.
TInt | Delete | ( | ) | [inline, virtual] |
Deletes the clip.
This should be overriden in the derived classes, the default version returns KErrNotSupported.
An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.
void | ReadBufferL | ( | TInt | aLength, |
CMMFBuffer * | aBuffer, | |||
TInt | aPosition, | |||
MDataSink * | aConsumer | |||
) | [pure virtual] |
Reads aLength number of bytes of data from the offset, aPosition into the buffer, aBuffer. Intended for asynchronous usage.
This is a virtual function that each derived class must implement.
TInt aLength | The number of bytes to read. |
CMMFBuffer * aBuffer | The buffer to read the data into. |
TInt aPosition | The offset from which to start reading. |
MDataSink * aConsumer | The sink of tha data read from the clip. Will be informed of read if not NULL. |
void | ReadBufferL | ( | CMMFBuffer * | aBuffer, |
TInt | aPosition, | |||
MDataSink * | aConsumer | |||
) | [pure virtual] |
Reads the maximum number of bytes of data from the offset, aPosition into the buffer, aBuffer. Intended for asynchronous usage.
This is a virtual function that each derived class must implement.
CMMFBuffer * aBuffer | The buffer to read the data into. |
TInt aPosition | The offset from which to start reading. |
MDataSink * aConsumer | The sink of tha data read from the clip. Will be informed of read if not NULL. |
void | ReadBufferL | ( | CMMFBuffer * | aBuffer, |
TInt | aPosition | |||
) | [pure virtual] |
Reads the maximum number of bytes of data from the offset, aPosition into the buffer, aBuffer. Intended for synchronous usage.
This is a virtual function that each derived class must implement.
CMMFBuffer * aBuffer | The buffer to read the data into. |
TInt aPosition | The offset from which to start reading. |
TInt | SetSize | ( | TInt | aSize | ) | [inline, virtual] |
Sets the size of the clip. This should be overriden in the derived classes, the default version returns KErrNotSupported.
An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.
TInt aSize | The size of the clip. |
TInt | Size | ( | ) | [pure virtual] |
Returns the size of the clip in bytes.
This is a virtual function that each derived class must implement.
The size of the clip.
void | WriteBufferL | ( | TInt | aLength, |
CMMFBuffer * | aBuffer, | |||
TInt | aPosition, | |||
MDataSource * | aSupplier | |||
) | [pure virtual] |
Writes aLength number of bytes of data from the offset, aPosition from the buffer, aBuffer. Intended for asynchronous usage.
This is a virtual function that each derived class must implement.
TInt aLength | The number of bytes to write. |
CMMFBuffer * aBuffer | The buffer to write the data into. |
TInt aPosition | The offset from which to start writing. |
MDataSource * aSupplier | The source of the data writen to the clip. Will be informed of write if not NULL. |
void | WriteBufferL | ( | CMMFBuffer * | aBuffer, |
TInt | aPosition, | |||
MDataSource * | aSupplier | |||
) | [pure virtual] |
Writes the maximum number of bytes of data from the offset, aPosition from the buffer, aBuffer. Intended for asynchronous usage.
This is a virtual function that each derived class must implement.
CMMFBuffer * aBuffer | The buffer to write the data into. |
TInt aPosition | The offset from which to start writing. |
MDataSource * aSupplier | The source of the data writen to the clip. Will be informed of write if not NULL. |
void | WriteBufferL | ( | CMMFBuffer * | aBuffer, |
TInt | aPosition | |||
) | [pure virtual] |
Writes the maximum number of bytes of data from the offset, aPosition from the buffer, aBuffer. Intended for synchronous usage.
This is a virtual function that each derived class must implement.
CMMFBuffer * aBuffer | The buffer to write the data into. |
TInt aPosition | The offset from which to start writing. |