Symbian^3 Product Developer Library >

COrientation Class Reference

class COrientation : public CAudioEffect

This is the orientation effect base class.

OrientationEffect.lib
Since
3.0

Inherits from

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()
~COrientation()
IMPORT_C const TDesC8 &DoEffectData()
IMPORT_C voidSetEffectData(const TDesC8 &)
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()
Protected Attributes
TEfOrientationDataPckg iDataPckgFrom
TEfOrientationDataPckg iDataPckgTo
TEfOrientation iOrientationData
Inherited Attributes
CAudioEffect::iEnabled
CAudioEffect::iEnforced
CAudioEffect::iHaveUpdateRights
CAudioEffect::iObservers

Constructor & Destructor Documentation

COrientation()

IMPORT_CCOrientation()[protected]

Private C++ constructor for this class.

~COrientation()

IMPORT_C~COrientation()[protected, virtual]

Destructor

Member Functions Documentation

DoEffectData()

IMPORT_C const TDesC8 &DoEffectData()[protected, virtual]
From CAudioEffect Create a package of the effect data
Since
3.0

Orientation(TInt32 &, TInt32 &, TInt32 &)

IMPORT_C voidOrientation(TInt32 &aHeading,
TInt32 &aPitch,
TInt32 &aRoll
)
Get the orientation vectors for the position
Since
3.0

Parameters

TInt32 & aHeadingThe heading (thousandths of radians)
TInt32 & aPitchThe Pitch (thousandths of radians)
TInt32 & aRollThe Roll (thousandths of radians)

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

Parameters

TInt32 & aFrontXX value of Front vector
TInt32 & aFrontYY value of Front vector
TInt32 & aFrontZZ value of Front vector
TInt32 & aAboveXX value of Above vector
TInt32 & aAboveYY value of Above vector
TInt32 & aAboveZZ value of Above vector

SetEffectData(const TDesC8 &)

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

Parameters

const TDesC8 & aEffectDataBufferDescriptor containing packed effect data

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

Parameters

TInt32 aHeadingThe heading (thousandths of radians)
TInt32 aPitchThe Pitch (thousandths of radians)
TInt32 aRollThe Roll (thousandths of radians)

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

Parameters

TInt32 aFrontXX value of Front vector
TInt32 aFrontYY value of Front vector
TInt32 aFrontZZ value of Front vector
TInt32 aAboveXX value of Above vector
TInt32 aAboveYY value of Above vector
TInt32 aAboveZZ value of Above vector

Member Data Documentation

TEfOrientationDataPckg iDataPckgFrom

TEfOrientationDataPckg iDataPckgFrom[protected]

TEfOrientationDataPckg iDataPckgTo

TEfOrientationDataPckg iDataPckgTo[protected]

TEfOrientation iOrientationData

TEfOrientation iOrientationData[protected]

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.