Symbian^3 Application Developer Library >

CMMFClip Class Reference

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).

Inherits from

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 )
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()

Constructor & Destructor Documentation

CMMFClip(TUid, TUid)

CMMFClip ( TUid aSourceType,
TUid aSinkType
) [protected, inline]

Protected constructor.

Parameters

TUid aSourceType The source type.
TUid aSinkType The sink type.

Member Functions Documentation

BytesFree()

TInt64 BytesFree ( ) [pure virtual]

Returns the amount of space available for the clip.

This is a virtual function that each derived class must implement.

Delete()

TInt Delete ( ) [inline, virtual]

Deletes the clip.

This should be overriden in the derived classes, the default version returns KErrNotSupported.

ReadBufferL(TInt, CMMFBuffer *, TInt, MDataSink *)

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.

Parameters

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.

ReadBufferL(CMMFBuffer *, TInt, MDataSink *)

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.

Parameters

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.

ReadBufferL(CMMFBuffer *, TInt)

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.

Parameters

CMMFBuffer * aBuffer The buffer to read the data into.
TInt aPosition The offset from which to start reading.

SetSize(TInt)

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.

Parameters

TInt aSize The size of the clip.

Size()

TInt Size ( ) [pure virtual]

Returns the size of the clip in bytes.

This is a virtual function that each derived class must implement.

WriteBufferL(TInt, CMMFBuffer *, TInt, MDataSource *)

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.

Parameters

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.

WriteBufferL(CMMFBuffer *, TInt, MDataSource *)

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.

Parameters

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.

WriteBufferL(CMMFBuffer *, TInt)

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.

Parameters

CMMFBuffer * aBuffer The buffer to write the data into.
TInt aPosition The offset from which to start writing.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.