Collapse all Symbian^3 Product Developer Library

CAVCFrame Class Reference

class CAVCFrame : public CBase

AVC frame creation and utilities.

Inherits from

CAVCFrame
- CBase

Public Member Functions
	~CAVCFrame()
IMPORT_C void	Append(const TDesC8 &)
IMPORT_C void	Append(TChar)
IMPORT_C TInt	ButtonAct(AVCPanel::TButtonAction &)
IMPORT_C const TDesC8 &	Data()
IMPORT_C TInt	DataLength()
IMPORT_C AVC::TFrameType	FrameType()
IMPORT_C AVC::TFrameType	FrameType(const TDesC8 &)
IMPORT_C CAVCFrame *	NewL(AVC::TFrameType, AVC::TCType, AVC::TSubunitType, AVC::TSubunitID)
IMPORT_C CAVCFrame *	NewL(const TDesC8 &, AVC::TFrameType)
IMPORT_C TUint8	Opcode()
IMPORT_C AVC::TOpcode	OpcodeL(const TDesC8 &)
IMPORT_C TInt	OperationId(TUint8 &)
IMPORT_C void	SetFrameType(AVC::TFrameType)
IMPORT_C void	SetType(AVC::TCType)
IMPORT_C AVC::TSubunitID	SubunitID()
IMPORT_C AVC::TSubunitType	SubunitType()
IMPORT_C AVC::TCType	Type()
IMPORT_C const TUint8 &	operator[](TInt)

Private Member Functions
	CAVCFrame(AVC::TFrameType)
void	ConstructL(AVC::TCType, AVC::TSubunitType, AVC::TSubunitID)
void	ConstructL(const TDesC8 &)
void	FindExtensionL(const TDesC8 &, TInt &, TInt &)

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

Private Attributes
RBuf8	iBuffer
AVC::TFrameType	iFrameType
TInt	iSubunitIDExtensionBytes
TInt	iSubunitTypeExtensionBytes

Constructor & Destructor Documentation

CAVCFrame(AVC::TFrameType)

CAVCFrame

(

AVC::TFrameType

aFrameType

)

[private]

Constructor.

Parameters

AVC::TFrameType aFrameType

ECommand if this is a command, EResponse if it's a response.

~CAVCFrame()

IMPORT_C

~CAVCFrame

(

)

[virtual]

Destructor.

Member Functions Documentation

Append(const TDesC8 &)

IMPORT_C void

Append

(

const TDesC8 &

aDes

)

Append data to the AV/C frame.

Parameters

const TDesC8 & aDes

The data to be appended.

Append(TChar)

IMPORT_C void

Append

(

TChar

aChar

)

Append data to the AV/C frame.

Parameters

TChar aChar

The data to be appended.

ButtonAct(AVCPanel::TButtonAction &)

IMPORT_C TInt

ButtonAct

(

AVCPanel::TButtonAction &

aButtonAction

)

const

Get the AV/C button action for this frame.

This is only valid for passthrough commands.

Parameters

AVCPanel::TButtonAction & aButtonAction

ConstructL(AVC::TCType, AVC::TSubunitType, AVC::TSubunitID)

void	ConstructL	(	AVC::TCType	aType,
			AVC::TSubunitType	aSubunitType,
			AVC::TSubunitID	aSubunitID
		)	[private]

Second phase construction.

This overload is used when an AV/C frame is to be constructed, that is it is probably an outgoing frame.

leave: System wide error code.

Parameters

AVC::TCType aType	The AV/C CType for this frame.
AVC::TSubunitType aSubunitType	The AV/C subunit type for this frame.
AVC::TSubunitID aSubunitID

ConstructL(const TDesC8 &)

void

ConstructL

(

const TDesC8 &

aBuffer

)

[private]

Second phase construction.

This overload is used when a data buffer should be parsed as an AV/C frame, that is it is probably an incoming frame.

For details of parsing refer to the AV/C digital interface command set specification.

leave: System wide error code.

Parameters

const TDesC8 & aBuffer

A buffer to be parsed as an AV/C frame.

Data()

IMPORT_C const TDesC8 &

Data

(

)

const

Retrieve the entire AV/C frame.

DataLength()

IMPORT_C TInt

DataLength

(

)

const

Return the length of the data in the AV/C frame

FindExtensionL(const TDesC8 &, TInt &, TInt &)

void	FindExtensionL	(	const TDesC8 &	aBuffer,
			TInt &	aSubunitTypeExtensionBytes,
			TInt &	aSubunitIDExtensionBytes
		)	[private, static]

Find extension bytes for the frame.

leave: System wide error code.

Parameters

const TDesC8 & aBuffer	buffer to be used.
TInt & aSubunitTypeExtensionBytes
TInt & aSubunitIDExtensionBytes

FrameType()

IMPORT_C AVC::TFrameType

FrameType

(

)

const

Gets the AV/C frame type.

FrameType(const TDesC8 &)

IMPORT_C AVC::TFrameType

FrameType

(

const TDesC8 &

aFrame

)

[static]

Gets the AV/C frame type.

Parameters

const TDesC8 & aFrame

The frame to get the frame type for.

NewL(AVC::TFrameType, AVC::TCType, AVC::TSubunitType, AVC::TSubunitID)

IMPORT_C CAVCFrame *	NewL	(	AVC::TFrameType	aFrameType,
			AVC::TCType	aType,
			AVC::TSubunitType	aSubunitType,
			AVC::TSubunitID	aSubunitID
		)	[static]

Factory function.

This overload should be called when an AV/C frame is to be constructed, that is it is probably an outgoing frame.

leave: System wide error code.

Parameters

AVC::TFrameType aFrameType	ECommand if this is a command, EResponse if it's a response.
AVC::TCType aType	The AV/C CType for this frame.
AVC::TSubunitType aSubunitType	The AV/C subunit type for this frame.
AVC::TSubunitID aSubunitID

NewL(const TDesC8 &, AVC::TFrameType)

IMPORT_C CAVCFrame *	NewL	(	const TDesC8 &	aBuffer,
			AVC::TFrameType	aType
		)	[static]

Factory function.

This overload should be used when a data buffer should be parsed as an AV/C frame, that is it is probably an incoming frame.

leave: System wide error code.

Parameters

const TDesC8 & aBuffer	A buffer to be parsed as an AV/C frame.
AVC::TFrameType aType	ECommand if this is a command, EResponse if it's a response.

Opcode()

IMPORT_C TUint8

Opcode

(

)

const

Get the AV/C opcode for this frame.

OpcodeL(const TDesC8 &)

IMPORT_C AVC::TOpcode

OpcodeL

(

const TDesC8 &

aBuffer

)

[static]

Get the AV/C opcode for this frame.

leave: System wide error code.

Parameters

const TDesC8 & aBuffer

buffer to search.

OperationId(TUint8 &)

IMPORT_C TInt

OperationId

(

TUint8 &

aOpId

)

const

Get the AV/C OperationId for this frame.

This is only valid for passthrough commands.

Parameters

TUint8 & aOpId

On return, the AV/C opcode for this frame.

SetFrameType(AVC::TFrameType)

IMPORT_C void

SetFrameType

(

AVC::TFrameType

aFrameType

)

Set the AV/C frame type for this frame.

Parameters

AVC::TFrameType aFrameType

SetType(AVC::TCType)

IMPORT_C void

SetType

(

AVC::TCType

aType

)

Set the AV/C CType for this frame.

Parameters

AVC::TCType aType

The AV/C CType to set.

SubunitID()

IMPORT_C AVC::TSubunitID

SubunitID

(

)

const

Get the AV/C subunit id for this frame.

SubunitType()

IMPORT_C AVC::TSubunitType

SubunitType

(

)

const

Get the AV/C subunit type for this frame.

Type()

IMPORT_C AVC::TCType

Type

(

)

const

Get the AV/C CType for this frame.

operator[](TInt)

IMPORT_C const TUint8 &

operator[]

(

TInt

aIndex

)

const

Retrieve data from the AV/C frame.

panic: If aIndex is outside the frame. DataLength() should be used to check the length of the data segment before using the [] operator.

Parameters

TInt aIndex

The offset of the data element within the data segment of the frame

Member Data Documentation

RBuf8 iBuffer

RBuf8

iBuffer

[private]

AVC::TFrameType iFrameType

AVC::TFrameType

iFrameType

[private]

TInt iSubunitIDExtensionBytes

TInt

iSubunitIDExtensionBytes

[private]

TInt iSubunitTypeExtensionBytes

TInt

iSubunitTypeExtensionBytes

[private]