COrientation Class Reference

#include <OrientationBase.h>

Link against: OrientationEffect.lib

class COrientation : public CAudioEffect

Inherits from

Protected Attributes
TEfOrientationDataPckg iDataPckgFrom
TEfOrientationDataPckg iDataPckgTo
TEfOrientation iOrientationData
Public Member Functions
IMPORT_C voidOrientation(TInt32 &, TInt32 &, TInt32 &)
IMPORT_C voidOrientationVectors(TInt32 &, TInt32 &, TInt32 &, TInt32 &, TInt32 &, TInt32 &)
IMPORT_C voidSetOrientationL(TInt32, TInt32, TInt32)
IMPORT_C voidSetOrientationVectorsL(TInt32, TInt32, TInt32, TInt32, TInt32, TInt32)
Protected Member Functions
COrientation()
virtual ~COrientation()
virtual IMPORT_C const TDesC8 &DoEffectData()
virtual IMPORT_C voidSetEffectData(const TDesC8 &)
Inherited Attributes
CAudioEffect::iEnabled
CAudioEffect::iEnforced
CAudioEffect::iHaveUpdateRights
CAudioEffect::iObservers
Inherited Functions
CAudioEffect::ApplyL()
CAudioEffect::CAudioEffect()
CAudioEffect::DisableL()
CAudioEffect::EnableL()
CAudioEffect::EnforceL(TBool)
CAudioEffect::HaveUpdateRights()const
CAudioEffect::IsEnabled()const
CAudioEffect::IsEnforced()const
CAudioEffect::RegisterObserverL(MAudioEffectObserver &)
CAudioEffect::Uid()const
CAudioEffect::UnRegisterObserver(MAudioEffectObserver &)
CAudioEffect::~CAudioEffect()
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()

Detailed Description

This is the orientation effect base class.

Since
3.0

Member Attribute Documentation

iDataPckgFrom

TEfOrientationDataPckg iDataPckgFrom[protected]

iDataPckgTo

TEfOrientationDataPckg iDataPckgTo[protected]

iOrientationData

TEfOrientation iOrientationData[protected]

Constructor & Destructor Documentation

COrientation ( )

IMPORT_CCOrientation()[protected]

Private C++ constructor for this class.

~COrientation ( )

IMPORT_C~COrientation()[protected, virtual]

Destructor

Member Function Documentation

DoEffectData ( )

IMPORT_C const TDesC8 &DoEffectData()[protected, virtual]

Reimplemented from CAudioEffect::DoEffectData()

From CAudioEffect Create a package of the effect data
Since
3.0

Returns: A descriptor containing the effect data.

Orientation ( TInt32 &, TInt32 &, TInt32 & )

IMPORT_C voidOrientation(TInt32 &aHeading,
TInt32 &aPitch,
TInt32 &aRoll
)
Get the orientation vectors for the position
Since
3.0
ParameterDescription
aHeadingThe heading (thousandths of radians)
aPitchThe Pitch (thousandths of radians)
aRollThe Roll (thousandths of radians)

Returns: -

OrientationVectors ( TInt32 &, TInt32 &, TInt32 &, TInt32 &, TInt32 &, TInt32 & )

IMPORT_C voidOrientationVectors(TInt32 &aFrontX,
TInt32 &aFrontY,
TInt32 &aFrontZ,
TInt32 &aAboveX,
TInt32 &aAboveY,
TInt32 &aAboveZ
)
Gets the orientation of the position.
Since
3.0
ParameterDescription
aFrontXX value of Front vector
aFrontYY value of Front vector
aFrontZZ value of Front vector
aAboveXX value of Above vector
aAboveYY value of Above vector
aAboveZZ value of Above vector

Returns: -

SetEffectData ( const TDesC8 & )

IMPORT_C voidSetEffectData(const TDesC8 &aEffectDataBuffer)[protected, virtual]
From CAudioEffect Internal function to unpack effect data
Since
3.0
ParameterDescription
aEffectDataBufferDescriptor containing packed effect data

Returns: -

SetOrientationL ( TInt32, TInt32, TInt32 )

IMPORT_C voidSetOrientationL(TInt32aHeading,
TInt32aPitch,
TInt32aRoll
)
Sets the Heading, Pitch, Roll values for the orientation of the source
Since
3.0
ParameterDescription
aHeadingThe heading (thousandths of radians)
aPitchThe Pitch (thousandths of radians)
aRollThe Roll (thousandths of radians)

Returns: -

SetOrientationVectorsL ( TInt32, TInt32, TInt32, TInt32, TInt32, TInt32 )

IMPORT_C voidSetOrientationVectorsL(TInt32aFrontX,
TInt32aFrontY,
TInt32aFrontZ,
TInt32aAboveX,
TInt32aAboveY,
TInt32aAboveZ
)
Sets the Front and Above vectors for the orientation of the position.
Since
3.0
ParameterDescription
aFrontXX value of Front vector
aFrontYY value of Front vector
aFrontZZ value of Front vector
aAboveXX value of Above vector
aAboveYY value of Above vector
aAboveZZ value of Above vector

Returns: -

© Nokia 2011.