Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: devvideobase.h
Link against: devvideo.lib

This item is not part of the S60 3rd Edition SDK for Symbian OS, Feature Pack 2.

Class CCompressedVideoFormat

class CCompressedVideoFormat : public CBase;

Description

Defines a compressed video format. The format is identified by its MIME type, which may include parameters that describe the used format profile and level. The MIME type used for H.263 is video/H263-2000, specified in TS 26.234, and the type for MPEG-4 is video/MP4V-ES, specified in RFC 3016.

Derivation

Members

Defined in CCompressedVideoFormat:
MimeType(), NewL(), NewL(), OptionalData(), operator==(), ~CCompressedVideoFormat()

Inherited from CBase:
Delete(), Extension_(), operator new()


Construction and destruction


NewL()

static IMPORT_C CCompressedVideoFormat *NewL(const TDesC8 &aMimeType, const TDesC8 &aOptionalData=KNullDesC8);

Description

Static factory function for creating new CCompressedVideoFormat objects.

Parameters

const TDesC8 &aMimeType

"Video codec MIME type, including optional parameters for profile, level and version information. The CCompressedVideoFormat object creates and owns a copy of this buffer and takes care of deallocation."

const TDesC8 &aOptionalData

"Reference to a descriptor that contains optional codec-specific data. Set to KNullDesC8 if not used. [The format of the data is codec-specific, typically a package buffer containing a data structure may be used. The pointer lifetime and validity requirements are specified with each method that uses this structure."

Return value

CCompressedVideoFormat *

"Pointer to a fully constructed CCompressedVideoFormat object."

Leave codes

"This

method may leave with one of the system-wide error codes."


NewL()

static IMPORT_C CCompressedVideoFormat *NewL(const CCompressedVideoFormat &aFormat);

Description

Static factory function for creating a copy of an existing CCompressedVideoFormat object.

Parameters

const CCompressedVideoFormat &aFormat

"The CCompressedVideoFormat object to copy."

Return value

CCompressedVideoFormat *

Pointer to a fully constructed CCompressedVideoFormat object.

Leave codes

This

method may leave with one of the system-wide error codes.


~CCompressedVideoFormat()

virtual IMPORT_C ~CCompressedVideoFormat();

Description

Virtual destructor. Destroys iMimeType.

[Top]


Member functions


MimeType()

IMPORT_C const TDesC8 &MimeType() const;

Description

Returns the video codec MIME type.

Return value

const TDesC8 &

"Reference to a descriptor that contains the video codec MIME type."


OptionalData()

IMPORT_C const TDesC8 &OptionalData() const;

Description

Returns the optional data.

Return value

const TDesC8 &

"Reference to a descriptor that contains optional codec-specific data. Zero length if not used. The format of the data is codec-specific, typically a package buffer containing a data structure may be used."


operator==()

IMPORT_C TBool operator==(const CCompressedVideoFormat &aOther) const;

Description

Tests whether this CCompressedVideoFormat is identical to aOther or not.

Parameters

const CCompressedVideoFormat &aOther

Return value

TBool

"ETrue if the two objects are identical, EFalse if not."