Symbian^3 Product Developer Library >

RA2dpOptimiser Class Reference

class RA2dpOptimiser

API used for optimisation related to A2DP streaming

Public Member Functions
RA2dpOptimiser()
IMPORT_C voidClose()
IMPORT_C TIntOpen()
IMPORT_C voidOptimiseAclForAudioStreaming(const TBTDevAddr &, TUint, TUint)
IMPORT_C voidRemoveAclOptimisation(const TBTDevAddr &)
Private Member Functions
RA2dpOptimiser(const RA2dpOptimiser &)
Public Member Enumerations
enumTA2dpOptimiserFunctionIds { EHCIA2dpOptimiseAcl = 0, EHCIA2dpRemoveAclOptimisation = 1 }
enumTA2dpOptimiserUtilsPanic { EApiUsedWhenHandleIsNotOpen = 0, EHandleIsAlreadyOpen = 1 }
Private Attributes
RHCIServerSession *iHCIServerSession
TUint32 iReserved1

Constructor & Destructor Documentation

RA2dpOptimiser()

IMPORT_CRA2dpOptimiser()

RA2dpOptimiser(const RA2dpOptimiser &)

RA2dpOptimiser(const RA2dpOptimiser &)[private]

Parameters

const RA2dpOptimiser &

Member Functions Documentation

Close()

IMPORT_C voidClose()

Closes the handle to the A2DP Optimisation interface.

Note that it is safe to call this multiple times.

Open()

IMPORT_C TIntOpen()

Opens the handle to the A2DP Optimisation interface.

OptimiseAclForAudioStreaming(const TBTDevAddr &, TUint, TUint)

IMPORT_C voidOptimiseAclForAudioStreaming(const TBTDevAddr &aDevAddr,
TUintaPeakBandwidth,
TUintaAccessLatency
)

Attempt to optimise the ACL for A2DP streaming.

This method should return immediately without waiting for confirmation of optimisation from the hardware as it will be called directly before streaming is required. This method can also be called multiple times without having to remove the optimisation to allow for changing streaming parameters.

The Peak Bandwidth argument is for the octets of A2DP data only, i.e. the overhead of additional headers, L2CAP for example, should not be considered by the caller of this method.

Parameters

const TBTDevAddr & aDevAddrAddress of the remote device recieving audio stream
TUint aPeakBandwidthPeak Bandwidth of audio stream in octets per second
TUint aAccessLatencyAccess Latency of audio stream in microseconds

RemoveAclOptimisation(const TBTDevAddr &)

IMPORT_C voidRemoveAclOptimisation(const TBTDevAddr &aDevAddr)

Attempt to remove any A2DP optimisation that was previously set using OptimiseAclForAudioStreaming().

Parameters

const TBTDevAddr & aDevAddrAddress of the remote device recieving audio stream

Member Enumerations Documentation

Enum TA2dpOptimiserFunctionIds

Enumerators

EHCIA2dpOptimiseAcl = 0
EHCIA2dpRemoveAclOptimisation = 1

Enum TA2dpOptimiserUtilsPanic

Enumerators

EApiUsedWhenHandleIsNotOpen = 0
EHandleIsAlreadyOpen = 1

Member Data Documentation

RHCIServerSession * iHCIServerSession

RHCIServerSession *iHCIServerSession[private]

TUint32 iReserved1

TUint32 iReserved1[private]

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.